Ambient API 使用入门

借助 Ambient API,您的应用可以将氛围模式设备连接到用户的 Google 相册账号,并显示用户选择的照片。

Ambient API 流程

以下详细介绍了 Ambient API 如何连接设备,然后检索和显示媒体内容:

  1. 检查是否存在现有设备(推荐):在创建新设备之前,建议先检查当前用户是否已有设备。对于内部用户通过您的应用创建的任何设备,您的应用应在内部用户与 Google 提供的 deviceId 之间保持映射。如果为用户找到 deviceId,您可以继续刷新其授权令牌(如果需要)。

  2. 发起 OAuth 2.0 授权(并可选创建设备):通过请求授权代码,开始适用于电视和输入受限的设备的 OAuth 2.0 流程。

  3. 创建新设备:您的应用通过调用 CreateDevice 并提供有效的 v4 UUID 在用户的 Google 相册账号中创建设备。

    设备成功创建后,该 API 将返回一个包含 Google 分配的 deviceIdAmbientDevice 对象。您的应用必须存储此 deviceId 并将其与用户相关联,这一点至关重要。

  4. 显示 settingsUriAmbientDevice 对象包含 settingsUri。向用户显示此 URI(通常以二维码的形式),以便用户使用移动设备进行扫描。此 URI 会将用户定向至 Google 相册应用,在该应用中,用户可以配置要在氛围模式设备上显示的媒体来源(例如影集)。

  5. 轮询 mediaSourcesSet:您的应用应定期调用 GetDevice 方法,提供 deviceId,以检查环境设备的状态。监控 AmbientDevice 响应中的 mediaSourcesSet 字段。它最初的值为 false。

    当用户在 Google 相册应用中成功选择媒体来源后,此字段将更改为 true。

    AmbientDevice 响应包含一个包含 pollIntervalpollingConfig,您应将其用作轮询频率的准则。

  6. 检索媒体内容:当 mediaSourcesSet 返回 true 时,您的应用可以开始提取用户选择的媒体内容。

    调用 ListMediaItems 方法,提供 deviceId。该 API 将返回一个包含 AmbientMediaItem 对象列表的 ListMediaItemsResponse。每个 AmbientMediaItem 都包含 idcreateTimeMediaFile 对象等详细信息,以及其他元数据。MediaFile 包含一个 baseUrl,您可以使用该 baseUrl 提取媒体内容的实际字节。如需详细了解其他 baseUrl 参数,请参阅列出和检索媒体内容指南。

  7. 显示媒体内容:使用 MediaFile 中的 baseUrl 在氛围设备上下载和显示媒体内容。

重要注意事项

设备数量限制和管理:

  • 设备数量限制:请注意,每个应用用户的设备数量上限为 100 部。
  • 设备活动和令牌:您需要管理设备和用户授权令牌的生命周期。考虑设备保持活跃状态的时长,以及在设备变为非活跃状态或令牌过期时如何处理令牌刷新或重新授权。

如需了解详情,请参阅创建和管理设备指南。

处理媒体内容:

  • 媒体内容使用:了解如何使用 baseUrl 正确提取和处理媒体内容,包括任何必要的身份验证或参数。
  • 错误处理:为 API 调用实现强大的错误处理,包括设备出现 NOT_FOUND 的情况、未设置媒体源时出现 FAILED_PRECONDITION 的情况,以及达到设备限制时出现 RESOURCE_EXHAUSTED 的情况。

如需了解详情,请参阅列出和检索媒体内容指南。

后续步骤