Salesforce で API 要求数の消費量と制限を分析する

API の制限と消費量の確認

Salesforce Lightning

組織の API 要求数の制限と消費量に関する情報を取得するには、次のいずれかの方法を使用できます:

I. 組織情報

1. [設定] | [組織情報] に移動します。
2. [API 要求数 (この 24 時間以内)] の値を確認します。ここには、過去 24 時間で消費された API コール数の合計と、ライセンスに基づいた組織の 1 日の制限が表示されます。

II. システムの概要

1. [設定] に移動します。
2. [クイック検索] で [システムの概要] を検索します。
3. ここで [API 要求数 (この 24 時間以内)] を確認できます。これは、本日を含め、過去 24 時間で行われた API コール数を示します。たとえば、月曜日の午後 2 時 30 分に確認した場合、日曜日の午後 2 時 30 分以降に行われたコールが表示されます。

III. API レスポンスの Limit Info ヘッダー
SOAP および REST API のレスポンスで返される Limit Info ヘッダーにも、過去 24 時間に行われた API コールと 1 日の API リクエスト制限に関する情報が含まれています。

SOAP API レスポンスの例：

<limitInfo> <current>700</current> <limit>15000</limit> <type>API REQUESTS</type></limitInfo>

REST API レスポンスの例：

Sforce-Limit-Info: api-usage=25/5000; 

IV. REST API 制限リソース
/services/data/vXX.X/limits/ リソースへの GET リクエストは、組織内のすべての制限に関する情報を返します。レスポンスには 'DailyApiRequests' が含まれ、過去 24 時間の使用量と 1 日の制限に関する情報を提供します。例:

"DailyApiRequests":{
  "Max":106200
  "Remaining":105482
}

上記の情報は、組織の 1 日の API リクエスト制限と合計消費量を確認するのに役立ちます。また、制限に対する消費量が特定のしきい値に達した際に通知を送信するように API 使用状況通知を定義できます。

組織の API の制限と消費量に関する情報が得られたら、次はこれらの制限を消費している API リクエストを調査することになります。

Ⅴ. API 合計使用量イベントログファイル
組織の API 使用制限に影響している API リクエストの内訳を確認するには、イベントモニタリングで利用可能な API 合計使用量 (ApiTotalUsage) のイベントタイプを使用します。Developer、Enterprise、Unlimited、および Performance Edition の組織は、追加費用なしで、1 日のデータ保持期間を持つ API 合計使用量イベントログファイルにアクセスできます。イベントモニタリングの詳細については、Event Monitoring Trailhead モジュール を参照してください。

API 合計使用量イベントには、SOAP API、REST API、および Bulk API のリクエストに関する詳細が含まれています。したがって、これは一般的な API 消費量を監視するために使用できます。

API 合計使用量に関するイベントログファイルを生成するには:

1. [設定] に移動し、[クイック検索] ボックスで  [イベントモニタリング設定]  を検索してクリックします。[イベントログファイルを生成] が オン になっていることを確認してください。
2. イベントログファイルへのアクセスには、「イベントログファイルを参照」と「API の有効化」のユーザー権限が必要です。ただし、「すべてのデータの参照」権限を持つユーザーは、これらの権限は必要ありません。

上記の手順が完了した後、Event Log File Browser (イベントログファイルブラウザー) または REST API を使用して、API 合計使用量イベントのログファイルを取得します。

Event Log File Browser では、API 合計使用量イベントのログファイルが利用可能になります。これらのファイルは CSV 形式でダウンロードでき、API リクエストに関する情報を取得できます。ログファイル内の各行は 1 つの API リクエストを表し、ログ行内の項目値は API リクエストに関する詳細情報を提供します。これらの各項目が何を表すかについての情報は、API 合計使用量イベントタイプの項目で確認できます。

考慮事項:

• イベントログファイルは、イベントタイプごとに 2 種類の間隔 (Hourly: 1時間ごと、Daily: 1日ごと) で生成されます。ログファイルは、実際のイベントが発生してから一定の時間が経過した後に生成されます。イベントログファイルの生成に関する詳細については、https://developer.salesforce.com/docs/atlas.ja-jp.api_rest.meta/api_rest/using_resources_event_log_files.htm を参照してください。
• サイトの切り替え、インスタンスのリフレッシュ、または予期せぬシステム障害の際に、Hourly のログファイルで一部のイベントログデータが欠落する可能性があるため、完全なデータを確認するには Daily のログファイルの使用をお勧めします。
• イベントログファイルの保持期間をデフォルトの 1 日から延長したい場合は、Event Monitoring (イベントモニタリング) アドオンの購入が必要です。Event Monitoring ライセンスには、API リクエストに関するより深いインサイトを提供する Event Monitoring Analytics App などの機能が含まれています。詳細については、担当のアカウントエグゼクティブにご連絡ください。

Salesforce Classic

API の制限と消費量に関する完全かつ正確な情報を得るには、Salesforce Classic で利用可能な API 使用状況データには一定の制限があるため、この記事の Lightning セクションで言及されている前述の方法を使用することを推奨します。

組織の API コールを [過去 7 日間の API 使用状況] レポートで表示する

利用可能なエディション:

• Enterprise、Performance、および Unlimited Edition (Salesforce Classic のみ）。
• Professional Edition でも、追加費用（およびアカウントエグゼクティブへの API 有効化の依頼）により利用可能です。詳細については、API アクセスが可能な Salesforce エディションを参照してください。

必要な権限:

• このレポートを参照するには、プロファイルに「設定・定義を参照する」権限が必要です。
• 非管理者ユーザーがこのレポートを参照するには、プロファイルに「すべて変更」権限が必要です。

[過去 7 日間の API 使用状況] レポートには、本日を含め、過去 7 日間のユーザー別および日付別に行われたコールが表示されます。

[過去 7 日間の API 使用状況] レポートの表示方法:

1. [レポート] をクリックします。
2. [管理レポート] をクリックします。
3. [過去 7 日間の API 使用状況] をクリックします。

注意:

• レポートデータは、グリニッジ標準時 (GMT) または UTC の午前 0 時に毎日リセットされます。
• [過去 7 日間の API 使用状況] は、[フォルダを検索] では表示されない場合があります。
• Salesforce が作成した特定の接続アプリケーション (例: Salesforce モバイルアプリケーション) によって発行された API コールは、組織に割り当てられた API リクエスト制限にはカウントされません。しかしながら、[過去 7 日間の API 使用状況] レポートには含まれることに注意してください。
• 内部のバグにより、一部の API コールは API 使用状況に含まれません。たとえば、いくつかの Bulk API コールはこのレポートには含まれません。より正確な詳細を確認するには、[システムの概要] ページまたは [制限] REST リソースを参照してください。 

Marketing Cloud Account Engagement (旧 Pardot)

Marketing Cloud Account Engagement では、[API 使用状況の統計情報] ページで API 要求数を確認できます。 

API コールの使用を抑える

特定の API クライアントが消費する API コールの量を抑える方法はいくつかあります。一例を挙げます (他にもあります):

• クライアント側でキャッシュする。
• 増分的な変更ではなく累積的な変更を送信する (例：REST API で複合リソースを使用する)。
• REST API で同じレコードをアップロード/更新するのではなく、Bulk API を利用してレコードを一括アップロード/更新する。

API コール数の上限を増やす

API 要求の制限と割り当てページの API 要求合計数の割り当ての増加 セクションを参照してください。

関連項目:

緊急時における「組織の 1 日の API 要求の制限（APIコール数）」の拡張について

本番の制限よりも高い Sandbox API コールの制限