> ## 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.

# 輔助 EDS API

> 輔助 EDS API

# 輔助 EDS API

有數個 Entertainment Discovery Services (EDS) API 不會直接提供內容的相關資訊，而是提供如何使用服務的一般資訊，或協助驅動常見的 UI 模型。

<a id="ID4EQ" />

## 輔助 API

| API | URI | 描述 |
| - | - | - |
| API 參數值 | /{locale}/metadata | 列舉可在服務呼叫中使用之參數的可能值 |
| 合併內容分級產生器 | /{locale}/contentRating | 建立可在其他 API 中用來篩選掉可能令人反感或露骨內容的值。如需詳細資訊，請參閱下文。 |
| 合併欄位名稱產生器 | /{locale}/fields | 建立可在詳細資料 API 中用來控制要傳回哪些欄位的值。如需詳細資訊，請參閱下文。 |

<a id="ID4EBC" />

### API 參數值

此 API 說明可與服務搭配使用的參數。由於每個參數都附有當地語系化文字，因此用戶端 UI 可使用傳回的資訊。

下列 API 都不接受任何查詢參數。

\| API| URI| 描述|
\| --- | --- | --- | --- | --- | --- |
\| 類型| /{locale}/metadata/mediaGroups| 媒體群組的完整清單|
\| 每個媒體群組的媒體項目類型| /{locale}/metadata/mediaGroups/{mediaItemTypeGroup}/mediaItemTypes| 指定媒體群組中包含的媒體項目類型清單。|
\| 所有媒體項目類型| /{locale}/metadata/mediaItemTypes| 媒體項目類型的完整清單|
\| 每個媒體項目類型的欄位| /{locale}/metadata/mediaItemTypes/{mediaItemType}/fields| 單一媒體項目類型中的欄位清單|
\| 查詢精簡器| /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners| 指定媒體項目類型所支援的查詢精簡器清單|
\| 所有查詢精簡器值| /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners/{queryRefiner}| 指定媒體項目類型之指定查詢精簡器的值|
\| 所有查詢精簡器子值| /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners/{queryRefiner}/subQueryRefinerValues| 指定查詢精簡器值的子值清單 (例如「指定類型中的子類型」)。查詢精簡器值會以名為 "queryRefinerValue" 的查詢字串參數傳入，這樣做是為了允許傳遞包含 URI 主幹中禁止之字元的查詢精簡器值。|
\| 排序| /{locale}/metadata/mediaItemTypes/{mediaItemType}/sortOrders| 指定媒體項目類型的排序順序清單|

<a id="ID4EEF" />

### 合併內容分級產生器

強制執行家長監護控制，以管理允許兒童觀看的內容，是一項複雜的工作。不僅每個媒體項目類型都有自己的分級系統，而且這些分級系統可能因國家/地區而異。這表示需要指定數種不同的資料，才能正確篩選所有項目。

此 API 不需要在所有 API 呼叫中指定所有參數，而是會產生一個值，傳入其他 API 中的 combinedContentRating 參數，並仍然傳達相同的資訊。這是為了讓 API 更容易使用和維護而設計，因為傳入此 API 的數個參數會摺疊成單一、可重複使用的值，供其他 API 使用。

雖然此 API 傳回的確切值最終可能會變更，但變更的頻率應該非常低 (例如在 EDS 版本之間)，因此可以長時間快取。任何接受 combinedContentRating 參數的 API，如果傳入的值無效，都會提供有意義的錯誤訊息，這表示呼叫者只需要再次呼叫此 API 即可取得更新的值。如果 API 接受 combinedContentRating 參數，但未提供該參數，則不會根據家長監護控制進行任何內容篩選

> **注意：**\
> 這並不表示只會傳回「安全」的內容--而是表示會傳回所有內容，包括可能露骨的內容)。

<a id="ID4EWF" />

### 合併欄位名稱

根據預設，EDS API 會針對每個項目傳回非常少的最小欄位集合：

* 媒體項目類型
* 媒體群組
* 識別碼
* 名稱

若要取得更多資訊，API 接受 "fields" 參數，以指定應傳回哪些額外資料。由於可能的欄位很多，在每次 API 呼叫中指定其完整名稱會大幅增加要求的大小。因此，可以將名稱傳入此 API，此 API 會產生一個小得多的值，可傳入其他 API。

對於任何接受此參數的 API，提供的值必須是所有指定媒體項目類型中所有欄位的超集。無法針對不同的媒體項目類型指定不同的欄位集合。不過，如果某個欄位適用於某個媒體項目類型但不適用於另一個，則只會出現在有資料存在的媒體項目類型中 (例如，如果在合併欄位名稱 API 的呼叫中包含 "AvatarBodyType"，則只有 AvatarItems 會包含該欄位)。

此 API 傳回的值非常適合快取--事實上，除了在 EDS 部署之間，這些值應該不會變更。如果需要快取，建議快取的持續時間不要超過使用者的工作階段。

除了接受實際的欄位名稱之外，此 API 也接受 "all" 作為有效值。這會產生一個包含所有可指定欄位的值。"all" 值可能只會用於開發、偵錯和測試用途。

<a id="ID4ERG" />

## 另請參閱

<a id="ID4ETG" />

##### 上層

[其他參考](/zh-TW/reference/live/rest/additional/atoc-xboxlivews-reference-additional)

<a id="ID4E6G" />

##### 進一步資訊

[Marketplace URI](/zh-TW/reference/live/rest/uri/marketplace/atoc-reference-marketplace)


## Related topics

- [XBOX Accessibility Guidelines (XAG)](/zh-TW/build/game-principles/accessibility/xbox-accessibility-guidelines.md)
- [使用 GDKX 建置並執行你的第一個主機遊戲](/zh-TW/home/build-first-title/first-console-title-walkthrough.md)
- [XBOX Partner Onboarding for access and publishing](/home/onboarding.md)
- [Integração de Parceiro XBOX para acesso e publicação](/pt-BR/home/onboarding.md)
- [Incorporación de partners de XBOX para acceso y publicación](/es/home/onboarding.md)