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

ApiEventStream

query()queryMore()、および count() のユーザが開始した読み取り専用 API 呼び出しを追跡します。Enterprise WSDL および Partner WSDL の場合、SOAP API、REST API、および Bulk API によって API 要求を捕捉します。Salesforce モバイルアプリケーションから開始された Tooling API コールおよび API コールは捕捉されません。このオブジェクトは API バージョン 46.0 以降で使用できます。

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

describeSObjects()

サポートされている登録者

登録者 サポートされているかどうか
Apex トリガ
フロー
プロセス
ストリーミング API (CometD) はい

ストリーミング API 登録チャネル

/event/ApiEventStream

特別なアクセスルール

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

項目

項目 詳細
AdditionalInfo
string
プロパティ
Nillable
説明
API 要求中に HTTP ヘッダーから取得した追加情報を JSON に逐次化したもの。たとえば、{"field1": "value1", "field2": "value2"} です。
ApiType
string
プロパティ
Nillable
説明
使用された API。次のような値があります。
  • SOAP Enterprise
  • SOAP Partner
  • REST API
  • なし
ApiVersion
double
プロパティ
Nillable
説明
API のバージョン番号。
Application
string
プロパティ
Nillable
説明
組織にアクセスするために使用するアプリケーション。Tableau CRM や Salesforce 開発者コネクタなどがあります。
Client
string
プロパティ
Nillable
説明
API イベントを実行したサービス。不明なクライアントを使用している場合、この項目で「不明」または空白の値が返されます。
ConnectedAppId
string
プロパティ
Nillable
説明
API コールに関連付けられた接続アプリケーションの 15 文字の ID。たとえば、0H4RM00000000Kr0AI です。
ElapsedTime
int
プロパティ
Nillable
説明
要求の完了にかかった時間 (ミリ秒単位)。この値の測定は、クエリが実行される前に始まり、クエリが完了すると終了します。ネットワーク経由で結果を返すのにかかる時間は含まれません。
EvaluationTime
double
プロパティ
Nillable
説明
ポリシーの評価にかかった時間 (ミリ秒単位)。
EventDate
dateTime
プロパティ
Nillable
説明
指定された API イベントが捕捉された時間 (クエリの実行後)。たとえば、「2020-01-20T19:12:26.965Z」などです。最も細かい設定はミリ秒です。
EventIdentifier
string
プロパティ
Nillable
説明
対応するストレージオブジェクトと共有される、イベントの一意の ID。たとえば、0a4779b0-0da1-4619-a373-0a36991dff90 です。この項目は、イベントとそのストレージオブジェクトを相関させるために使用します。
EventUuid
string
プロパティ
Nillable
説明
プラットフォームイベントメッセージを識別するユニバーサル一意識別子 (UUID)。この項目は、API バージョン 52.0 以降で使用できます。
LoginHistoryId
reference
プロパティ
Nillable
説明
ユーザアクティビティと一連の特定の API イベントを関連付けられるように、ユーザセッションを追跡します。この項目は LoginEvent、AuthSession、および LoginHistory オブジェクトでも使用できるため、ユーザの元の認証へとイベントを簡単にトレースバックできます。たとえば、0YaB000002knVQLKA2 です。
LoginKey
string
プロパティ
Nillable
説明
特定のユーザのログインセッションのすべてのイベントを結び付ける文字列。このセッションはログインイベントで開始され、ログアウトイベントまたはユーザセッションの期限切れで終了します。たとえば、lUqjLPQTWRdvRG4 です。
Operation
picklist
プロパティ
Nillable、Restricted picklist
説明
イベントを生成した API コール。可能な値は、QueryQueryAll、または QueryMore です。
Platform
string
プロパティ
Nillable
説明
ログインマシンのオペレーティングシステム。iPhone、Mac OS、Linux、Unknown などになります。
PolicyId
reference
プロパティ
Nillable
説明
このイベントに関連付けられたトランサクションポリシーの ID。たとえば、0NIB000000000KOOAY です。
PolicyOutcome
picklist
プロパティ
Nillable、Restricted picklist
説明
トランサクションポリシーの結果。このイベントで使用可能な値は次のとおりです。
  • Block - ポリシーをトリガする操作を実行できないようにユーザがブロックされました���
  • Error - ポリシーの実行時にポリシーによって未定義のエラーが発生しました。
  • 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
textarea
プロパティ
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 項目と共に使用して、すべての関連イベントを相関させます。追加の認証が必要でない場合、この項目は空白になります。

ReplayId
string
プロパティ
Nillable
説明
システムによって生成された ID 値を表し、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。登録者は再生 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内の欠落したイベントを取得できます。
RowsProcessed
double
プロパティ
Nillable
説明
ユーザが API クエリを実行したときにクエリから返されたデー���の行の���計数。

Big Object では、返された行の合計数が API バッチサイズよりも大きい場合、RowsProcessed-1 になります。

RowsReturned
double
プロパティ
Nillable
説明
現在の API バッチで返されたデータの行数。

RowsProcessed が API バッチサイズ以下の場合、RowsReturnedRowsProcessed と等しくなります。RowsProcessed が API バッチサイズより大きい場合、RowsReturned は API バッチサイズまたは最後のバッチの行数と等しくなります。

SessionKey
string
プロパティ
Nillable
説明
ユーザの一意のセッション ID。この値を使用して、セッション内のすべてのユーザイベントを識別します。ユーザがログアウトしてから再びログインすると、新しいセッションが開始されます。たとえば、vMASKIU6AxEr+Op5 です。
SessionLevel
picklist
プロパティ
Nillable、Restricted picklist
説明
セッションレベルのセキュリティは、接続アプリケーションやレポートなど、このセキュリティをサポートする機能へのユーザのアクセス権を制御します。可能な値は次のとおりです。
  • HIGH_ASSURANCE — リソースへのアクセスに高保証セッションが使用されました。たとえば、高保証セッションレベルが必要な接続アプリケーション、レポート、ダッシュボードなどのリソースにユーザがアクセスしようとした場合です。
  • LOW - 現在のセッションに対するユーザのセキュリティレベルが最低限の要件を満たします。

    この Low レベルは、Salesforce UI で利用不可能であり、使用されません。UI を介したユーザセッションは、標準または高保証です。このレベルは API を使用して設定できますが、このレベルに割り当てられたユーザは、Salesforce 組織で使用できる機能が制限され、またどの機能を使用できるかを判断することができません。

    メモ

  • STANDARD - 現在のセッションに対するユーザのセキュリティレベルが、現在の組織のセッションセキュリティレベルの標準の要件セットを満たします。
SourceIp
string
プロパティ
Nillable
説明
API イベントの発生元の IP。Salesforce 内部 IP (Salesforce 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 形式の発生元のユーザ名。