本指南說明如何建立、管理及刪除裝置。妥善管理裝置有助於打造流暢的使用者體驗,並有效運用 Ambient API。
可建立裝置
使用者透過電視和有限輸入裝置應用程式專用的 OAuth 2.0 流程完成驗證後,請在他們的 Google 相簿帳戶中建立裝置。
應用程式使用 devices.create 方法成功建立裝置後,Ambient API 會傳回 AmbientDevice 物件,其中包含 Google 產生的 id。安全儲存這項id,並與使用者建立關聯。
使用 OAuth 簡化裝置建立流程
Ambient API 提供簡化的 OAuth 流程。在初始 OAuth 要求中傳遞額外 state 參數,並使用相符的 requestId 呼叫 devices.create,即可將裝置建立程序直接連結至使用者的登入流程,減少使用者需要掃描的 QR code 數量,簡化使用者體驗。
如需更多詳細資料和範例,請參閱「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。