次の方法で共有

GET (/users/me/groups/{moniker} )

  • [アーティクル]

自分のグループの PresenceRecord を取得します。 これらの URI のドメインは userpresence.xboxlive.com です。

解説

クレーム内のユーザーに関連するモニカーによって指定されたグループ内のユーザーを取得し、それらのユーザーの PresenceRecord を返します。 プライバシーまたはコンテンツ分離によって制限されるデータは返されません。

URI パラメーター

パラメーター 型 説明
moniker 文字列 ユーザーのグループを定義する文字列。 現時点で受け入れられるモニカーは、「People」 (大文字の「P」) だけです。

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

パラメーター 型 説明
level 文字列 このクエリ文字列によって指定されている詳細のレベルを返します。 有効なオプションは、"user"、"device"、"title"、および "all" です。レベル "user" は、入れ子になった DeviceRecord オブジェクトを含まない PresenceRecord オブジェクトです。 レベル "device" は、入れ子になった TitleRecord オブジェクトを含まない PresenceRecord および DeviceRecord オブジェクトです。 レベル "title" は、入れ子になった ActivityRecord オブジェクトを含まない PresenceRecord、DeviceRecord、および TitleRecord オブジェクトです。 レベル "all" は、入れ子になったすべてのオブジェクトを含む、レコード全体です。このパラメーターが指定されていない場合、サービスの既定値は title レベルです (つまり、このユーザーのプレゼンスをタイトルの詳細まで返します)。

Authorization

使用される承認クレーム クレーム 種類 必須かどうか 値の例
Xuid 64 ビット符号付き整数 ○ 1234567890

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

要求自体の形式が正しい場合、サービスは常に 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 文字列 サーバーのドメイン名。 値の例: userpresence.xboxlive.com。

省略可能な要求ヘッダー

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

リクエストの本文

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

HTTP ステータス コード

サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。

コード 理由 説明
200 OK セッションは正常に取得されました。
400 Bad Request サービスは無効な形式の要求を解釈できませんでした。 通常は、無効なパラメーターです。
401 未承認 要求にはユーザー認証が必要です。
403 Forbidden ユーザーまたはサービスに対して要求が許可されていません。
404 Not Found 指定されたリソースが見つかりませんでした。
405 メソッドが許可されていません。 HTTP メソッドが、サポートされていないコンテンツ タイプで使用されました。
406 Not Acceptable リソースのバージョンがサポートされていません。
500 Request Timeout サービスは無効な形式の要求を解釈できませんでした。 通常は、無効なパラメーターです。
503 Request Timeout サービスは無効な形式の要求を解釈できませんでした。 通常は、無効なパラメーターです。

必須の応答ヘッダー

ヘッダー 型 説明
x-xbl-contract-version 文字列 この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。 値の例: 1, vnext。
Content-Type 文字列 要求の本文の MIME タイプ。 値の例: application/json。
Cache-Control 文字列 キャッシュ動作を指定する正式な要求。 値の例: "no-cache"。
X-XblCorrelationId 文字列 サーバーが返す内容およびクライアントが受信する内容を関連付けるためのサーバーが生成する値。 値の例: "4106d0bc-1cb3-47bd-83fd-57d041c6febe"。
X-Content-Type-Option 文字列 SDL 準拠の値を返します。 値の例: "nosniff"。
日付 文字列 メッセージが送信された日付/時刻。 値の例: "Tue, 17 Nov 2012 10:33:31 GMT"。

省略可能な応答ヘッダー

ヘッダー 型 説明
Retry-After 文字列 503 HTTP エラーで返されます。 呼び出しの再試行までどのぐらい待つかをクライアントに知らせます。 値の例: "120"。
Content-Length 文字列 応答本文の長さ。 値の例: "527"。
Content-Encoding 文字列 応答のエンコード タイプ。 値の例: "gzip"。

応答の本文

この API は、PresenceRecord オブジェクト (要求内の XUID ごとに 1 つ) の配列を返します。

サンプル応答

[
     {
         xuid:"0123456789",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341234",
                         name:"Contoso 5",
                         lastModified:"2012-09-17T07:15:23.4930000",
                         placement:"full",
                         state:"active",
                         activity:
                         {
                             richPresence:"Playing on Nirvana"
                         },
                     }
                 ]
             }
         ]
     },
     {
         xuid:"0123456780",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341235",
                         name:"Contoso Waypoint",
                         lastModified:"2012-09-17T07:15:23.4930000",
                         placement;"full",
                         state:"active",
                         activity:
                         {
                             richPresence:"Viewing stats"
                         },
                     }
                 ]
             }
         ]
     },
     {
         xuid:"0123456781",
         state:"online",
         devices:
         [
             {
                 type:"Win8",
                 titles:
                 [
                     {
                         id:"23452345",
                         name:"Contoso Gamehelp",
                         state:"active",
                         timestamp:"2012-09-17T07:15:23.4930000",
                         activity:
                         {
                             richPresence:"Viewing help"
                         }
                     }
                 ]
             }
         ]
     }
 ]

関連項目

親

/users/me/groups/{moniker}