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

PlatformEventChannelMember

標準またはカスタムチャネルの変更データキャプチャ通知に選択されたエンティティを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

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` です。
selectedEntity	string	必須。変更データキャプチャ通知に選択されたエンティティの変更イベント名。たとえば、Account 標準オブジェクトの場合、名前は `AccountChangeEvent`、MyObject__c カスタムオブジェクトの場合、名前は `MyObject__ChangeEvent` です。

EnrichedField

変更データキャプチャ強化用に PlatformEventChannelMember で選択された項目。空でない強化された項目は、変更されていなくても更新または削除の変更イベントに追加されます。

項目名	項目の型	説明
name	string	変更イベントを強化するために選択された項目の名前。

使用方法

PlatformEventChannelMember メタデータ型では createMetadata() および deleteMetadata() コールはサポートされていません。

チャネルからチャネルメンバーを削除するには、この型に対して destructiveChanges.xml をリリースして、メンバーの完全名を指定します。

宣言的なメタデータの定義のサンプル

この PlatformEventChannelMember コンポーネントは、リード変更イベント選択を変更データキャプチャ選択 (標準 ChangeEvents チャネル) の一部として表します。

コンポーネント例の名前は ChangeEvents_LeadChangeEvent.platformEventChannelMember です。ファイル名の拡張子以外の部分は、コンポーネントの完全名 (ChangeEvents_LeadChangeEvent) に対応します。

メモ

チャネルで複数のエンティティが選択されている場合、各エンティティは PlatformEventChannelMember コンポーネントによって別々に表されます。たとえば、次のコンポーネントは、標準 ChangeEvents チャネルの 2 番目のメンバーであり、取引先責任者変更イベントを表します。

次の例は、SalesEvents__chn カスタムチャネルで選択されたエンティティです。

次の例は、SalesEvents__chn カスタムチャネルで選択されたエンティティの 1 つの強化された項目 (Phone) を示しています。強化された項目は、API バージョン 51.0 以降でサポートされています。

チャネルメンバーの完全名のアンダースコア

完全名に含まれる 2 つの連続したアンダースコアは、コンポーネント名のサフィックスまたは名前空間のプレフィックスを指定します。他のすべてのケースでは、完全名に含まれる 2 つの連続したアンダースコアはサポートされません。チャネルメンバー名にカスタムチャネル名を含めることで一意の名前にしてある場合は、2 つのアンダースコアを 1 つのアンダースコアに置き換えてください。たとえば、SalesEvents_chn_AccountChangeEvent というメンバー名は使用できますが、SalesEvents__chn_AccountChangeEvent は使用できません。

Package.xml でのチャネルメンバーとチャネルの参照

次のマニフェストファイルは、ChangeEvents 標準チャネルの定義例を参照します。PlatformEventChannelMember の <members> 項目に各メンバーをリストします。<members> 項目には、チャネルメンバーの完全名が ChannelName_EventName の形式で格納されます。

次のマニフェストファイルは、SalesEvents__chn カスタムチャネルのメンバーを参照します。

カスタムチャネルとチャネルメンバーを取得するには、次の例のように同じ package.xml ファイルで参照できます。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド