この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ApiEvent

query()、queryMore()、および count() のユーザが開始した読み取り専用 API 呼び出しを追跡します。Enterprise WSDL および Partner WSDL の場合、SOAP API、REST API、および Bulk API によって API 要求をキャプチャします。Salesforce モバイルアプリケーションから開始された Tooling API コールおよび API コールはキャプチャされません。ApiEvent は、トランザクションセキュリティポリシーで使用できます。ApiEvent は、ApiEventStream のイベントデータを格納する Big Object です。このオブジェクトは API バージョン 46.0 以降で使用できます。

サポートされているコール

describeSObjects()、query()

特別なアクセスルール

このオブジェクトにアクセスするには、Salesforce Shield または Salesforce Event Monitoring アドオンサブスクリプションと、「データ漏洩検出イベントを表示」ユーザ権限が必要です。

項目

項目	詳細
AdditionalInfo	型 string プロパティ Nillable 説明 API 要求中に `HTTP` ヘッダーから取得した追加情報を JSON に逐次化したもの。たとえば、`{"field1": "value1", "field2": "value2"}` です。「AdditionalInfo の使用」��参照してください。
ApiType	型 string プロパティ Nillable 説明使用された API。次のような値があります。 `SOAP Enterprise` `SOAP Partner` `REST API` `なし`
ApiVersion	型 double プロパティ Nillable 説明 API のバージョン番号。
Application	型 string プロパティ Nillable 説明組織にアクセスするために使用するアプリケーション。Einstein Analytics や Salesforce 開発者コネクタなどがあります。この項目は、API バージョン 41.0 以降で使用できます。
Client	型 string プロパティ Nillable 説明 API イベントを実行したサービス。不明なクライアントを使用している場合、この項目で「不明」または空白の値が返されます。
ConnectedAppId	型 reference プロパティ Nillable 説明 API コールに関連付けられた接続アプリケーションの 15 文字の ID。この項目は、API バージョン 41.0 以降で使用できます。
ElapsedTime	型 int プロパティ Nillable 説明要求の完了にかかった時間 (ミリ秒単位)。この値の測定は、クエリが実行される前に始まり、クエリが完了すると終了します。ネットワーク経由で結果を返すのにかかる時間は含まれません。
EvaluationTime	型 double プロパティ Nillable 説明ポリシーの評価にかかった時間 (ミリ秒単位)。この項目は、API バージョン 41.0 以降で使用できます。
EventDate	型 dateTime プロパティ Filter、Nillable。Sort 説明指定された API イベントがキャプチャされた時間 (クエリの実行後)。たとえば、2013-01-01T03:01:01Z です。最も細かい設定は秒です。
EventIdentifier	型 string プロパティ Filter、Group、Nillable、Sort 説明イベントの一意の ID。たとえば、0a4779b0-0da1-4619-a373-0a36991dff90 などです。この項目は、API バージョン 41.0 以降で使用できます。
LoginHistoryId	型 reference プロパティ Nillable 説明ユーザアクティビティと一連の特定の API イベントを関連付けられるように、ユーザセッションを追跡します。この項目は LoginEvent、AuthSession、および LoginHistory オブジェクトでも使用できるため、ユーザの元の認証へとイベントを簡単にトレースバックできます。この項目は、API バージョン 41.0 以降で使用できます。
LoginKey	型 string プロパティ Nillable 説明特定のユーザのログインセッションのすべてのイベントを結び付ける文字列。このセッションはログインイベントで開始され、ログアウトイベントまたはユーザセッションの期限切れで終了します。
Operation	型 string プロパティ Nillable、Restricted picklist 説明イベントを生成した API コール (`Query`、`QueryAll`、または `QueryMore`)。
Platform	型 string プロパティ Nillable 説明ログインマシンのオペレーティングシステム。iPhone、Mac OS、Linux、Unknown などになります。この項目は、API バージョン 41.0 以降で使用できます。
PolicyId	型 reference プロパティ Nillable 説明このイベントに関連付けられたトランサクションポリシーの ID。この項目は、API バージョン 42.0 以降で使用できます。
PolicyOutcome	型 picklist プロパティ Nillable、Restricted picklist 説明トランサクションポリシーの結果。値は次のとおりです。 `Block` - ポリシーをトリガする操作を実行できないようにユーザがブロックされました。 `EndSession` - ユーザあたりの同時セッション数を制限する同時セッションの制限ポリシーが有効化されました。 `Error` - ポリシーの実行時にポリシーによって未定義のエラーが発生しました。 `FailedInvalidPassword` - ユーザが無効なパスワードを入力しました。 `FailedPasswordLockout` - ユーザが無効なパスワードを入力した回数が多すぎます。 `NoAction` - ポリシーがトリガしませんでした。 `Notified` - 受信者に通知が送信されました。この項目は、API バージョン 41.0 以降で使用できます。
QueriedEntities	型 string プロパティ Nillable 説明 SOQL クエリのエンティティ。たとえば、商談、リード、取引先、ケースなどです。また、カスタムオブジェクトを含めることもできます。リレーションクエリの場合、この項目の値にはクエリに関係するすべてのエンティティが含まれます。例 `SELECT Contact.FirstName, Contact.Account.Name from Contact` の場合、QueriedEntities の値は `Account, Contact` になります。 `SELECT Account.Name, (SELECT Contact.FirstName, Contact.LastName FROM Account.Contacts) FROM Account` の場合、QueriedEntities の値は `Account, Contact` になります。 `SELECT Id, Name, Account.Name FROM Contact WHERE Account.Industry = 'media'` の場合、QueriedEntities の値は `Account, Contact` になります。
Query	型 string プロパティ Nillable 説明 SOQL クエリ。たとえば、`SELECT id FROM Lead` です。
Records	型 json プロパティ Nillable 説明照会されたオブジェクトのメタデータを表す JSON 文字列。このメタデータには、エンティティ種別およびエンティティ ID あたりのクエリ結果数が含まれます。例 `1{ "totalSize" : 1, 2 "done" : true, 3 "records" : [ { 4 "attributes" : { 5 "type" : "Account" 6 }, 7 "Id" : "001xx000003DMvCAAW", 8 "Contacts" : { 9 "totalSize" : 3, 10 "done" : true, 11 "records" : [ { 12 "attributes" : { 13 "type" : "Contact" 14 }, 15 "Id" : "003xx000004U7xKAAS" 16 }, { 17 "attributes" : { 18 "type" : "Contact" 19 }, 20 "Id" : "003xx000004U7xLAAS" 21 }, { 22 "attributes" : { 23 "type" : "Contact" 24 }, 25 "Id" : "003xx000004U7xMAAS" 26 } ] 27 } 28 } ] 29}`
RelatedEventIdentifier	型 string プロパティ Nillable 説明関連イベントの EventIdentifier を表します。
RowsProcessed	型 double プロパティ Nillable 説明クエリから返されたデータの行数。
SessionKey	型 string プロパティ Nillable 説明ユーザの一意のセッション ID。この値を使用して、セッション内のすべてのユーザイベントを識別します。ユーザがログアウトしてから再びログインすると、新しいセッションが開始されます。この項目は、API バージョン 41.0 以降で使用できます。
SessionLevel	型 picklist プロパティ Nillable、Restricted picklist 説明セッションレベルのセキュリティは、接続アプリケーションやレポートなど、このセキュリティをサポートする機能へのユーザのアクセス権を制御します。値は次のとおりです。 `HIGH_ASSURANCE` - リソースへのアクセスに高保証セッションが使用されました。たとえば、高保証セッションレベルが必要な接続アプリケーション、レポート、ダッシュボードなどのリソースにユーザがアクセスしようとした場合です。 `LOW` - 現在のセッションに対するユーザのセキュリティレベルが最低限の要件を満たします。この Low レベルは、Salesforce UI で利用不可能であり、使用されません。UI を介したユーザセッションは、標準または高保証です。このレベルは API を使用して設定できますが、このレベルに割り当てられたユーザは、Salesforce 組織で使用できる機能が制限され、またどの機能を使用できるかを判断することができません。メモ `STANDARD` - 現在のセッションに対するユーザのセキュリティレベルが、現在の組織のセッションセキュリティレベルの標準の要件セットを満たします。この項目は、API バージョン 41.0 以降で使用できます。
SourceIp	型 string プロパティ Nillable 説明 API イベントの発生元の IP。Salesforce ��部 IP (Salesforce AppExchange から発生する API イベントなど) は、「Salesforce.com IP」と表示されます。
UserAgent	型 string プロパティ Nillable 説明 API コールが発生したプラットフォームまたは環境。この項目には、オペレーティングシステム、アプリケーション、または Web プロトコルに関する情報を含めることができます。
UserId	型 reference プロパティ Nillable 説明発生元ユーザの一意の ID。たとえば、005000000000123 です。
Username	型 string プロパティ Nillable 説明イベントが作成された時点での user@company.com 形式の発生元のユーザ名。

