メタデータ API 開発者ガイド
jPlatformEventChannelMember
ファイルのサフィックスおよびディレクトリの場所
PlatformEventChannelMember コンポーネントのサフィックスは .platformEventChannelMember で、platformEventChannelMembers フォルダーに保存されます。
バージョン
PlatformEventChannelMember コンポーネントは、API バージョン 47.0 以降で使用できます。
特別なアクセスルール
この型をリリースおよび取得するには、「アプリケーションのカスタマイズ」権限が必要です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| enrichedFields | EnrichedField[] | 変更データキャプチャ強化用に選択された 1 つ以上の項目。空でない強化された項目は、変更されていなくても更新または削除の変更イベントに追加されます。詳細は、『Change Data Capture Developer Guide (変更データキャプチャ開発者ガイド)』の「Enrich Change Events with Extra Fields When Subscribed with CometD (CometD 登録時の追加項目による変更イベントの強化)」を参照してください。API バージョン 51.0 以降で利用できます。 |
| eventChannel | string | 必須。チャネルの名前。標準チャネルの名前は ChangeEvents です。カスタムチャネルの名前の形式は MyChannel__chn です。 |
| filterExpression | string |
イベントのストリームを絞り込み、特定の条件に一致したイベントのみを配信するために使用される式。検索条件式には、1 つ以上の項目 - 値式を含めることができます。検索条件式は SOQL に準拠しており、SOQL の一部の演算子やデータ型をサポートしています。 たとえば、次の検索条件式は、値が 'San Francisco' の City__c 項目を含むイベントのみを配信します。City__c = 'San Francisco' 詳細は、『プラットフォームイベント開発者ガイド』の「カスタムチャネルを使用したプラットフォームイベントストリームの絞り込み」、および『変更データキャプチャ開発者ガイド』の「Filter Your Stream of Change Events with Channels (チャネルを使用した変更イベントストリームの絞り込み)」を参照してください。API バージョン 56.0 以降で利用できます。 |
| selectedEntity | string | 必須。変更データキャプチャ通知に選択されたエンティティの変更イベント名。たとえば、Account 標準オブジェクトの場合、名前は AccountChangeEvent、MyObject__c カスタムオブジェクトの場合、名前は MyObject__ChangeEvent です。 |
EnrichedField
変更データキャプチャ強化用に PlatformEventChannelMember で選択された項目。空でない強化された項目は、変更されていなくても更新または削除の変更イベントに追加されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 変更イベントを強化するために選択された項目の名前。 |
使用方法
PlatformEventChannelMember メタデータ型では createMetadata() および deleteMetadata() コールはサポートされていません。
チャネルからチャネルメンバーを削除するには、この型に対して destructiveChanges.xml をリリースして、メンバーの完全名を指定します。
宣言的なメタデータの定義のサンプル
この PlatformEventChannelMember コンポーネントは、リード変更イベント選択を変更データキャプチャ選択 (標準 ChangeEvents チャネル) の一部として表します。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3 <eventChannel>ChangeEvents</eventChannel>
4 <selectedEntity>LeadChangeEvent</selectedEntity>
5</PlatformEventChannelMember>チャネルで複数のエンティティが選択されている場合、各エンティティは PlatformEventChannelMember コンポーネントによって別々に表されます。たとえば、次のコンポーネントは、標準 ChangeEvents チャネルの 2 番目のメンバーであり、取引先責任者変更イベントを表します。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3 <eventChannel>ChangeEvents</eventChannel>
4 <selectedEntity>ContactChangeEvent</selectedEntity>
5</PlatformEventChannelMember>次の例は、SalesEvents__chn カスタムチャネルで選択されたエンティティです。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3 <eventChannel>SalesEvents__chn</eventChannel>
4 <selectedEntity>ContactChangeEvent</selectedEntity>
5</PlatformEventChannelMember>次の例は、SalesEvents__chn カスタムチャネルで選択されたエンティティの 1 つの強化された項目 (Phone) を示しています。強化された項目は、API バージョン 51.0 以降でサポートされています。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enrichedFields>
4 <name>Phone</name>
5 </enrichedFields>
6 <eventChannel>SalesEvents__chn</eventChannel>
7 <selectedEntity>ContactChangeEvent</selectedEntity>
8</PlatformEventChannelMember>次の例は、SalesEvents__chn カスタムチャネルで選択された ContactChangeEvent エンティティの検索条件式を示しています。
1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3 <eventChannel>SalesEvents__chn</eventChannel>
4 <filterExpression>(Region__c='AMER')</filterExpression>
5 <selectedEntity>ContactChangeEvent</selectedEntity>
6</PlatformEventChannelMember>チャネルメンバーの完全名のアンダースコア
完全名に含まれる 2 つの連続したアンダースコアは、コンポーネント名のサフィックスまたは名前空間のプレフィックスを指定します。他のすべてのケースで��、完全名に含まれる 2 つの連続したアンダースコアはサポートされません。チャネルメンバー名にカスタムチャネル名を含めることで一意の名前にしてある場合は、2 つのアンダースコアを 1 つのアンダースコアに置き換えてください。たとえば、SalesEvents_chn_AccountChangeEvent というメンバー名は使用できますが、SalesEvents__chn_AccountChangeEvent は使用できません。
Package.xml でのチャネルメンバーとチャネルの参照
次のマニフェストファイルは、ChangeEvents 標準チャネルの定義例を参照します。PlatformEventChannelMember の <members> 項目に各メンバーをリストします。<members> 項目には、チャネルメンバーの完全名が ChannelName_EventName の形式で格納されます。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>ChangeEvents_LeadChangeEvent</members>
5 <members>ChangeEvents_ContactChangeEvent</members>
6 <name>PlatformEventChannelMember</name>
7 </types>
8 <version>60.0</version>
9</Package>次のマニフェストファイルは、SalesEvents__chn カスタムチャネルのメンバーを参照します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>SalesEvents_chn_AccountChangeEvent</members>
5 <members>SalesEvents_chn_ContactChangeEvent</members>
6 <members>SalesEvents_chn_MyCustomObj_ChangeEvent</members>
7 <name>PlatformEventChannelMember</name>
8 </types>
9 <version>60.0</version>
10</Package>カスタムチャネルとチャネルメンバーを取得するには、次の例のように同じ package.xml ファイルで参照できます。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>SalesEvents__chn</members>
5 <name>PlatformEventChannel</name>
6 </types>
7 <types>
8 <members>SalesEvents_chn_AccountChangeEvent</members>
9 <members>SalesEvents_chn_ContactChangeEvent</members>
10 <members>SalesEvents_chn_MyCustomObj_ChangeEvent</members>
11 <name>PlatformEventChannelMember</name>
12 </types>
13 <version>60.0</version>
14</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。