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