Skip to main content

辅助 EDS API

有几个娱乐发现服务 (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 为每项返回一个非常小的最小字段集:
  • 媒体项类型
  • 媒体组
  • Id
  • Name
若要获取更多信息,API 接受一个 “fields” 参数,用于指定应额外返回哪些数据。由于可能的字段有很多,为每次 API 调用都完整指定它们的名称将大大增加请求体量。相反,可以将这些名称传入此 API,它将生成一个更小的值,然后传入其他 API。 对于接受此参数的任何 API,提供的值必须是所有指定媒体项类型中所有字段的超集。不能为不同的媒体项类型指定不同的字段集。但是,如果某个字段适用于一种媒体项类型而不适用于另一种,则它只会出现在存在数据的媒体项类型中(例如,如果对组合字段名 API 的调用中包含 “AvatarBodyType”,则只有 AvatarItems 才会包含该字段)。 此 API 返回的值具有很高的可缓存性——事实上,除非在 EDS 部署之间,否则不应变化。建议如果需要缓存,缓存的存续时间不超过用户会话的时长。 除了接受实际字段名之外,此 API 还接受 “all” 作为有效值。这将生成一个包含所有可指定字段的值。“all” 值可能仅用于开发、调试和测试目的。

另请参阅

上级
附加参考
更多信息
市场 URI
Last modified on October 19, 2026