GET (/users/xuid({xuid}))

[アーティクル]
05/09/2023

別のユーザーまたはクライアントのプレゼンスを検出します。これらの URI のドメインは userpresence.xboxlive.com です。

解説
URI パラメーター
クエリ文字列パラメーター
Authorization
プライバシー設定がリソースに与える影響
必須の要求ヘッダー
省略可能な要求ヘッダー
リクエストの本文
応答の本文

解説

使用者がオブジェクト全体に関心を持っていない場合、応答をフィルター処理して PresenceRecord の一部を提供できます。

注:
返されるデータは、プライバシールールおよびコンテンツ分離ルールによって制限されます。

URI パラメーター

パラメーター	型	説明
xuid	64 ビット符号なし整数	ターゲットユーザーの Xbox ユーザー ID (XUID)。

クエリ文字列パラメーター

パラメーター	型	説明
level	文字列	オプション。 user: ユーザーノードのみを返します。 device: ユーザーノードおよびデバイスノードを返します。 title: 既定。アクティビティ以外のツリー全体を返します。 all: アクティビティレベルのプレゼンスを含む、ツリー全体を返します。

Authorization

種類	必須かどうか	説明	存在しない場合の応答
XUID	○	呼び出し元の Xbox ユーザー ID (XUID)	403 Forbidden

プライバシー設定がリソースに与える影響

このメソッドは常に 200 OK を返しますが、応答本文でコンテンツを返さないことがあります。

要求元のユーザー	ターゲットユーザーのプライバシー設定	動作
自分	-	200 OK
フレンド	すべての人	200 OK
フレンド	フレンドのみ	200 OK
フレンド	制限	200 OK
フレンドではないユーザー	すべての人	200 OK
フレンドではないユーザー	フレンドのみ	200 OK
フレンドではないユーザー	制限	200 OK
サードパーティーのサイト	すべての人	200 OK
サードパーティーのサイト	フレンドのみ	200 OK
サードパーティーのサイト	制限	200 OK

必須の要求ヘッダー

ヘッダー	型	説明
Authorization	文字列	HTTP 認証用の認証資格情報。例の値: "XBL3.0 x=<userhash>;<token>"。
x-xbl-contract-version	文字列	この要求の送信先である Xbox LIVE サービスのビルド名/番号。要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。値の例: 3, vnext。
Accept	文字列	受け入れ可能な Content-Type。プレゼンスでサポートされるのは application/json のみですが、ヘッダー内で指定する必要があります。
Accept-Language	文字列	応答で受け入れ可能な文字列のロケール。値の例: en-US。
Host	文字列	サーバーのドメイン名。値の例: presencebeta.xboxlive.com。

省略可能な要求ヘッダー

ヘッダー	型	説明
X-RequestedServiceVersion		この要求の送信先である Xbox LIVE サービスのビルド名/番号。要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。既定値: 1。

リクエストの本文

この要求の本体で送信されるオブジェクトはありません。

応答の本文

サンプル応答

ユーザーに既存のレコードがない場合、デバイスのないレコードが返されます。

{
  xuid:"0123456789",
  state:"online",
  devices:
  [{
    type:"D",
    titles:
    [{
      id:"12341234",
      name:"Contoso 5",
      state:"active",
      placement:"fill",
      timestamp:"2012-09-17T07:15:23.4930000",
      activity:
      {
        richPresence:"Team Deathmatch on Nirvana"
      }
    },
    {
      id:"12341235",
      name:"Contoso Waypoint",
      timestamp:"2012-09-17T07:15:23.4930000",
      placement:"snapped",
      state:"active",
      activity:
      {
        richPresence:"Using radar"
      }
    }]
  },
  {
    type:W8,
    titles:
    [{
      id:"23452345",
      name:"Contoso Gamehelp",
      state:"active",
      placement:"full",
      timestamp:"2012-09-17T07:15:23.4930000",
      activity:
      {
        richPresence:"Nirvana page",
      }
    }]
  }]
}

次の方法で共有