前提条件

最初のクライアント アプリケーションのコーディングを開始する前に、行うことがいくつかあります。

クライアントのプロジェクトを作成する

リクエストを送信する前に、クライアントについて Google に伝え、API へのアクセスを有効にする必要があります。 これを行うには、Google API Console を使用して、プロジェクト(名前付きコレクション)を作成します。 API アクセス情報のリストを表示し、アプリケーションを登録します。

Android Over The Air API の使用を開始するには、まず、 設定ツールを使用して、Google Cloud コンソールでプロジェクトを作成する手順が Google API Console、API の有効化、認証情報の作成

プロジェクトを許可リストに登録する

Android Over The Air API は、許可リストに登録されたプロジェクトでのみ利用できます。プロジェクトが許可リストに登録されていない場合は、 使用しようとすると 404 件のエラーが発生します。

許可リストに登録するには、Google TAM にメールを送信して新しいプロジェクト ID を許可リストに登録します。

プロジェクト ID は Cloud ダッシュボードで確認できます。 詳しくは、こちらのヘルプ ドキュメントをご覧ください。

プロジェクト ID は、{company}-gota-api-{number} の形式にするのが理想的です

許可リストに登録したら、プロジェクトで Android Over The Air API を有効にして、 認可ハウツーをご覧ください。

Android Over The Air API を使用できるのは、指定したプロジェクト ID のみです。水 API を使用するためのサービス アカウントの作成を強くおすすめします(承認の説明を参照)。 おすすめします

Android Over The Air ダッシュボードを試す

この API ドキュメントは、Android Over The Air ダッシュボードの使用経験があり、ウェブ プログラミングの概念やウェブデータ形式の知識があることを前提としています。

Android Over The Air ダッシュボードを使ったことがない場合は、コーディングを始める前に Android のユーザー インターフェースを使ってみてください。

REST の基礎を学習する

API は次の 2 つの方法で呼び出すことができます。

クライアント ライブラリを使用しない場合は、REST の基礎を理解する必要があります。

REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャのスタイルです。

REST という用語は「Representational State Transfer」の省略形です。Google API のコンテキストでは、HTTP 動詞を使用して、Google が保存しているデータ表現を取得および変更することを表しています。

RESTful システムでは、リソースはデータストアに保存されており、クライアントはサーバーが特定のアクション(リソースの作成、取得、更新、削除など)を実行するようにリクエストを送信し、サーバーはそのアクションを実行し、多くの場合、指定されたリソースの表現形式でレスポンスを送信します。

Google の RESTful 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 をご覧ください。