REST を使用してイベントを生成する
Streaming Channel Push REST API リソースを使用して、チャネル登録者に対してイベント通知を生成します。
前提条件:
Postman を使用して、次の手順を実行します。始める前に、Trailhead の「Quick Start: Connect Postman to Salesforce (クイックスタート: Postman から Salesforce への接続)」を実行して、Postman を設定します。
-
Postman を設定して認証したら、Tooling API を使用して SOQL クエリを実行し、ストリーミングチャネル ID を取得します。
- Postman で、[REST] を展開し、[Query (クエリ)] をクリックします。
-
[Params (パラメーター)] を��リックし、q の値に次のクエリを入力します。
1SELECT Name, ID FROM StreamingChannel - [Send (送信)] をクリックします。
- 応答には、/u/notifications/ExampleUserChannel の StreamingChannel ID が含まれます。次のステップで使用するために、この ID を記録しておいてください。
-
push REST API リソースを使用してイベントメッセージを公開します。
- Postman で、 を展開して、[SObject Create (Sobject を作成)] をクリックします。
-
[POST] を選択し、次のパスの <Streaming Channel ID> を先ほどコピーした ID に置き換えた後に、そのパスを要求 URL に追加します: /<Streaming Channel ID>/push。
完全な URL は次のようになります。
1{{_endpoint}}/services/data/v{{version}}/sobjects/:SOBJECT_API_NAME/<Streaming Channel ID>/push - [Params (パラメーター)] をクリックし、[Path Variables (パス変数)] の [SOBJECT_API_NAME] に「StreamingChannel」と入力します。
-
[Body (本文)] をクリックし、次の本文の値を入力します。
1{ 2 "pushEvents": [ 3 { 4 "payload": "Broadcast message to all subscribers", 5 "userIds": [] 6 } 7 ] 8} -
[Send (送信)] をクリックします。
この要求で、チャネルのすべての登録者にイベントが送信されます。Java クライアントで、ペイロードテキストを含む通知を受信します。REST メソッド応答は、イベントが送信された登録者数を示します (この場合は、すべての登録者にイベントを送信するよう設定されているため、–1 になります)。
次の例では、受信した通知メッセージが表示されます。
汎用ストリーミングを使用して、通知が登録者に正常に送信されました。すべての登録者に送信するだけでなく、登録ユーザーのリストを指定して特定の登録者に通知を送信することができます。また、Streaming Channel Push REST API リソースの GET メソッドを使用して、チャネルのアクティブな登録者のリストを取得することもできます。
1{
2 "clientId":"a1ps4wpe52qytvcvbsko09tapc",
3 "data":{
4 "event":{
5 "createdDate":"2016-03-29T19:05:28.334Z",
6 "replayId":55
7 },
8 "payload":"Broadcast message to all subscribers"
9 },
10 "channel":"/u/notifications/ExampleUserChannel"
11}