AdditionalInfo の使用

AdditionalInfo を使用すると、API イベントを拡張してカスタムデータを含めることができます。このデータは後で照会できます。たとえば、一意の相関 ID を共有する外部システムからユーザが SOQL クエリを実行したときに、その ID を取得できます。このプロセスにより、システム間で API コールを追跡できます。ApiEvent を使用してデータを保存するには、すべての AdditionalInfo 項目名の先頭を x-sfdc-addinfo-{field name} にします。たとえば、有効な項目割り当ては、x-sfdc-addinfo-correlation_id = ABC123 です。ここで、x-sfdc-addinfo-correlation_id は項目名、ABC123 は項目値です。

項目名を定義するときには、次の点に注意してください。

x-sfdc-addinfo- では大文字と小文字が区別されません。x-sfdc-addinfo-{field name} と X-SFDC-ADDINFO-{field name} および x-SfDc-AdDiNfO-{field name} は等価です。
項目には、英数字と「_」 (アンダースコア) 文字のみを使用できます。
項目名は、x-sfdc-addinfo-{field name} を含めずに 2 ～ 29 文字にする必要があります。
先頭が x-sfdc-addinfo- でない項目名は無視されます。
x-sfdc-addinfo- より後に無効な文字が含まれる名前は無視され、何も保存されません。たとえば、x-sfdc-addinfo-correlation_id は有効な項目名ですが、x-sfdc-addinfo-correlation->id は有効ではありません。
最初の有効な 30 個の項目名のみが AdditionalInfo に保存されます。たとえば x-sfdc-addinfo-correlation_id と x-sfdc-addinfo-correlation_number など、有効な 2 つの項目名を保存している場合、他に 28 個の項目名を保存できます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。

