メッセージサービス
*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
このページには、エクスペリエンス内のすべてのサーバーにメッセージを送信できる Open Cloud v1 メッセージサービス API の参照ドキュメントが含まれています。
v2 API には独自の メッセージを公開する メソッドがあります。v2 メソッドの使用に関する情報は、メッセージ使用ガイド を参照してください。
CrossServerMessaging
次のエンドポイントは、ベースのURLに相対するパスで使用できます。
メッセージを公開する
メッセージのサイズが最大 1,024 文字 (1KB) の経験のプリ定義トピックにメッセージを公開します。API キーと OAuth 2.0 アプリのための パブリッシュ 権限および universe-messaging-service:publish スコープが必要です。クロスサーバーメッセージ でユーザーを定義し、トピックにサブスクライブする方法を参照してください。
パラメータ
メッセージを送信したい経験の識別子。エクスペリエンスのユニバースIDをクリエイターダッシュボードにコピーできます。
メッセージを公開したいトピック、最大 80文字。
レスポンス
必要な権限
このエンドポイントを呼び出すには以下のAPIキー権限が必要です。適切なキーの生成方法についての情報は、 API キーの管理 をごらんください。
オブジェクト
以下のオブジェクトは、受け入れられたか返されたペイロードの説明です。これらのオブジェクトがいつ使用されるかについて詳しくは、各エンドポイントを参照してください。
PublishRequest
ライブサーバーに公開したいメッセージストリングを持つリクエストボディオブジェクト。
属性
ライブサーバーに公開したいメッセージコンテンツ。