Admin API の REST

Admin API のオペレーションは、REST HTTP 動詞に直接マッピングされます。つまり、標準的な HTTP メソッドを使用してリソースを取得し、操作できます。

Admin API URI には次の形式があります。

https://appengine.googleapis.com/v1/resourcePath?parameters

たとえば、my-app プロジェクト内のアプリケーションの my- frontend サービスについて、my-v1 バージョンの詳細をすべて表示するには、HTTP リクエストを送信します(?view=FULL パラメータを使用)。

 GET https://appengine.googleapis.com/v1/apps/my-app/services/my-frontend/versions/my-v1?view=FULL

API でサポートされている各オペレーションで使用される URI の一覧については、Google App Engine Admin API リファレンス ドキュメントをご覧ください。

基本事項

REST API を初めて使用する場合に役立つリソースがあります。

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 の仕様が記載されています。

JSON の基本

Admin API は JSON 形式でデータを返します。

JSON(JavaScript Object Notation)は、任意のデータ構造の単純なテキスト表現を提供する、一般的な言語に依存しないデータ形式です。詳しくは json.org をご覧ください。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...