REST を介したユーザーのプレゼンスの更新

このトピックでは、リッチプレゼンス文字列を更新するためのサンプルコードを提供します。タイトル内でリッチプレゼンス文字列を更新するには、JSON オブジェクトに適切なパラメーターを指定して Write Title URI を呼び出します。この RESTful 呼び出しは、XBOX Service API (XSAPI) によってもラップされています。この呼び出しに関連する API については、XblPresenceSetPresenceAsync を参照してください。 URI は以下のようになります。

POST /users/xuid({xuid})/devices/current/titles/current

以下のフィールドはリッチプレゼンス文字列の設定専用です。その他のオプションフィールドはタイトルのプレゼンスの書き込みに関連していますが、このトピックでは一覧化されていません。

TitleRequest オブジェクト

プロパティ	型	必須	説明
Activity	ActivityRequest	いいえ	タイトル内情報 (リッチプレゼンスおよび利用可能な場合はメディア情報) を記述するレコード

ActivityRequest オブジェクト

プロパティ	型	必須	説明
richPresence	RichPresenceRequest	いいえ	使用するリッチプレゼンス文字列のフレンドリ名

RichPresenceRequest オブジェクト

プロパティ	型	必須	説明
Id	String	はい	使用するリッチプレゼンス文字列のフレンドリ名
Scid	String	はい	リッチプレゼンス文字列が定義されている場所を示す scid

たとえば、xuid が 12345 のユーザーのリッチプレゼンスを更新する呼び出しは以下のようになります。

POST /users/xuid(12345)/devices/current/titles/current

以下の JSON ボディを持ちます。

          {
            activity:
            {
              richPresence:
              {
                id:"playingMap",
                scid:"0000-0000-0000-0000-01010101"
              }
            }
          }

ラッパー API を使用する場合、これは XblPresenceSetPresenceAsync への呼び出しになります。 XBOX Player Data を最新の状態に保っている場合、データが変わるたびに空欄を埋めるためにリッチプレゼンス文字列をリセットする必要はありません。前の例では、現在のマップが使用されています。プレゼンスは、ユーザーが文字列を読み取って現在の値を埋めようとしたときに、XBOX Player Data からデータを検索します。ユーザーがマップを切り替えても、XBOX Player Data に適切なイベントを送信している限り、ゲーム内でリッチプレゼンス文字列をリセットする必要はありません。 XBOX Player Data システム内でデータが移行するまで数秒かかることがあります。誰かがユーザー 12345 のリッチプレゼンスを読み取ろうとすると、サービスは要求されているロケールを確認し、返す前に文字列を適切に整形します。この場合、ユーザーが en-US 文字列を読み取ろうとしていると仮定します。リッチプレゼンスの読み取りは以下のように機能します。

GET /users/xuid(12345)?level=all

この呼び出しの詳細については、GET (/users/xuid({xuid})) を参照してください。これのラッパー API は、XblPresenceGetPresenceAsync または XblPresenceGetPresenceForMultipleUsersAsync のいずれかです。前の例では、xuid が 12345 のユーザーの PresenceRecord を要求しました。詳細レベルは all を要求しました。 all を指定しないと、リッチプレゼンスは返されません。代わりに、all は以下を JSON レスポンスで返します。

          {
            xuid:"12345",
            state:"online",
            devices:
            [
              {
                type:"D",
                titles:
                [
                  {
                    id:"12345",
                    name:"Buckets are Awesome",
                    lastModified:"2022-08-17T07:15:23.4930000",
                    placement: "full",
                    state:"active",
                    activity:
                    {
                      richPresence:"Playing on map:Mountains"
                    }
                  }
                ]
              }
            ]
          }

XBOX Services

PlayFab

TitleRequest オブジェクト

ActivityRequest オブジェクト

RichPresenceRequest オブジェクト

​TitleRequest オブジェクト

​ActivityRequest オブジェクト

​RichPresenceRequest オブジェクト

TitleRequest オブジェクト

ActivityRequest オブジェクト

RichPresenceRequest オブジェクト