EDS パラメーター
クエリ文字列パラメーター
これらのクエリ パラメーターはすべての Entertainment Discovery Services (EDS) API に指定できるわけではありませんが、いずれも複数の API に指定できます。
| パラメーター | 型 | 説明 |
|---|---|---|
| combinedContentRating | 文字列 | オプション。 「GET (/media/{marketplaceId}/contentRating)」を参照してください。 |
| continuationToken | 文字列 | オプション。 継続トークンは、特定の状況でのページ処理のためにサービスが必要とする情報を含む非透過的な BLOB です。 値を省略した場合、結果の 1 ページ目 (ページ サイズは maxItems パラメーターによって決定される) と、結果の 2 ページ目を取得するために使用できる継続トークンが返されます。 2 ページ目には結果の 3 ページ目への継続トークンが含まれ、以下同様です。 |
| Desired | 文字列 | オプション。 「Combined Field Name API」を参照してください。 |
| desiredMediaItemTypes | 文字列の配列 | オプション。 このパラメーターは、応答で返される項目のタイプを決定します。 |
| ドメイン | 文字列 | オプション。 Domain パラメーターは、クライアントが要求しているゲームおよびアプリケーションのマーケットプレースのコンテキストを決定します。 既定のドメインは、クライアントが Xbox One (またはそれ以降の) コンテンツのみを要求できることを示す "Modern" です。 Xbox 360 コンテンツを表示するようにドメインを切り替えたい場合、クライアントは Domain に "Xbox360" を指定する必要があります。 現時点では、ドメインを越えた結果はサポートされていません。 指定可能な値は、以下のとおりです。
|
| fields | 文字列 | オプション。 「GET (/media/{marketplaceId}/fields)」を参照してください。 |
| firstPartyOnly | ブール値 | オプションのフィルター パラメーター。 クエリからファーストパーティー コンテンツのみが返されるか、ファーストパーティー コンテンツとサードパーティー コンテンツの両方が返されるかを決定します。 |
| freeOnly | ブール値 | オプションのフィルター パラメーター。 結果を無料コンテンツのみに制限します。 |
| GroupBy | TK | groupBy パラメーターは、1 つの結果セットではなく結果セットをグループに分類するために使用されます。 このパラメーターを指定すると、項目の複数リストを返すように結果セットが変更され、各バケットの項目数は maxItems パラメーターによって決定されます。
|
| hasTrailer | ブール値 | オプションのフィルター パラメーター。 返される項目にトレーラーが含まれている必要があるか、トレーラーはオプションかを決定します。 値が true の場合、すべての項目にトレーラーが必要です。 |
| id | 文字列 | オプション。 指定した場合、与えられた ID を持つ項目の子のみに結果を制限します。 このパラメーターを指定する場合、MediaItemType も指定する必要があります。 |
| ids | 文字列の配列 | 必須。 詳細を取得する対象のすべての ID (10 個まで)。 URL に使用できない文字が ID に含まれている場合、その ID を EDS に正しく送信するには ID を URL エンコードする必要があることに注意してください (通常、ProviderContentId 型の ID はそれ自体が完全 URL であるため、無効な文字が含まれています)。 |
| idType | 文字列 | オプション。 ids パラメーターに渡される ID タイプ。 有効な値は次のとおりです。
|
| latestOnly | ブール値 | オプションのフィルター パラメーター。 リリース日が最も新しい項目のみに結果を制限します。 |
| maxItems | 32 ビット符号付き整数 | オプション。 呼び出しで返される項目の最大数を決定します。 有効な値は 1 以上 25 以下の数値です。 省略した場合、パラメーターは既定値の 25 になります。 |
| mediaGroup | 文字列 | オプション。 ID のメディア グループ。 指定するすべての ID が同じメディア グループを共有する必要があります。 |
| MediaItemType | 文字列 | オプション。 id パラメーターで ID が指定された項目のタイプ。 id パラメーターを指定する場合、このパラメーターも指定する必要があります。 |
| orderBy | 文字列 | 必須。 orderBy パラメーターは、返される項目のソート方法を決定します。 このフィールドの一般的な値は以下のとおりですが、一部の API ではその他の値がサポートされている場合があります。
|
| preferredProvider | 文字列 | オプション。 Comcast Xfinity や Verizon FIOS など、ユーザーが優先するコンテンツ プロバイダーがある場合は、そのプロバイダーの ID を渡すことができます。 項目の実際の順序は変わりませんが、項目ごとに、指定されたプロバイダーの情報がプロバイダーのリストの最上部に表示されます (優先するコンテンツ プロバイダーに利用可能な項目がある場合)。 |
| q | 文字列 | 必須。 検索で使用するクエリ用語。 |
| queryRefiners | 文字列の配列 | オプション。 「EDS クエリの絞り込み条件」の一覧を参照してください。 |
| relationship | 文字列 | オプション。 指定された関係の種類に一致する他のプロダクトを検索するときにベースとして ID パラメーターを使用するフィルター:
|
| ScopeId | 文字列 | このパラメーターは、ビデオ メディアの逆引き参照のシナリオで使用されます。 |
| ScopeIdType | 文字列 | このパラメーターは、ビデオ メディアの逆引き参照のシナリオで使用されます。 指定可能な値は、Title です。 |
| skipItems | 32 ビット符号付き整数 | オプション。 skipItems パラメーターは、グループを横断しない場合のページ処理で、何個の項目が表示済みか (どの項目を結果セットの先頭に表示するか) を決定するために使用します。 値は 0 から始まるので、skipItems=0 を指定した (または skipItems を指定しない) 場合、リストの先頭から取得を開始します。 skipItems=3 を指定した場合、リストの先頭から 3 つの項目を飛ばして 4 番目の項目から取得を開始します。 |
| subscriptionLevel | 文字列の配列 | オプションのフィルター パラメーター。 subscriptionLevel パラメーターは、ユーザーが持っているメンバーシップの種類 (ユーザーが有料または無料のどちらのメンバーシップを持っているか、など) を決定します。 有効値は次に示すとおりです。
|
| TargetDevices | 文字列 | EDS は、ターゲット デバイス用にオファーを絞り込める柔軟性を提供しています。 項目に対して返されるオファー (ProviderContent または Availability) をターゲット デバイスに制限することができます。 |
| topRatedOnly | ブール値 | オプションのフィルター パラメーター。 最も評価の高いコンテンツのみに結果を制限します。 |