Platform Events Developer Guide (プラットフォームイベント開発者ガイド)
jSalesforce API によるイベントメッセージの公開
イベントを公開するには、sObject を挿入する方法と同じ方法でイベントのレコードを作成します。SOAP API、REST API、Bulk API など、任意の Salesforce API を使用してプラットフォームイベントを作成できます。
イベントメッセージを公開すると、API から返された結果に、操作が成功したかどうかと、発生したエラーに関する情報が含まれます。success 項目が true の場合、標準量イベントのイベントが公開されています。大規模イベントの場合、公開要求が Salesforce のキューに入れられ、イベントメッセージがすぐに公開されないことがあります。詳細は、「大規模プラットフォームイベントの保持」を参照してください。success が false の場合、イベント公開操作でエラーが発生しており、エラーは errors 項目で返されています。
返される結果には Id システム項目も含まれます。Id 項目値は、登録者に配信されるイベントメッセージには含まれません。これは、イベントメッセージの識別に使用されず、必ずしも一意ではありません。登録者は、配信されたメッセージに含まれる ReplayId システム項目を使用して、ストリーム内のイベントの位置を特定できます。
REST API
REST API を使用してプラットフォームイベントメッセージを公開するには、POST 要求を次のエンドポイントに送信します。
例
「Low Ink (低インクレベル)」という名前のプラットフォームイベントを定義している場合、Low_Ink__e レコードを追加して、イベント通知を公開します。この例では、種別 Low_Ink__e の 1 つのイベントを REST API で作成します。
REST エンドポイント:
リクエストボディ:
プラットフォームイベントレコードが作成されると、REST 応答が次の出力のように表示されます。簡潔にするため、ヘッダーは削除しています。
SOAP API
SOAP API を使用してプラットフォームイベントメッセージを公開するには、create() コールを使用します。
例
この例は、1 回のコールで 3 つのプラットフォームイベントを作成する要求の SOAP メッセージ (Partner API を使用) を示しています。各イベントに Printer_Model__c という名前の 1 つのカスタム項目が含まれます。
Partner SOAP API 要求の応答は、次のように表示されます。簡潔にするため、ヘッダーは削除しています。