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

PlatformEventChannel

Salesforce レコードの変更通知を受け取るために登録できる、変更データキャプチャの標準またはカスタムチャネルを表します。標準チャネルは、[設定] の [変更データキャプチャ] ページのエンティティ選択に対応します。カスタムチャネルとは、このメタデータ型を使用して定義するチャネルです。API バージョン 47.0 から、チャネルには (それぞれが PlatformEventChannelMember で表される) 選択されたエンティティは含まれなくなりました。API バージョン 46.0 以前では、チャネルには選択されたエンティティが含まれていました。変更データキャプチャでは、選択されたエンティティの作成、更新、削除、復元されたレコードの通知のみが送信されます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

PlatformEventChannel コンポーネントのサフィックスは .platformEventChannel で、platformEventChannels フォルダに保存されます。

バージョン

PlatformEventChannel コンポーネントは、API バージョン 45.0 以降で使用できます。

特別なアクセスルール

この型をリリースおよび取得するには、「アプリケーションのカスタマイズ」権限が必要です。

項目

項目名	項目の型	説明
channelMembers	PlatformEventChannelSelectedEntity[]	削除済み。標準オブジェクトとカスタムオブジェクトを含む、変更データキャプチャ通知に選択されたエンティティのイベント名のリスト。この項目は、API バージョン 47.0 以降では削除されており、API バージョン 45.0 と 46.0 でのみ使用できます。API バージョン 47.0 以降では、チャネルメンバーはそれぞれ PlatformEventChannelMember コンポーネントで定義されます。メモ
channelType	PlatformEventChannelType (string 型の列挙)	必須。チャネル種別。有効な値は、次のとおりです。 `data` — 選択されたエンティティに対応する変更データキャプチャチャネル。 `event` — 将来の使用のために予約。
label	string	必須。チャネルの表示ラベル。

PlatformEventChannelSelectedEntity

この項目種別は、API バージョン 47.0 以降では削除されており、API バージョン 45.0 と 46.0 でのみ使用できます。

メモ

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

使用方法

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

API バージョン 47.0 以降では、ChangeEvents 標準チャネルをリリースまたは取得することはできません。

ChangeEvents 標準チャネルを destructiveChanges.xml で削除することはできませんが、destructiveChanges.xml で PlatformEventChannelMember 型を使用することでチャネルメンバーを削除できます。

カスタムチャネルの宣言的なメタデータの定義のサンプル

PlatformEventChannel コンポーネントには、カスタムチャネルの表示ラベルとチャネル種別が含まれます。

この package.xml は、以前の定義を参照します。カスタムチャネル名は SalesEvents__chn です。

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

すべてのカスタムチャネルをリリースまたは取得するには、<members> 項目でワイルドカード文字の * (アスタリスク) を指定します。

以前のバージョンからバージョン 47.0 以降へのアップグレード

API バージョン 47.0 以降では、PlatformEventChannel 型から channelMembers 項目が削除されています。その結果、以前のバージョンで作成されている PlatformEventChannel コンポーネントを、新しい API バージョンを使用してリリースすることはできません。ただし、それらを作成したのと同じ API バージョンであればリリースできます。

API バージョン 47.0 以降を使用してカスタムチャネルコンポーネントをリリースするには、<channelMembers> 項目を削除することで PlatformEventChannel 定義をアップグレードしてください。ChangeEvents 標準チャネルはリリースも取得もできませんので、PlatformEventChannel 定義ファイルを削除してください。

たとえば、SalesEvents__chn というカスタムチャネルが API バージョン 46.0 のカスタムチャネル定義であるとします。

バージョン 47.0 以降にアップグレードするには、このカスタムチャネル定義を、チャネルメンバーを一切含まない次の定義と置き換えます。

カスタムまたは標準 ChangeEvents チャネルに含まれていた各チャネルメンバーに対しては、PlatformEventChannelMember メタデータコンポーネントを追加します。また、package.xml ファイルでは、PlatformEventChannel コンポーネントと PlatformEventChannelMember コンポーネントの両方を参照します。

たとえば、AccountChangeEvent メンバーに対しては、次の PlatformEventChannelMember コンポーネントを追加します。

詳細は、PlatformEventChannelMember を参照してください。

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