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

Consumer Goods Cloud 開発者ガイド

Consumer Goods 標準オブジェクト
管理カスタムオブジェクトの同期
リテールエグゼキューションのカスタムオブジェクト
取引プロモーション管理のカスタムオブジェクト
リテールエグゼキューションと取引プロモーション管理のカスタムオブジェクト
今後使用するためのカスタムオブジェクト
Consumer Goods Cloud に関連付けられたオブジェクト
StandardObjectNameChangeEvent
StandardObjectNameFeed
StandardObjectNameHistory
StandardObjectNameOwnerSharingRule
StandardObjectNameShare
Consumer Goods メタデータ API
Consumer Goods ビジネス API
Einstein Object Detection 標準オブジェクト
Einstein Object Detection REST API
Einstein 訪問レコメンデーション標準オブジェクト
Einstein 訪問レコメンデーションのおすすめの関連付けられたオブジェクト
Einstein 訪問レコメンデーションのおすすめアクション
Einstein 訪問活動のおすすめ標準オブジェクト
Einstein 訪問 ToDo のおすすめの関連付けられたオブジェクト
API の有効期限
PDF

StandardObjectNameChangeEvent

ChangeEvent オブジェクトは、変更データキャプチャをサポートする各オブジェクトで利用できます。変更データキャプチャを使用して変更イベントのストリームを登録し、Salesforce のレコードの変更に関連するデータを受け取ることができます。変更には、レコードの作成、既存のレコードの更新、レコードの削除、レコードの復元が含まれます。変更イベントは Salesforce オブジェクトではありません。このため CRUD 操作やクエリをサポートしていません。変更イベントは、オブジェクトリファレンスに含まれているため、どの Salesforce オブジェクトが変更イベントをサポートしているのかを確認できます。

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

describeSObjects()

特別なアクセスルール

  • すべてのオブジェクトが組織で使用できるようになっているわけではありません。一部のオブジェクトでは、特定の機能の設定や権限が有効になっている必要があります。
  • 特殊なアクセス権のルールが存在する場合には、標準オブジェクトのドキュメントを参照してください。たとえば、AccountChangeEvent の場合は、Account への特別なアクセスルールについて参照してください。

変更イベント名

変更イベントは、すべてのカスタムオブジェクト、および標準オブジェクトのサブセットで使用できます。変更イベントの名前は、変更を捉える対象オブジェクトの名前に基づきます。

標準オブジェクトの変更イベント名
1<Standard_Object_Name>ChangeEvent
例: AccountChangeEvent
カスタムオブジェクトの変更イベント名
1<Custom_Object_Name>__ChangeEvent
例: MyCustomObject__ChangeEvent

変更イベント項目

変更イベントに含めることができる項目は、いくつかの例外を除いて、関連する親の Salesforce オブジェクトの項目に対応しています。たとえば、AccountChangeEvent 項目は取引先についての項目に対応します。

変更イベントに含まれない項目は、次のとおりです。

  • IsDeleted システム項目。
  • SystemModStamp システム項目。
  • 項目の値がレコードになく、その項目が他のレコードまたは数式から派生している場合は、変更イベントに含まれます (積み上げ集計項目を除く)。これには、数式項目があります。派生値を持つ項目の例としては、LastActivityDate や PhotoUrl などがあります。

各変更イベントにはヘッダー項目も含まれます。ヘッダー項目は ChangeEventHeader 項目の中に含まれます。ヘッダー項目には、変更が更新または削除のどちらであるかや、オブジェクトの名前 (取引先など) など、イベントに関する情報が含まれます。

イベントペイロードに加えて、イベントスキーマ ID が schema 項目に含まれています。また、イベント固有の項目である replayId も含まれており、これは過去のイベントを検索するために使用されます。

イベントメッセージの例

次の例は、新規取引先レコード作成のイベントメッセージを JSON 形式で表したものです。

1{
2  "schema": "IeRuaY6cbI_HsV8Rv1Mc5g", 
3  "payload": {
4    "ChangeEventHeader": {
5      "entityName": "Account", 
6      "recordIds": [
7        "<record_ID>"
8      ], 
9      "changeType": "CREATE", 
10      "changeOrigin": "com/salesforce/api/soap/51.0;client=SfdcInternalAPI/", 
11      "transactionKey": "0002343d-9d90-e395-ed20-cf416ba652ad", 
12      "sequenceNumber": 1, 
13      "commitTimestamp": 1612912679000, 
14      "commitNumber": 10716283339728, 
15      "commitUser": "<User_ID>"
16    }, 
17    "Name": "Acme", 
18    "Description": "Everyone is talking about the cloud. But what does it mean?", 
19    "OwnerId": "<Owner_ID>", 
20    "CreatedDate": "2021-02-09T23:17:59Z", 
21    "CreatedById": "<User_ID>", 
22    "LastModifiedDate": "2021-02-09T23:17:59Z", 
23    "LastModifiedById": "<User_ID>"
24  }, 
25  "event": {
26    "replayId": 6
27  }
28}

API バージョンとスキーマ

変更イベントを登録すると、登録には最新の API バージョンが使用され、受信するイベントメッセージには最新の項目定義が反映されます。詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』の「API Version and Event Schema (API バージョンとイベントスキーマ)」を参照してください。

使用方法

変更データキャプチャについての詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』を参照してください。

このモデルに準拠するオブジェクト

次のオブジェクトには、このモデルに準拠する関連する ChangeEvent オブジェクトがあります。