EDS 參數
查詢字串參數
並非所有 Entertainment Discovery Services (EDS) API 都一定會接受這些查詢參數，但每個參數都至少會被一個以上的 API 接受。| 參數 | 類型 | 描述 |
|---|---|---|
| combinedContentRating | string | 選擇性。請參閱 GET (/media//contentRating)。 |
| continuationToken | string | 選擇性。接續權杖是不透明的 Blob，包含服務在特定情況下進行分頁所需的資訊。如果省略此值，則會傳回第一頁結果 (頁面大小由 maxItems 參數決定)，以及可用來取得第二頁結果的接續權杖。第二頁會包含第三頁結果的接續權杖，依此類推。 |
| Desired | string | 選擇性。請參閱合併欄位名稱 API。 |
| desiredMediaItemTypes | 字串陣列 | 選擇性。此參數決定回應中要傳回的項目類型。 |
| 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 | 選擇性。如果提供，會將結果限制為僅限具有指定識別碼之項目的子項。如果提供此參數，也必須指定 MediaItemType。 |
| ids | 字串陣列 | 必要。要傳回詳細資料的所有識別碼 (最多 10 個)。請注意，任何包含不可放入 URL 之字元的識別碼 (ProviderContentId 類型的識別碼本身通常是完整的 URL，因此包含不合法的字元)，都必須經過 URL 編碼，才能正確傳送至 EDS。 |
| idType | string | 選擇性。傳入 ids 參數之識別碼的類型。有效值包括：
|
| latestOnly | 布林值 | 選擇性篩選參數。將結果限制為僅限具有最新發行日期的項目。 |
| maxItems | 32 位元帶正負號整數 | 選擇性。決定呼叫應傳回的項目數上限。有效值為介於 1 到 25 (含) 之間的數字。如果省略，參數預設為 25。 |
| mediaGroup | string | 選擇性。識別碼的媒體群組。所有提供的識別碼都必須具有相同的媒體群組。 |
| MediaItemType | string | 選擇性。在 id 參數中指定其識別碼之項目的類型。如果提供 id 參數，也必須指定此參數。 |
| orderBy | string | 必要。orderBy 參數決定傳回的項目應如何排序。此處列出此欄位的常見值，但某些 API 可能支援其他值。
|
| preferredProvider | string | 選擇性。如果使用者有偏好的內容提供者，例如 Comcast Xfinity 或 Verizon FIOS，則可以傳入該提供者的識別碼。雖然項目的實際順序不會變更，但對於每個項目，指定提供者的資訊會顯示在提供者清單的頂端 (如果偏好的內容提供者有提供該項目)。 |
| q | string | 必要。搜尋中使用的查詢字詞。 |
| queryRefiners | 字串陣列 | 選擇性。請參閱 EDS 查詢精簡器清單。 |
| relationship | string | 選擇性。使用識別碼參數作為基礎，搜尋符合指定關聯性類型之其他產品的篩選條件：
|
| ScopeId | string | 此參數用於影片媒體的反向查閱情節。 |
| ScopeIdType | string | 此參數用於影片媒體的反向查閱情節。可能的值：Title。 |
| skipItems | 32 位元帶正負號整數 | 選擇性。在非跨群組情節中進行分頁時，skipItems 參數用來決定已經看過多少個項目 (以及結果集中應先顯示哪個項目)。此值以 0 為起始，因此 skipItems=0 (或乾脆不提供 skipItems) 會從清單開頭開始擷取。skipItems=3 會略過清單中的前三個項目，並從第四個項目開始擷取。 |
| subscriptionLevel | 字串陣列 | 選擇性篩選參數。subscriptionLevel 參數決定使用者擁有的訂閱類型 (例如使用者擁有付費訂閱或免費訂閱)。可能的值如下。
|
| TargetDevices | string | EDS 提供針對目標裝置篩選優惠的彈性。項目傳回的優惠 (ProviderContent 或 Availability) 可以限制為特定目標裝置。 |
| topRatedOnly | 布林值 | 選擇性篩選參數。將結果限制為僅限評分最高的內容。 |