> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # GET (/users/xuid(xuid)/lists/PINS/{listname}) > GET (/users/xuid(xuid)/lists/PINS/{listname}) # GET (/users/xuid(xuid)/lists/PINS/{listname}) リストの内容を返します。 これらの URI のドメインは `eplists.xboxlive.com` です。 * [備考](#ID4EV) * [URI パラメーター](#ID4EIB) * [クエリ文字列パラメーター](#ID4ETB) * [認可](#ID4ESD) * [必須リクエスト ヘッダー](#ID4E6D) * [リクエスト本文](#ID4EVF) * [HTTP ステータス コード](#ID4EAG) * [レスポンス本文](#ID4E5CAC) ## 備考 返されるデータの **listCount** フィールドは、サービスによって管理されているリスト全体のアイテム数を示します。したがって、リストの終端がどこかを判定するために使用でき、これはリクエストで返された具体的なアイテムの数とは異なる可能性があります。 リストがまだ存在しない場合、結果にはリスト アイテムは含まれず、**listCount** は 0、**listVersion** も 0 になります。 ## URI パラメーター | パラメーター | 型 | 説明 | | - | - | - | | xuid | string | XBOX User ID (XUID)。 | | listtype | string | リストの種類 (使用方法および動作方法)。これらの関連メソッドでは常に "PINS"。 | | listname | string | リストの名前 (指定した listtype 内のどのリストを操作するか)。Pins 内のアイテムでは常に "XBLPins"。 | ## クエリ文字列パラメーター \| パラメーター| 型| 説明| \| --- | --- | --- | --- | --- | --- | \| skipItems| 32 ビット符号付き整数| 任意。結果を返す前に列挙でスキップするアイテムの数。既定値: 0。| \| maxItems| 32 ビット符号付き整数| 任意。返すアイテムの最大数。リクエストで最大数が指定されない場合の既定は 25 アイテムです。サービスはこの値の上限を設けていません。値がリスト内のアイテム数を超える場合、エラーなしですべてのアイテムが返されます。| \| filterItemId| string| 任意。リスト内で検索するアイテムを指定します。リスト内のそのアイテムのすべての出現箇所を返します。クライアントはアイテムがリスト内に存在するかとその場所を素早く判定できます。大きなリストで、リスト全体を反復せずに、あるアイテムのすべての出現箇所を特定するのに便利です。既定値: null。| \| filterContentType| string| 任意。返すコンテンツ タイプのカンマ区切りリストを指定します (リストにない型は返しません)。リストから特定のコンテンツ タイプのみを取得するために使用します。このフィルターにはコンテンツ タイプのカンマ区切りリストが使用されます (1 回の呼び出しで複数のコンテンツ タイプを問い合わせできます)。サポートされるコンテンツ タイプには Entertainment Discovery Services (EDS) で定義されるすべてのメディア タイプが含まれます。既定値: null (すべてのコンテンツ タイプ)。| \| filterDeviceType| string| 任意。返すデバイス タイプのカンマ区切りリストを指定します (リストにない型は返しません)。特定のデバイス タイプのセットから挿入されたアイテムのみを返すよう、返却セットをフィルタリングします。このフィルターにはデバイス タイプのカンマ区切りリストが使用されます (1 回の呼び出しで複数のデバイス タイプを問い合わせできます)。取り得る値: XboxOne、MCapensis、WindowsPhone、WindowsPhone7、Web、PC、MoLive。既定値: null (すべてのコンテンツ タイプ)。| ## 認可 この呼び出しでは、**Authorization** ヘッダーに XSTS SAML トークンが必要です。呼び出し元を識別するために、SAML トークン内に Xuid クレームが存在する必要があります。この値は、呼び出し元が該当するリスト データへのアクセス権を持っているかどうかを判定するために使用されます。リスト自体も Xuid によって識別され、リストの URI に含まれます。これを使用することで、将来的にはリストの共有アクセスをサポートする可能性がありますが、現時点ではこの機能はサポートされていません。現在、ユーザーがアクセスするリストはすべてそのユーザー自身のものであり、共有アクセスはありません。したがって、URI 内の Xuid は SAML クレーム トークン内の Xuid と一致する必要があります。 > **注:**\ > 現時点では XBL Auth 2.0 と 3.0 の両方のトークンがサポートされています。 ## 必須リクエスト ヘッダー \| ヘッダー| 説明| \| --- | --- | --- | --- | --- | --- | --- | --- | --- | \| Authorization| リクエストの認証および認可に使用される STS トークンを含みます。XSTS サービスからのトークンで、XUID がクレームの 1 つとして含まれている必要があります。 | \| X-XBL-Contract-Version| どの API バージョンを要求しているかを指定します (正の整数)。Pins はバージョン 2 をサポートします。このヘッダーが欠落しているか、値がサポートされていない場合、サービスはステータス説明に "Unsupported or missing contract version header" を含む 400 - Bad request を返します。| \| Content-Type| リクエスト/レスポンス本文の内容が json か xml かを指定します。サポートされる値は "application/json" と "application/xml" です。| \| If-Match| 変更リクエストを行う際に、このヘッダーにはリストの現在のバージョン番号を含める必要があります。変更リクエストは PUT、POST、DELETE 動詞を使用します。"If-Match" ヘッダーのバージョンが現在のリスト バージョンと一致しない場合、リクエストは HTTP 412 - precondition failed のリターン コードで拒否されます。(任意) GET でも使用でき、指定されたバージョンが現在のリスト バージョンと一致する場合、リスト データはなく HTTP 304 - Not Modified コードが返されます。 | ## リクエスト本文 このリクエストの本文にはオブジェクトは送信されません。 ## HTTP ステータス コード サービスは、このリソースに対するこのメソッドでのリクエストに応じて、このセクション内のいずれかのステータス コードを返します。XBOX Live Services で使用される標準的な HTTP ステータス コードの完全な一覧については、[標準 HTTP ステータス コード](https://devdocs.xbox.com/ja-jp/reference/live/rest/additional/httpstatuscodes) を参照してください。 \| コード| 理由フレーズ| 説明| \| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | \| 200| OK| リクエストは正常に完了しました。レスポンス本文には、要求されたリソース (GET の場合) が含まれます。POST および PUT リクエストは最新のリスト メタデータ (リスト バージョン、件数など) を受け取ります。| \| 201| Created| 新しいリストが作成されました。これはリストへの初回挿入時に返されます。レスポンスにはリストの最新のメタデータが含まれ、location ヘッダーにはリストの URI が含まれます。| \| 304| Not Modified| GET で返されます。クライアントが最新バージョンのリストを持っていることを示します。サービスは **If-Match** ヘッダーの値をリスト バージョンと比較します。それらが等しい場合、データなしで 304 が返されます。| \| 400| Bad Request| リクエストの形式が不正でした。URI やクエリ文字列パラメーターの値または型が無効な可能性があります。また、必須のパラメーターやデータ値が欠落している場合、リクエストで API のバージョンが欠落または無効な場合にも発生することがあります。**X-XBL-Contract-Version** ヘッダーを参照してください。| \| 401| Unauthorized| リクエストにはユーザー認証が必要です。| \| 403| Forbidden| このユーザーまたはサービスにはリクエストが許可されていません。| \| 404| Not Found| 呼び出し元にはリソースへのアクセス権がありません。これはそのようなリストが作成されていないことを示します。| \| 412| Precondition Failed| リストのバージョンが変更され、変更リクエストが失敗したことを示します。変更リクエストは挿入、更新、または削除のいずれかです。サービスは **If-Match** ヘッダーのリスト バージョンをチェックします。現在のリスト バージョンと一致しない場合、操作は失敗し、現在のリスト メタデータ (現在のバージョンを含む) とともにこの応答が返されます。| \| 500| Internal Server Error| サービスはサーバー側のエラーによりリクエストを拒否しています。| \| 501| Not Implemented| 呼び出し元は、サーバー上に実装されていない URI を要求しました (現時点では、許可リストに登録されていないリスト名に対するリクエストにのみ使用されます)。| \| 503| Service Unavailable| サーバーはリクエストを拒否しています。通常は過大な負荷が原因です。遅延の後 (**Retry-after** ヘッダーを参照)、リクエストを再試行できます。| ## レスポンス本文 ### サンプル レスポンス ```cpp theme={null} { "ListMetadata": {"ListVersion": 12, "ListCount": 6, "MaxListSize": 200, "AccessSetting": "OwnerOnly", "AllowDuplicates": true }, "ListItems": [{ "Index": 0, "DateAdded": "\/Date(1198908717056)/", "DateModified": "\/Date(1198908717056)/", "HydrationResult": "Indeterminate", "HydratedItem": null "Item": { "ContentType": "Movie", "ItemId": "3a5095a5-eac3-4215-944d-27bc051faa47", "ProviderId": null, "Provider": null, "ImageUrl": "http://www.bing.com/thumb/get?bid=Gw%2fsjCGSS4kAAQ584x800&bn=SANGAM&fbid=7wIR63+Clmj+0A&fbn=CC", "Title": "The Dark Knight", "SubTitle": null, "Locale": "en-us", "AltImageUrl": null, "DeviceType": "XboxOne" } }] } ``` ## 関連項目 ##### 親 [/users/xuid(xuid)/lists/PINS/{listname}](https://devdocs.xbox.com/ja-jp/reference/live/rest/uri/lists/uri-usersxuidlistspinslistname) ##### 詳細情報 [Marketplace URIs](https://devdocs.xbox.com/ja-jp/reference/live/rest/uri/marketplace/atoc-reference-marketplace) [追加のリファレンス](https://devdocs.xbox.com/ja-jp/reference/live/rest/additional/atoc-xboxlivews-reference-additional) ## Related topics - [XblUserStatisticsGetSingleUserStatisticAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md) - [XblUserStatisticsGetSingleUserStatisticsAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)