プラットフォームイベント開発者ガイド
Spring '26 (API version 66.0)
Winter '25 (API version 62.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
フロー
プロセス
Lightning のコンポーネント
Pub/Sub API
CometD
EventUuid 項目を使用したイベントメッセージの識別と照合
プラットフォームイベントの公開および配信の使用状況を監視する
プラットフォームイベントの登録
-
イベント登録のデバッグログの設定
プラットフォームイベントトリガ、イベントプロセス、および再開されたフローインタビューのデバッグログは自動化プロセスにより作成され、対応する Apex コードログから分離されます。上書きされた実行ユーザが設定されたプラットフォームイベントトリガでは、デバッグログは指定したユーザによって作成されます。開発者コンソールの [ログ] タブでこのデバッグログを使用することはできません。 -
フローによるプラットフォームイベントメッセージの登録
プラットフォームイベントメッセージを受信すると、フローを起動したり、インタビューと呼ばれるフローのインスタンスの実行を再開したりします。登録済みのフローおよびインタビューは、Apex、API、フロー、または他のプロセスで公開されたイベントメッセージを受信できます。フローおよびインタビューでは自動登録メカニズムを利用できます。 -
プロセスによるプラットフォームイベントメッセージの登録
プロセスビルダーで作成されたプロセスでプラットフォームイベントを登録し、Apex、API、フロー、または他のプロセスで公開されたイベントメッセージを受信できます。プロセスは自動登録メカニズムを提供します。 -
Apex トリガによるプラットフォームイベント通知の登録
Apex トリガを使用してイベントを登録します。イベント通知がどのような方法 (Apex または API) で公開されたかにかかわらず、トリガでイベント通知を受信できます。トリガは自動登録メカニズムを提供します。Apex でチャネルを明示的に作成し、そのチャネルをリスンする必要はありません。 -
Lightning コンポーネントでのプラットフォームイベント通知の登録
Lightning Web コンポーネントまたは Aura コンポーネントの empApi コンポーネントを使用して、プラットフォームイベントを登録します。empApi コンポーネントによって、ストリーミングチャネルの登録とイベントメッセージのリスンを行うメソッドにアクセスできます。 -
Pub/Sub API によるプラットフォームイベント通知の登録
Pub/Sub API は、外部クライアントのイベントメッセージに登録し、システムを統合するために使用します。1 つの API を使用してイベントスキーマの公開、登録、取得を行うことで、開発を単純化します。Pub/Sub API では、gRPC と HTTP/2 に基づいて、Apache Avro 形式のバイナリイベントメッセージを効率的に配信できます。クライアントでのイベント処理速度に応じて、Subscribe コールごとに受信するイベントメッセージの量を制御できます。 -
CometD によるプラットフォームイベント通知の登録
CometD を使用して、外部クライアントでプラットフォームイベントを登録します。独自の CometD クライアントを実装するか EMP コネクタを使用します。EMP コネクタはオープンソースのコミュニティサポートツールであり、CometD への登録およびチャネルのリスンに関するすべての詳細を実装します。 -
カスタムチャネルを使用したプラットフォームイベントの 1 つのストリームへのグループ化
カスタムチャネルを使用して、Salesforce 組織で定義された 1 つ以上のプラットフォームイベントに対応するイベントメッセージの 1 つのストリームを受信できます。たとえば、さまざまな地域の注文に対応���るプラットフォームイベントを定義した場合、1 つのクライアントがそのすべてのイベントに登録して処理することができます。カスタムチャネルは CometD と Pub/Sub API クライアントでのみサポートされています。カスタムチャネルに検索条件 (ベータ) を追加することもできます。1 つのみのクライアントを使用してすべてのイベントに登録し、検索条件を使用することによって、登録が最適化されます。 -
カスタムチャネルを使用したプラットフォームイベントストリームの絞り込み
カスタムチャネルで定義済みの検索条件に一致するイベントメッセージのみを受信します。チャネルを作成し、検索条件式で設定します。チャンネルへの CometD 登録者は、絞り込まれたイベントストリームを受信します。登録者に配信されるイベントの数が少なくなるため、イベント処理が最適化されます。また、CometD 登録者はイベント配信割り当てをより効率的に使用できます。 -
プラットフォームイベントのサブスクライバーの取得
Salesforce ユーザインターフェースまたは API を使用して、プラットフォームイベントを登録しているすべてのトリガまたはプロセスのリストを表示します。 -
EventUuid 項目を使用したイベントメッセージの識別と照合
プラットフォームイベントメッセージには、イベントメッセージを識別する EventUuid 項目が含まれています。この項目を使用して、公開および受信したイベントメッセージを照合します。この照合では、受信したイベントの UUID と公開コールの SaveResult で返された UUID が比較されます。これにより、配信されていないイベントメッセージを見つけて再公開できます。