在開始設計第一個用戶端應用程式之前,您必須先做以下幾件事。
為用戶端建立專案
您必須先將用戶端的相關資訊提供給 Google,並啟用 API 存取權,才能傳送要求。 您可以使用 Google API 控制台建立「專案」,也就是具名的集合 設定和 API 存取資訊,並註冊您的應用程式。
如要開始使用 Android Over The Air API,您必須先 使用 設定工具,會引導您在 Google API 控制台,啟用 API 並建立憑證。
將專案加入許可清單
Android Over The Air API 僅適用於已加入許可清單的專案。如果專案未加入許可清單,
嘗試使用此工具時,您會收到 404
個錯誤。
如要加入許可清單,請傳送電子郵件給您的 Google TAM,以便將您新的專案 ID 加入許可清單。
如要查看專案 ID,請前往 Cloud 資訊主頁。 詳情請參閱這份說明文件。
請注意,專案 ID 格式應為 {company}-gota-api-{number}
加入許可清單後,請為專案啟用 Android Over The Air API,然後查看 請參閱授權操作說明。
請注意,只有你提供的專案 ID 才能使用 Android Over The Air API。三 強烈建議您建立用於 API 使用的服務帳戶 (如授權中所述) 不必使用任何個人帳戶
試用 Android Over The Air Dashboard
本 API 說明文件假設您曾使用 Android Over The Air Dashboard,而且熟悉網路程式設計概念和網站資料格式。
如果您尚未使用過 Android Over The Air Dashboard,請先測試使用者介面,再開始編寫程式碼。
瞭解 REST 的基本概念
您可以透過下列 2 種方式叫用 API:
- 傳送 HTTP 要求並剖析回應。
- 使用用戶端程式庫。
如果您決定不使用用戶端程式庫,則必須瞭解 REST 的基本概念。
REST 是一種軟體架構,可提供簡便且一致的資料要求及修改方法。
REST 這個詞是「Representational State Transfer (表現層狀態轉換)」的簡稱。在 Google API 中,這是指使用 HTTP 動詞來擷取及修改 Google 所儲存資料的表示法。
在符合 REST 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。
在具備 REST 特性的各種 Google API 中,用戶端會使用 POST
、GET
、PUT
或 DELETE
等 HTTP 動詞來指定動作。接著,該動詞會透過全域唯一的 URI 來指定資源,格式如下:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
由於所有 API 資源都有可供 HTTP 存取的專屬 URI,因此 REST 不僅能夠支援資料快取,也非常適合與網路的分散式基礎架構搭配運作。
您可以在 HTTP 1.1 標準說明文件中找到實用的方法定義;包括 GET
、POST
、PUT
和 DELETE
的規格。
Android Over The Air API 中的 REST
Android Over The Air API 作業直接對應至 REST HTTP 動詞。
Android Over The Air API URI 的專用格式如下:
https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters
如需 API 中各支援作業使用的完整 URI 組合摘要資訊,請參閱 Android Over The Air API 參考資料文件。
瞭解 JSON 的基本概念
Android Over The Air API 會以 JSON 格式傳回資料。
JSON (JavaScript Object Notation) 是一種不涉及語言的常用資料格式,可透過簡單的文字呈現多種資料結構。詳情請參閱 json.org。