輔助 EDS API
有數個 Entertainment Discovery Services (EDS) API 不會直接提供內容的相關資訊,而是提供如何使用服務的一般資訊,或協助驅動常見的 UI 模型。輔助 API
API 參數值
此 API 說明可與服務搭配使用的參數。由於每個參數都附有當地語系化文字,因此用戶端 UI 可使用傳回的資訊。 下列 API 都不接受任何查詢參數。 | API| URI| 描述| | --- | --- | --- | --- | --- | --- | | 類型| //metadata/mediaGroups| 媒體群組的完整清單| | 每個媒體群組的媒體項目類型| //metadata/mediaGroups//mediaItemTypes| 指定媒體群組中包含的媒體項目類型清單。| | 所有媒體項目類型| //metadata/mediaItemTypes| 媒體項目類型的完整清單| | 每個媒體項目類型的欄位| //metadata/mediaItemTypes//fields| 單一媒體項目類型中的欄位清單| | 查詢精簡器| //metadata/mediaItemTypes//queryRefiners| 指定媒體項目類型所支援的查詢精簡器清單| | 所有查詢精簡器值| //metadata/mediaItemTypes//queryRefiners/| 指定媒體項目類型之指定查詢精簡器的值| | 所有查詢精簡器子值| //metadata/mediaItemTypes//queryRefiners//subQueryRefinerValues| 指定查詢精簡器值的子值清單 (例如「指定類型中的子類型」)。查詢精簡器值會以名為 “queryRefinerValue” 的查詢字串參數傳入,這樣做是為了允許傳遞包含 URI 主幹中禁止之字元的查詢精簡器值。| | 排序| //metadata/mediaItemTypes//sortOrders| 指定媒體項目類型的排序順序清單|合併內容分級產生器
強制執行家長監護控制,以管理允許兒童觀看的內容,是一項複雜的工作。不僅每個媒體項目類型都有自己的分級系統,而且這些分級系統可能因國家/地區而異。這表示需要指定數種不同的資料,才能正確篩選所有項目。 此 API 不需要在所有 API 呼叫中指定所有參數,而是會產生一個值,傳入其他 API 中的 combinedContentRating 參數,並仍然傳達相同的資訊。這是為了讓 API 更容易使用和維護而設計,因為傳入此 API 的數個參數會摺疊成單一、可重複使用的值,供其他 API 使用。 雖然此 API 傳回的確切值最終可能會變更,但變更的頻率應該非常低 (例如在 EDS 版本之間),因此可以長時間快取。任何接受 combinedContentRating 參數的 API,如果傳入的值無效,都會提供有意義的錯誤訊息,這表示呼叫者只需要再次呼叫此 API 即可取得更新的值。如果 API 接受 combinedContentRating 參數,但未提供該參數,則不會根據家長監護控制進行任何內容篩選注意:
這並不表示只會傳回「安全」的內容—而是表示會傳回所有內容,包括可能露骨的內容)。
合併欄位名稱
根據預設,EDS API 會針對每個項目傳回非常少的最小欄位集合:- 媒體項目類型
- 媒體群組
- 識別碼
- 名稱