項目値を定義する場合は、次の点に注意してください。

既存の API 項目名は HTTP ヘッダー内の AdditionalInfo 名に使用できません。AdditionalInfo 名がオブジェクトの API 参照名と競合した場合、項目値は保存されません。たとえば、X-SFDC-ADDINFO-UserId='abc123' という HTTP ヘッダーは AdditionalInfo に保存されません。
追加項目値には、英数字、「_」、「-」文字のみを使用できます。
項目値は 255 文字以下にする必要があります。項目値が 255 文字を超えた場合、最初の 255 文字のみが保存され、残りは切り捨てられます。
無効な文字を含む項目値は保存されますが、項目ヘッダーが空の文字列 ("") になります。
最初の有効な 30 個の項目名のみが AdditionalInfo 項目に保存されます。項目名は、認証に渡されたのと同じ順序で保存されるとは限りません。
AggregationFieldName または PlatformEventMetrics が SourceIp の場合、値が Salesforce.com IP だと AggregationFieldValue で絞り込めません。

HTTP と cURL を使用して追加情報を渡す方法

1curl https://yourInstance.salesforce.com/services/data/v34.0/query?q=SELECT+Name+From+Account -H "X-PrettyPrint:1" -H "x-sfdc-addinfo-correlationid:
2d18c5a3f-4fba-47bd-bbf8-6bb9a1786624"

