获取单个国家的流媒体平台、播放类型和附加频道
查看 流媒体观看平台与片库查询 的全部接口 →按路径参数 country-code 中的 ISO 3166-1 alpha-2 国家代码返回单个国家对象,包含 countryCode、name 和 services。使用 us 的实际探测返回了美国,共 20 个平台。每个平台包含 id、name、homePage、themeColorCode、imageSet(lightThemeImage、darkThemeImage、whiteImage 三种徽标 URL)、streamingOptionTypes 和 addons。streamingOptionTypes 是由 addon、buy、rent、free、subscription 五个布尔值组成的对象,可据此判断某个平台在该国家提供租赁、购买、免费套餐还是只有订阅。每个附加频道包含 id、name、homePage、themeColorCode 以及自己的 imageSet。在美国的抽样中,有六个平台带有附加频道,数量从一个到 140 个(Prime Video)不等。output_language(en、es、tr、fr)用于本地化返回的名称。如果已经知道国家,想拿到它的平台 id、播放类型和附加频道 id,用来在查询片库或变动之前校验 catalogs 选择器,就适合使用这个接口。上述字段名和数量均来自针对 us 的实际调用;接口文档也说明该响应列出该国家受支持的平台及其名称、徽标、支持的播放类型和可用的附加频道。
API 功能
在线 API 演示
未找到可用的 API Key,请前往控制台创建后刷新本页。 控制台 →
/api/project/streaming-availability/get-country API 响应 (JSON)
{} curl -X GET 'https://api.opendata-api.com/api/project/streaming-availability/get-country?key=<API_KEY>&country-code=<country-code>&output_language=en'
查询结果
使用场景
- 渲染注册流程中的平台选择器,只显示用户所在国家实际销售的平台及其徽标。
- 读取 streamingOptionTypes,决定是否为某个平台在当地提供租赁、购买、免费或订阅筛选项。
- 列出某个平台的附加频道,让界面把某个选项标注为通过特定频道观看。
- 在发起片库或变动查询之前,校验某个 catalogs 选择器在该国家是不是真实存在的平台或附加频道 id。
常见问题
路径参数 country-code 应该填什么?
填写 ISO 3166-1 alpha-2 国家代码,例如 us。使用 country-code=us 的实际探测返回了美国对象,共 20 个平台。受支持的代码就是完整国家目录中的键。
它与完整的国家目录有什么区别?
目录接口一次返回全部受支持国家;这个接口针对单个代码返回结构相同的国家对象。在已经知道国家的情况下,获取和缓存的开销更小。
会返回多少个平台和附加频道?
因国家而异。美国的实际抽样有 20 个平台,其中六个带有附加频道,数量从一个到 Prime Video 的 140 个不等。目录抽样中的其他国家最少只有一个平台。
streamingOptionTypes 标志是什么意思?
这是一个对象,包含 addon、buy、rent、free 和 subscription 五个布尔值,说明该平台在这个国家提供哪些播放类型。它们对应片库选择器可接受的播放类型后缀。
返回的 id 可以直接用于其他查询吗?
可以。平台的 id 是有效的 catalogs 选择器,附加频道的 id 则扩展为 service.addon.<addon id>。先在这里确认,可以避免发送该国家不支持的选择器。