建立及管理裝置

本指南將說明如何建立、管理及刪除裝置。妥善的裝置管理有助於打造流暢的使用者體驗,並有效運用 Ambient API。

可建立裝置

使用者使用 適用於電視和輸入受限裝置應用程式的 OAuth 2.0 流程成功完成驗證後,請在其 Google 相簿帳戶中建立裝置。

當應用程式使用 devices.create 方法成功建立裝置時,Ambient API 會傳回 AmbientDevice 物件,其中包含 Google 產生的 id。安全地儲存這個 id,並與使用者建立關聯。

使用 OAuth 簡化裝置建立程序

Ambient API 提供簡化的 OAuth 流程,可同時建立裝置和使用者驗證。您可以在初始 OAuth 要求中傳遞額外的 state 參數,將裝置建立程序直接連結至使用者的登入流程,藉此減少使用者需要掃描的 QR code 數量,簡化使用者體驗。

如需詳細資訊和範例,請參閱「Streamlined authentication flow for the Ambient API」(Ambient API 的簡化驗證流程) 指南。

裝置限制

您的應用程式最多可為每位使用者建立 100 個裝置。如果超過此限制,API 會傳回 RESOURCE_EXHAUSTED 錯誤。

管理裝置

建立裝置並連結至使用者的 Google 相簿帳戶後,您可能需要管理裝置的生命週期。

擷取裝置

如要擷取特定裝置的相關資訊,請使用 devices.get 方法搭配其專屬的 id。這有助於檢查裝置狀態,例如 mediaSourcesSet 是否為 true。

可更新裝置

您可以使用 devices.patch 方法更新現有裝置的特定屬性,例如顯示名稱。這樣一來,使用者就能自訂裝置,並在 Google 相簿中輕鬆辨識裝置。

刪除裝置

實作刪除裝置的策略,以便妥善清理裝置並提供使用者控管機制。您可以使用 devices.delete 方法刪除裝置。

請考量下列刪除裝置的情境:

  • 使用者取消連結:如果使用者取消應用程式與 Google 相簿帳戶的連結,您應刪除對應的裝置。
  • 孤立裝置:如果您找不到 id,但仍有建立時使用的 requestId,您可以使用 requestId 搭配 devices.delete 來移除孤立裝置。這有助於避免意外重複,並確保使用者帳戶保持乾淨。

重要注意事項和最佳做法

  • 裝置生命週期和使用者授權:您必須管理裝置和使用者授權權杖的生命週期。請考量裝置的有效期限,以及在裝置失效或權杖到期時,如何處理權杖重新整理或重新授權。
  • 錯誤處理:為所有裝置相關的 API 呼叫實作可靠的錯誤處理機制。請做好準備,以因應下列情境:
    • NOT_FOUND:裝置不存在或不屬於使用者。
    • RESOURCE_EXHAUSTED:如果您超出裝置限制。
    • ALREADY_EXISTS:如果您嘗試使用已存在的 requestId 建立裝置。

後續步驟

  • 應用程式範例:我們的應用程式範例包含建立裝置和使用回應資料的範例。詳情請參閱 createDevice 函式。
  • 參考說明文件:請參閱完整的裝置參考文件,瞭解所有可用方法、請求和回應參數,以及錯誤代碼的詳細資訊。
  • 列出及擷取媒體項目:建立及管理裝置後,請瞭解如何列出及擷取媒體項目,以便在裝置上顯示。