Java の使用例

1//adding additional info headers ..
2Map<String, String> httpHeaders = new HashMap<String,String>();
3httpHeaders.put("x-sfdc-addinfo-fieldname1" /* additional info field*/ , "d18c5a3f-4fba-47bd-bbf8-6bb9a1786624" /* value*/);
4httpHeaders.put("x-sfdc-addinfo-fieldname2" /* additional info field*/ , "d18c5a3f-4fba-47bd-bbf8-6bb9a1786624" /* value*/);
5
6ConnectorConfig config = new ConnectorConfig();
7config.setUsername(userId);
8config.setPassword(passwd);
9config.setAuthEndpoint(authEndPoint);
10config.setProxy(proxyHost, proxyPort);
11
12//setting additional info headers
13for (Map.Entry<String, String> entry : httpHeaders.entrySet()) {
14     config.setRequestHeader(entry.getKey(), entry.getValue());
15}
16// Set the username and password if your proxy must be authenticated
17     config.setProxyUsername(proxyUsername);
18     config.setProxyPassword(proxyPassword);
19     try {
20       QueryResult queryResult = connection.query("SELECT Id, Name FROM Account");
21       // etc.
22     } catch (ConnectionException ce) {
23      ce.printStackTrace();
24     }

ユーザインターフェースの場合は、プロキシサーバを使用してコールをインターセプトし、必要な情報を追加します。

標準 SOQL 使用状況

ApiEvent では、2 つの項目 (EventDate と EventIdentifier) で絞り込みができます。ApiEvent オブジェクトでサポートされている SOQL 関数は、WHERE、ORDER BY、および LIMIT のみです。WHERE 句では、比較演算子 (<、>、<=、および >=) のみを使用できます。!= 演算子はサポートされていません。ORDER BY 句では、EventDate DESC のみを使用できます。EventDate では昇順はサポートされておらず、EventIdentifier では並べ替えはサポートされていません。

convertTimeZone() などの日付関数はサポートされていません。たとえば、SELECT CALENDAR_YEAR(EventDate), Count(Id) FROM ApiEvent GROUP BY CALENDAR_YEAR(EventDate) はエラーを返します。クエリの日付リテラルや、TODAY()、YESTERDAY()、LAST_n_DAYS:1 のような日付/時間関数は使用できます。ただし、これらの関数はバックグラウンドで比較演算子を使用します。つまり、これらは WHERE 句の最後の式でのみ使用できます。

メモ

次のリストで、有効なクエリと無効なクエリの例を確認してください。

絞り込みなし
- 有効 — WHERE 句が含まれないため、特殊なルールは適用されません。
  1SELECT ApiType, Client, ElapsedTime, QueriedEntities, Username 2FROM ApiEvent
EventDate で絞り込み — EventDate のみで絞り込みできますが、他の項目で絞り込むと失敗します。このクエリ種別では比較演算子も使用できます。
- 有効 — EventDate のみで絞り込みできますが、他の項目で絞り込むと失敗します。このクエリ種別では比較演算子も使用できます。
  1SELECT ApiType, Client, ElapsedTime, QueriedEntities, Username 2FROM ApiEvent 3WHERE EventDate>=2014-11-27T14:54:16.000Z

非同期 SOQL 使用状況

非同期 SOQL の場合は、ApiEvent の項目を絞り込み、クエリに任意の比較演算子を使用できます。

例: ユーザが Patent__c に対して実行したすべてのクエリを検索する

SELECT EventDate, EventIdentifier, PolicyOutcome, EvaluationTime, Query FROM ApiEvent WHERE QueriedEntities='Patent_c'

Platform Events Developer Guide (プラットフォームイベント開発者ガイド)