必備條件

在開始設計第一個用戶端應用程式之前,您必須先做以下幾件事。

為用戶端建立專案

您必須先向 Google 告知用戶端並啟用 API 存取權,才能傳送要求。如要這麼做,請使用 Google API 控制台建立「專案」,「專案」是命名的集合和 API 存取權資訊,並註冊應用程式。

如要開始使用 Android Over The Air API,請先使用設定工具,這項工具會逐步引導您在 Google API 控制台中建立專案、啟用 API,並建立憑證。

將專案加入許可清單

Android Over The Air API 僅適用於已加入許可清單的專案。如果專案未加入許可清單,您會收到 404 嘗試使用專案。

如要讓列入許可清單,請傳送電子郵件給 Google TAM,請對方將新的專案 ID 加入許可清單。

您可以在 Cloud 資訊主頁中找到專案 ID。如需詳細資訊,請參閱這篇說明文件

請注意,專案 ID 的格式最好是 {company}-gota-api-{number}

加入許可清單後,請為專案enable Android Over The Air API 並查看授權操作說明,進一步瞭解如何存取這項工具。

請注意,只有您提供的專案 ID 才能使用 Android Over The Air API。我們強烈建議您建立用於 API 用量的服務帳戶 (如授權中所述),而不要使用任何個人帳戶。

試用 Android Over The Air 資訊主頁

這份 API 說明文件假設您先前使用過 Android Over The Air 資訊主頁,並熟悉網路程式設計概念和網頁資料格式。

如果您未曾使用過 Android Over The Air 資訊主頁,請先試用使用者介面,再開始編寫程式碼。

瞭解 REST 的基本概念

您可以透過下列 2 種方式叫用 API:

如果您決定不使用用戶端程式庫,則必須瞭解 REST 的基本概念。

REST 是一種軟體架構,可提供簡便且一致的資料要求及修改方法。

REST 為 Representational State Transfer (具象狀態傳輸) 的簡稱。在 Google 的 API 中,這是指使用 HTTP 動詞來擷取及修改 Google 儲存的資料表示法。

在符合 REST 樣式的系統中,資源會儲存在資料儲存庫中。用戶端向伺服器發出執行特定動作 (例如建立、擷取、更新或刪除資源) 的要求後,伺服器就會執行指定動作並傳回回應 (大多採用指定資源表示法的形式)。

在 Google 的 REST 樣式 API 中,用戶端會使用 POSTGETPUTDELETE 等 HTTP 動詞指定動作。它會透過全域唯一的 URI 指定資源,格式如下:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

由於所有 API 資源都有可供 HTTP 存取的專屬 URI,因此 REST 不僅能夠支援資料快取,也非常適合與網路的分散式基礎架構搭配運作。

您可以在 HTTP 1.1 標準說明文件中找到實用的方法定義,其中包含 GETPOSTPUTDELETE 的規格。

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