POST (/users/batch)

ユーザーのバッチのプレゼンスを取得します。 これらの URI のドメインは userpresence.xboxlive.com です。

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

解説

ユーザーのバッチのプレゼンス情報を必要とするすべてのクライアント、サービス、タイトルは、このメソッドを使用する必要があります。

このバッチ要求の応答は、深さとパスでフィルターできます。 使用側はこれによりユーザーのセットに関するプレゼンスを検索して表示できます。 この API のフィルターは、プロパティ内では OR になりますが、プロパティ間では AND になります。

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。
Content-Length	文字列	要求本文の長さ。 値の例: 312。

省略可能な要求ヘッダー

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

リクエストの本文

必須メンバー

メンバー	説明
users	プレゼンスを確認したいユーザーの XUID を列挙します (一度に最大 1100 の XUID)。

省略可能なメンバー

メンバー	説明
deviceTypes	確認したいユーザーが使用するデバイスの種類の一覧。 配列を空のままにすると、既定ではすべての使用可能なデバイスの種類に設定されます (つまり、どれもフィルターによって除外されません)。
titles	ユーザーを確認したいデバイスの種類の一覧。 配列を空のままにすると、既定ではすべての使用可能なタイトルに設定されます (つまり、どれもフィルターによって除外されません)。
level	使用可能な値は次のとおりです。 user - ユーザー ノードを取得します device - ユーザーおよびデバイス ノードを取得します title - 基本的なタイトル レベルの情報を取得します all - リッチ プレゼンス情報、メディア情報、またはその両方を取得します 既定値は "title" です。
onlineOnly	このプロパティが true の場合は、バッチ操作でオフライン ユーザー (クロークされたユーザーを含む) のレコードがフィルターによって除外されます。 指定されていない場合は、オンラインとオフラインの両方のユーザーが返されます。

禁止されたメンバー

その他のすべてのメンバーは要求では使用できません。

サンプル要求

{
  users:
  [
    "1234567890",
    "4567890123",
    "7890123456"
  ]
}

応答の本文

サンプル応答

このメソッドは PresenceRecord を返します。

{
  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",
      }
    }]
  }]
}

関連項目

親

/users/batch