プラットフォームイベント開発者ガイド
j変更データキャプチャイベント
Salesforce 変更データキャプチャでは、Salesforce レコードの変更を表す変更イベントが公開されます。変更には、レコードの作成、既存のレコードの更新、レコードの削除、レコードの復元が含まれます。変更データキャプチャイベントは API バージョン 44.0 以降で使用できます。
変更イベント名
変更イベントは、すべてのカスタムオブジェクト、および標準オブジェクトのサブセットで使用できます。変更イベントの名前は、変更を捉える対象オブジェクトの名前に基づきます。サポートされている標準オブジェクトについては、『Salesforce および Lightning プラットフォームのオブジェクトリファレンス』の「StandardObjectNameChangeEvent」を参照してください。
- 標準オブジェクトの変更イベント名
-
1<Standard_Object_Name>ChangeEvent - 例: AccountChangeEvent
- カスタムオブジェクトの変更イベント名
-
1<Custom_Object_Name>__ChangeEvent - 例: Employee__ChangeEvent
登録チャネル
変更イベントの登録チャネルは、通知を受信する変更イベントの名前によって異なります。また、すべての通知を受信するための汎用チャネルが提供されています。
- すべての変更イベントのチャネル
- 変更データキャプチャで選択されているすべてのオブジェクトのイベントメッセージを受信するには、次のチャネルを使用します。
1/data/ChangeEvents - 標準オブジェクトのチャネル
- 標準オブジェクトの変更に対するイベントメッセージを受信するには、次のチャネルを使用します。
1/data/<Standard_Object_Name>ChangeEvent - 例: AccountChangeEvent
- カスタムオブジェクトのチャネル
- カスタムオブジェクトの変更に対するイベントメッセージを受信するには、次のチャネルを使用します。
1/data/<Custom_Object_Name>__ChangeEvent - 例: Employee__ChangeEvent
変更イベント項目
変更イベントのレコード項目は、関連付けられた Salesforce オブジェクトまたは変更をトリガーしたエンティティの項目に対応します。イベントメッセージには新規項目または更新された項目のみが含まれます。
たとえば、取引先オブジェクトの変更イベントで送信できる項目は取引先項目です。標準オブジェクトの項目を確認するには、『Salesforce および Lightning プラットフォームのオブジェクトリファレンス』を参照してください。
各変更イベントにはヘッダー項目も含まれます。ヘッダー項目は ChangeEventHeader 項目の中に含まれます。ヘッダー項目には、変更が更新または削除のどちらであるかや、エンティティの名前 (取引先など) など、イベントに関する情報が含まれます。
次の例は、変更イベントメッセージの構造を示しています。
1{
2 "data": {
3 "schema": "<schema_ID>",
4 "payload": {
5 "ChangeEventHeader": {
6 "entityName" : "...",
7 "recordIds" : ["..."],
8 "changeType" : "...",
9 "changeOrigin" : "...",
10 "transactionKey" : "...",
11 "sequenceNumber" : "...",
12 "commitTimestamp" : "...",
13 "commitUser" : "...",
14 "commitNumber" : "..."
15 },
16 "field1":"...",
17 "field2":"...",
18 . . .
19 },
20 "event": {
21 "replayId": <replayID>
22 }
23 },
24 "channel": "/data/<channel>"
25}イベントメッセージの例
次のイベントは新規取引先に対して送信されます。
1{
2 "data": {
3 "schema": "IeRuaY6cbI_HsV8Rv1Mc5g",
4 "payload": {
5 "ChangeEventHeader": {
6 "entityName": "Account",
7 "recordIds": [
8 "<record_ID>"
9 ],
10 "changeType": "CREATE",
11 "changeOrigin": "com/salesforce/api/soap/46.0;client=Astro",
12 "transactionKey": "001b7375-0086-250e-e6ca-b99bc3a8b69f",
13 "sequenceNumber": 1,
14 "commitTimestamp": 1556737866,
15 "commitNumber": 92847272780,
16 "commitUser": "<User_ID>"
17 },
18 "Name": "Acme",
19 "Description": "Everyone is talking about the cloud. But what does it mean?",
20 "OwnerId": "<Owner_ID>",
21 "CreatedDate": "2019-05-01T12:11:44Z",
22 "CreatedById": "<User_ID>",
23 "LastModifiedDate": "2019-05-01T12:11:44Z",
24 "LastModifiedById": "<User_ID>"
25 },
26 "event": {
27 "replayId": 6
28 }
29 },
30 "channel": "/data/ChangeEvents"
31}リソース
変更データキャプチャについての詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』を参照してください。