| Client |
- 型
- string
- プロパティ
- Filter、Group、Nillable、Sort
- 説明
- この項目は、利用状況総計値が有効になっている場合にのみ使用できます。クライアントの ID。登録者クライアントについて Client 項目が入力されるのは、イベント配信の利用状況の場合です。公開者クライアントの場合、クライアント ID があれば、Client 項目に入力され、そうでない場合は空になります。
-
Client 項目は、次のいずれかの値になります。
- ストリーミング API (CometD) クライアントと empApi Lightning コンポーネントの場合、クライアント ID は CometD セッションの ID になります。
- Pub/Sub API クライアントの場合、クライアント ID は次の形式になります: pub-sub-api-timestamp。タイムスタンプは、クライアント接続が開始された現在の UTC 時間 (ミリ秒) です。
- イベントリレーの場合、クライアント ID は次の形式になります: relay-client-timestamp。タイムスタンプは、クライアント接続が開始された現在の UTC 時間 (ミリ秒) です。
|
| EndDate |
- 型
- dateTime
- プロパティ
- Filter、Nillable、Sort
- 説明
- 利用状況総計値の照会で使用する終了日時 (UTC)。日付の粒度は時です。
- 過去 24 時間の利用状況データを取得する場合、終了日は現在の日付 (UTC) になります。時間は現在の時間 (UTC) の前の正時に丸められます。たとえば、11:23 は 11:00 になります。日付形式は 2020-08-04T11:00:00.000Z です。
- 履歴データを取得する場合、終了日 (UTC) は日付範囲の終了日になり、時間は 0 として指定されます。例: 2020-08-04T00:00:00.000Z。日付範囲を照会するには、< または <= 演算子を使用できます。
- 使用する日付形式については、『SOQL および SOSL リファレンス』の「日付形式と日付リテラル」を参照してください。
|
| EventName |
- 型
- string
- プロパティ
- Filter、Group、Nillable、Sort
- 説明
- この項目は、利用状況総計値が有効になっている場合にのみ使用できます。カスタムプラットフォームイベントまたは変更イベントの API 参照名。
- 表示ラベルが「My Event (私のイベント)」のカスタムプラットフォームイベント: My_Event__e
- 変更イベントの例: AccountChangeEvent
-
EventName の利用状況総計値を照会する場合、SELECT 句または WHERE 句の UsageType 項目を指定します。
|
| EventType |
- 型
- picklist
- プロパティ
- Filter、Group、Nillable、Restricted picklist、Sort
- 説明
- この項目は、利用状況総計値が有効になっている場合に使用できます。変更イベントやカスタムプラットフォームイベントなど、利用状況総計値を照会するイベントの種別。
- 値は次のとおりです。
-
CHANGE_EVENT — 変更データキャプチャイベント。
-
CUSTOM_PLATFORM_EVENT — Salesforce 組織で管理者が定義したプラットフォームイベント。
-
EventType の利用状況メトリックスを照会する場合、SELECT 句または WHERE 句の UsageType 項目を指定します。
|
| ExternalId |
- 型
- string
- プロパティ
- Filter、Group、Nillable、Sort
- 説明
- この項目は使用されていません。
|
| Name |
- 型
- picklist
- プロパティ
- Filter、Group、Restricted picklist、Sort
- 説明
- 利用状況の取得の対象である総計値の名前。
- 可能な値は次のとおりです。
-
CHANGE_EVENTS_DELIVERED — CometD および Pub/Sub API クライアント、empApi Lightning コンポーネント、イベントリレーに配信される変更データキャプチャイベントの数
-
CHANGE_EVENTS_PUBLISHED — 公開された変更データキャプチャイベントの数
-
PLATFORM_EVENTS_DELIVERED — CometD および Pub/Sub API クライアント、empApi Lightning コンポーネント、イベントリレーに配信されるプラットフォームイベントの数
-
PLATFORM_EVENTS_PUBLISHED — 公開されたプラットフォームイベントの数
|
| StartDate |
- 型
- dateTime
- プロパティ
- Filter、Nillable、Sort
- 説明
- 利用状況総計値の照会で使用する開始日時 (UTC)。日付の粒度は時です。
- 過去 24 時間の利用状況データを取得する場合、開始日は前日 (UTC) になります。時間は現在の時間 (UTC) の前の正時に丸められます。たとえば、11:23 は 11:00 になります。日付形式は 2020-08-03T11:00:00.000Z です。
- 履歴データを取得する場合、開始日は日付範囲の開始日になり、時間は 0 として指定されます。たとえば、2020-08-03T00:00:00.000Z などです。日付範囲を指定するには、> または >= 演算子を使用できます。
- 拡張された利用状況総計値が有効になっている場合は、次の点に注意してください。
-
StartDate と EndDate の間の期間が、選択した TimeSegment 値に対して有効であることを確認します。
-
StartDate と EndDate の間に指定できる日付範囲は、最大 60 日です。
- 使用する日付形式については、『SOQL および SOSL リファレンス』の「日付形式と日付リテラル」を参照してください。
|
| TimeSegment |
- 型
- picklist
- プロパティ
- Filter、Group、Nillable、Restricted picklist、Sort
- 説明
- この項目は、利用状況総計値が有効になっている場合に使用できます。クエリ結果で返される利用状況データの集計に使用される期間。有効な TimeSegment の値は、StartDate と EndDate で指定された時間範囲によって異なります。
- 値は次のとおりです。
| Daily |
利用状況データが、指定された時間範囲内で毎日集計されます。 |
クエリの StartDate と EndDate で指定された時間範囲が 24 時間以上の場合のみ有効です。 |
| Hourly |
利用状況データは、指定された時間範囲内で 1 時間ごとに集計されます。 |
クエリの StartDate と EndDate で指定された時間範囲が 1 時間から 24 時間の間にある場合のみ有効です。 |
| FifteenMinutes |
利用状況データは、指定された時間範囲内で 15 分ごとに集計されます。 |
クエリの StartDate と EndDate で指定された時間範囲が 15 分から 1 時間の間にある場合のみ有効です。 |
|
| UsageType |
- 型
- picklist
- プロパティ
- Filter、Group、Nillable、Restricted picklist、Sort
- 説明
- この項目は、利用状況総計値が有効になっている場合に使用できます。イベント公開やイベント配信など、照会するイベント利用状況総計値の種別を指定します。この項目は、EventName または EventType の項目と一緒に使用します。
- 値は次のとおりです。
-
PUBLISH — 公開されたイベントの利用状況総計値。
-
DELIVERY — 登録者に配信されたイベントの利用状況総計値。
|
| Value |
- 型
- Long
- プロパティ
- Filter、Group、Nillable、Sort
- 説明
- 指定された総計値と日付範囲の利用状況の値。
|
j