Salesforce Platform API バージョン 21.0 ～ 30.0 の廃止

元の公開日 - 2020 年 10 月 20 日

更新日: 2024 年 5 月 4 日
 

SOAP API、REST API、Bulk API バージョン 21 ～ 30 の現在の状況

• 現在:これらの API バージョンは非推奨であり (Summer ‘22 リリース時点)、サポートは終了しています。該当する API バージョンは使用できますが、問題が発生して Salesforce サポートにケースを登録する場合は、まず API バージョンを更新していただく必要があります。従来の API のこれらのバージョンについては、トラブルシューティングやバグ修正はありません。

• 今後:Summer ‘25 リリース - これらの API バージョンは廃止されます。該当するバージョンを使用するアプリケーションは中断されます。コールは失敗し、要求されたエンドポイントが見つからず、プラットフォームで処理できないというエラーで応答します。以下にそのエラーを示します。

  • REST API で「410:GONE」が返される。

  • SOAP API で「500:UNSUPPORTED_API_VERSION」が返される。

  • Bulk API で「400:InvalidVersion」が返される。

注意:API バージョン 7.0 ～ 20.0 はすでに廃止されており、Summer ’22 リリースでは使用できません。

これらの API バージョンを廃止する理由
Salesforce では、アプリケーションを通じたカスタム機能作成時の Salesforce エクスペリエンスを向上させるために、API の最新バージョンに開発リソースを集中させています。なお、API バージョン 30 は Spring ‘14 リリースで公開されました。

これらの API バージョンの廃止による影響
この廃止は、バージョン 21.0 ～ 30.0 の SOAP API、REST API、Bulk API の要求を実行するすべてのコード、パッケージ、アプリケーション、インテグレーションに影響します。

注意: この廃止は以下のものには影響しません。

• Apex クラス、Apex トリガー、Visualforce ページ、フロー、プロセスビルダーの API バージョン

• 標準の B2B Classic/Visualforce 製品

• 管理パッケージ内のバージョン設定されたメタデータコンポーネント

• カスタム Apex REST と SOAP Web サービス (カスタム Apex Web サービスは、Apex クラスメソッドをパブリック API として呼び出し可能にする方法です。Apex Web サービスについての詳細は、「Apex Web サービス」を参照してください)

お客様にてご対応いただく作業

1. 組織内のコンポーネント/アプリケーションのうち、従来の API のこれらのバージョンを使用しているものを特定します。

2. 該当するコンポーネント/アプリケーションを更新します。Summer '25 リリースの前に、現在サポートされている API バージョンで機能するようにアプリケーションを変更またはアップグレードする必要があります。新しいバージョンの API に移行すると、セキュリティとパフォーマンスが向上した高度な機能を利用できるため、Salesforce は新しいバージョンへの移行を強く推奨しています。

一般的に影響が発生するコンポーネントと、各コンポーネントに必要なアクションについては、以下の表を参照してください。

従来の API のこれらのバージョンがアプリケーションのどこで使われているかを確認する方法

API のバージョンを確認するには、使用しているアプリケーションの開発者にお問い合わせください。

また、無料の API 合計使用量 EventLogFile で API イベントを確認できます。このイベントログファイルは、次の 2 つの方法のいずれかを使用して、Salesforce の SOAP API、REST API、Bulk API アクティビティをレポートします。

1. 1 つ目は、Summer '24 リリースに含まれる新しいイベントログブラウザーを使用する方法です。  このブラウザーでは、組織で API 合計使用量イベントログファイルを参照し、それらを CSV ファイルとしてダウンロードして個別の API イベントを確認できます。

[設定] 内から、[セキュリティ] → [イベントモニタリング] → [イベントログブラウザー] に移動します。  ここでは、過去 24 時間 ([イベントモニタリング] を有効にしている場合は過去 30 日間) のイベントログファイルを確認できます。  その後、個別のイベントログファイルを CSV ファイルとしてダウンロードし、それらのファイルで API イベントを確認できます。

2. 2 つ目の方法では、Salesforce CLI などのクライアントを使用して、EventLogFile オブジェクトに対して SOQL クエリを実行し、過去 24 時間 ([イベントモニタリング] を有効にしている場合は過去 30 日間) のイベントログファイルを入手します。

sf data query -q "SELECT Id, LogFile, EventType, CreatedDate FROM EventLogFile WHERE EventType IN ('ApiTotalUsage')" -o <your-username>

各結果で、クエリ結果のエンドポイントに REST API 要求を実行し、そのイベントログファイルのイベントログデータを取得します。*

