ApiEvent

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

describeSObjects()、query()

特別なアクセスルール

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

項目

項目	詳細
AdditionalInfo	型 string プロパティ Nillable 説明 API 要求中に `HTTP` ヘッダーから取得した追加情報を JSON にシリアライズしたもの。たとえば、`{"field1": "value1", "field2": "value2"}` です。使用法のヒントや使用例については、「AdditionalInfo 項目の使用」セクションを参照してください。
ApiType	型 string プロパティ Nillable 説明使用された API。次のような値があります。 `Bulk` `REST` `SOAP Enterprise` `SOAP Partner` `なし`
ApiVersion	型 double プロパティ Nillable 説明 API のバージョン番号。
Application	型 string プロパティ Nillable 説明組織にアクセスするために使用するアプリケーション。CRM Analytics や Salesforce 開発者コネクタなどがあります。
Client	型 string プロパティ Nillable 説明 API イベントを実行したサービス。不明なクライアントを使用している場合、この項目で「不明」または空白の値が返されます。
ConnectedAppId	型 reference プロパティ Nillable 説明 API コールに関連付けられた接続アプリケーションの 15 文字の ID。たとえば、0H4RM00000000Kr0AI です。ConnectedAppID 項目は、コールで OAuth 2.0 認証プロセスがトリガーされると入力されます。これにより、ユーザーの代理で Salesforce データにアクセスすることを許可された接続アプリケーションが識別されます。コールに関連付けられたユーザーがすでに有効な認証トークンを持っている場合、ConnectedAppID は null 値に設定されます。
ElapsedTime	型 int プロパティ Nillable 説明要求の完了にかかった時間 (ミリ秒単位)。この値の測定は、クエリが実行される前に始まり、クエリが完了すると終了します。ネットワーク経由で結果を返すのにかかる時間は含まれません。
EvaluationTime	型 double プロパティ Nillable 説明ポリシーの評価にかかった時間 (ミリ秒単位)。
EventDate	型 dateTime プロパティ Filter、Sort 説明指定された API イベントが捕捉された時間 (クエリの実行後)。たとえば、「`2020-01-20T19:12:26.965Z`」などです。最も細かい設定はミリ秒です。
EventIdentifier	型 string プロパティ Filter、Sort 説明イベントの一意の ID。たとえば、0a4779b0-0da1-4619-a373-0a36991dff90 などです。
LoginHistoryId	型 reference プロパティ Nillable 説明ユーザー活動と一連の特定の API イベントを関連付けられるように、ユーザーセッションを追跡します。この項目は LoginEvent、AuthSession、および LoginHistory オブジェクトでも使用できるため、ユーザーの元の認証へとイベントを簡単にトレースバックできます。たとえば、0YaB000002knVQLKA2 です。
LoginKey	型 string プロパティ Nillable 説明特定のユーザーのログインセッションのすべてのイベントを結び付ける文字列。このセッションはログインイベントで開始され、ログアウトイベントまたはユーザーセッションの期限切れで終了します。たとえば、lUqjLPQTWRdvRG4 です。
Operation	型 picklist プロパティ Nillable、Restricted picklist 説明イベントを生成した API コール。可能な値は、`Query`、`QueryAll`、または `QueryMore` です。
Platform	型 string プロパティ Nillable 説明ログインマシンのオペレーティングシステム。iPhone、Mac OS、Linux、Unknown などになります。
PolicyId	型 reference プロパティ Nillable 説明このイベントに関連付けられたトランザクションポリシーの ID。たとえば、0NIB000000000KOOAY です。
PolicyOutcome	型 picklist プロパティ Nillable、Restricted picklist 説明トランザクションポリシーの結果。このイベントで使用可能な値は次のとおりです。 `Block` - ポリシーをトリガーする操作を実行できないようにユーザーがブロックされました。 `Error` - ポリシーの実行時にポリシーによって未定義のエラーが発生しました。 `ExemptNoAction` — このユーザーはトランザクションセキュリティポリシーの対象外のため、ポリシーがトリガーされませんでした。 `MeteringBlock` — ポリシーの処理に 3 秒以上かかったため、操作を実行できないようにユーザーがブロックされました。 `MeteringNoAction` — ポリシーの処理に 3 秒以上かかりましたが、ユーザーは操作の実行をブロックされませんでした。 `NoAction` - ポリシーがトリガーしませんでした。 `Notified` - 受信者に通知が送信されました。
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 を表します。たとえば、bd76f3e7-9ee5-4400-9e7f-54de57ecd79c です。この項目は、このイベントで監視している活動で追加の認証 (多要素認証など) が必要とされる場合にのみ入力されます。この場合、Salesforce はより多くのイベントを生成し、新しいイベントの RelatedEventIdentifier 項目を元のイベントの EventIdentifier 項目の値に設定します。この項目を EventIdentifier 項目と共に使用して、すべての関連イベントを相関させます。追加の認証が必要でない場合、この項目は空白になります。
RowsProcessed	型 double プロパティ Nillable 説明ユーザーが API クエリを実行したときにクエリから返されたデータの行の合計数。 Big Object では、返された行の合計数が API バッチサイズよりも大きい場合、RowsProcessed は `-1` になります。
RowsReturned	型 double プロパティ Nillable 説明現在の API バッチで返されたデータの行数。 RowsProcessed が API バッチサイズ以下の場合、RowsReturned は RowsProcessed と等しくなります。RowsProcessed が API バッチサイズより大きい場合、RowsReturned は API バッチサイズまたは最後のバッチの行数と等しくなります。
SessionKey	型 string プロパティ Nillable 説明ユーザーの一意のセッション ID。この値を使用して、セッション内のすべてのユーザーイベントを識別します。ユーザーがログアウトしてから再びログインすると、新しいセッションが開始されます。たとえば、vMASKIU6AxEr+Op5 です。
SessionLevel	型 picklist プロパティ Nillable、Restricted picklist 説明セッションレベルのセキュリティは、接続アプリケーションやレポートなど、このセキュリティをサポートする機能へのユーザーのアクセス権を制御します。可能な値は次のとおりです。 `HIGH_ASSURANCE` - リソースへのアクセスに高保証セッションが使用されました。たとえば、高保証セッションレベルが必要な接続アプリケーション、レポート、ダッシュボードなどのリソースにユーザーがアクセスしようとした場合です。 `LOW` - 現在のセッションに対するユーザーのセキュリティレベルが最低限の要件を満たします。この Low レベルは、Salesforce UI で利用不可能であるか、使用されません。UI を介したユーザーセッションは、標準または高保証です。このレベルは API を使用して設定できますが、このレベルに割り当てられたユーザーは、使用できる機能が制限され、またどの機能を使用できるかを判断することができません。 `STANDARD` - 現在のセッションに対するユーザーのセキュリティレベルが、現在の組織のセッションセキュリティレベルの標準の要件セットを満たします。
SourceIp	型 string プロパティ Nillable 説明 API イベントの発生元の IP。Salesforce 内部 IP (AppExchange から発生する API イベントなど) は、「Salesforce.com IP」と表示されます。
UserAgent	型 string プロパティ Nillable 説明 API コールが発生したプラットフォームまたは環境。この項目には、オペレーティングシステム、アプリケーション、または Web プロトコルに関する情報を含めることができます。たとえば、「`Mozilla/5.0 (iPhone; CPU iPhone OS 13_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko)`」などです。
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 のみで絞り込みできますが、他の項目で絞り込むと失敗します。このクエリ種別では比較演算子も使用できます。

1SELECT ApiType, Client, ElapsedTime, QueriedEntities, Username
2FROM ApiEvent 
3WHERE EventDate>=2014-11-27T14:54:16.000Z

プラットフォームイベント開発者ガイド