Tooling API によるカスタムチャネルの作成とプラットフォームイベントの追加
この例では、Order_Channel__chn という名前の注文用チャネルを作成し、そのメンバーとして Order_NorthAmer__e と Order_EMEA__e の 2 つのプラットフォームイベントを追加します。
| 必要なユーザー権限 | |
|---|---|
| PlatformEventChannel と PlatformEventChannelMember オブジェクトを作成または更新する | 「アプリケーションのカスタマイズ」 |
| REST API を使用する | 「API の有効化」 |
次の手順は、お好みの REST API ツールを使用して実行できます。お勧めは、Postman と、Salesforce API コール用の便利なテンプレートが収録されている Salesforce API Collection を併用することです。Postman の設定については、「Salesforce APIs for Postman (Postman 用 Salesforce API)」を参照してください。
-
PlatformEventChannel を使用してチャネルを作成し、channelType 項目を event に設定します。次の URI 宛に POST 要求を送信します。
1/services/data/v60.0/tooling/sobjects/PlatformEventChannel -
次のリクエストボディを使用します。
1{ 2 "FullName": "Order_Channel__chn", 3 "Metadata": { 4 "channelType": "event", 5 "label": "Custom Channel for Orders" 6 } 7}次のような応答が返されます。1{ 2 "id": "0YLRM0000004CEI4A2", 3 "success": true, 4 "errors": [], 5 "warnings": [], 6 "infos": [] 7} -
PlatformEventChannelMember を使用して、Order_NorthAmer__e プラットフォームイベントをチャネルに追加します。チャネルメンバーは、eventChannel 項目で、そのチャネルメンバーが属するチャネル (Order_Channel__chn) を参照します。プラットフォームイベントを selectedEntity 項目に指定します。次の URI 宛に POST 要求を送信します。
1/services/data/v60.0/tooling/sobjects/PlatformEventChannelMember -
次のリクエストボディを使用します。
1{ 2 "FullName": "Order_Channel_chn_Order_NorthAmer_e", 3 "Metadata": { 4 "eventChannel": "Order_Channel__chn", 5 "selectedEntity": "Order_NorthAmer__e" 6 } 7}次のような応答が返されます。1{ 2 "id": "0v8RM0000000N6uYAE", 3 "success": true, 4 "errors": [], 5 "warnings": [], 6 "infos": [] 7} -
プラットフォームイベント Order_EMEA__e を指定する 2 番目のチャネルメンバーを追加します。次の URI 宛に POST 要求を送信します。
1/services/data/v60.0/tooling/sobjects/PlatformEventChannelMember -
次のリクエストボディを使用します。
1{ 2 "FullName": "Order_Channel_chn_Order_EMEA_e", 3 "Metadata": { 4 "eventChannel": "Order_Channel__chn", 5 "selectedEntity": "Order_EMEA__e" 6 } 7}次のような応答が返されます。1{ 2 "id": "0v8RM0000004VPJYA2", 3 "success": true, 4 "errors": [], 5 "warnings": [], 6 "infos": [] 7}