/services/data/v58.0/sobjects/EventLogFile/0AT3i000005vXpWGAU/LogFile

レスポンスボディをアプリケーションに貼り付けると、イベントログデータが .CSV ファイルとして調査しやすくなります。

3. 各 .CSV ファイルで、エンドポイントへの要求に使用されている API バージョンが 30 以前であるかどうかを確認します。

API_VERSION が 30 以前のすべての API 合計使用量イベント (ApiTotalUsage EventType) を確認します**

4. バージョン 30.0 以前を使用するインテグレーションとクライアントについては、イベントログデータの主要項目で提供されるヒントに従って、従来の API コールのソースを特定します。

CLIENT_NAME, CONNECTED_APP_ID, ENTITY_NAME, USER_ID

イベントモニタリングについての詳細は、「イベントモニタリング」Trailhead モジュールを受講してください。

*REST API リクエストの実行に関する基本的な情報は、Trailhead「REST API を使用する」を参照してください。

**「API 合計使用量」イベント種別は、バージョン情報を含め、SOAP API、Bulk API、REST API の関連する要求情報を集約します。イベント定義についての詳細はこちらを参照してください。API が有効になっている組織では、データ保持期間が 1 日の「API 合計使用量」イベントログファイルに無料でアクセスできます。イベントモニタリングを有効にすると、このイベントログファイルをはじめ、すべてのイベントログファイルタイプにアクセスでき、データも 30 日間保持されます。

また、次の方法でも Bulk API 要求と SOAP API ログインを見つけることができます。

• Bulk API 要求を見つける:Bulk API の場合は、[設定] の [一括データ読み込みジョブ] ページに移動して、各「一括 V1」ジョブの詳細を確認します。この API の廃止は、「API バージョン」フィールドが 30.0 以下の値となっているすべてのジョブに影響します。

• SOAP API ログインを見つける: SOAP login() 操作の場合は、[設定] の [ログイン履歴] に移動して、API 種別が「SOAP Enterprise」または「SOAP Partner」であるエントリを確認します。または、SOQL を介して LoginHistory sObject を照会できます。「API バージョン」項目で 30.0 以下の値を使用しているログインエントリは、すべてこの廃止の影響を受けます。

注意: パートナーはパッケージ利用状況ログを使用して、非推奨 API の使用情報を得ることができます。

詳細情報の入手方法

最新のサポート対象 API バージョンについては、Salesforce 開発者サイトを参照してください。

API およびアウトバウンドメッセージングについて

• プラットフォーム API の基本 (Trailhead)

• SOAP API の概要 (開発者ガイド)

• アウトバウンドメッセージについて (開発者ガイド)

• Bulk API (開発者ガイド)

• REST API の概要 (開発者ガイド)

  • 「REST」は、エンドポイント URI が /services/data/vXX.Y/ および /services/metadata/vXX.Y/ (XX.Y は API バージョン) のすべての API を対象とします。これには、sObject とレコードを操作するための「標準」の Salesforce Platform REST API のほか、以下のリソースも含まれます。

    • メタデータ API 開発者

    • Tooling API

    • Chatter/Connect API

    • Query および Query All API

    • Search API

    • 制限 API

    • ログイン API (別名「ID」)

• • • GET /services/data/v30.0 または GET /services/metadata/v30.0 への REST 要求の結果を調べて、v30.0 以下のエンドポイントが廃止されたときに影響を受ける最上位のリソースを理解します。

この従来の API の廃止についての詳細は、「An Important Update to Our Legacy API Retirement Plan」(従来 API の廃止計画に関する重要な最新情報) を参照してください。

管理者向けの API バージョンの説明は、こちらのポッドキャストをお聴きください (数年前の番組ですが、主要な情報は現在も参考にできます): 「Why API Versions Matter with Kris Harrison」(なぜ API バージョンが重要なのかを Kris Harrison と語る)

さらにサポートが必要な場合、どうすればよいですか?

• 上記のリソースをよく読みます。

• Trailblazer Community に投稿します。

• Salesforce ヘルプから Salesforce サポートに問い合わせます。できるだけ効率的にサポートできるよう、どんなことを試したか、どこで行き詰まっているのかなどを覚えておいてください。**サポートではお客様の組織の従来の API を更新することはできません。

現在と過去の廃止機能の一覧を参照するには、「Salesforce 製品 & 機能の廃止」を参照してください。製品や機能を廃止する Salesforce のアプローチについては、「製品 & 機能廃止の方針」をご覧ください。