要件

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

Google アカウントを取得する

Google API Console でプロジェクトを作成するには、Google アカウントが必要です。すでにアカウントをお持ちの場合は、準備が整っています。

テスト用に別の Google アカウントを取得することもできます。

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

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

Google Knowledge Graph Search API を使用するには、まず設定ツールを使用する必要があります。このツールのガイドに沿って、Google API Console でプロジェクトを作成し、API を有効にして、認証情報を作成します。

まだの場合は、[認証情報を作成] > [API キー] をクリックしてアプリケーションの API キーを作成します。次に、[API キー] セクションで 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 の仕様が記載されています。

Google Knowledge Graph Search API の REST

Google Knowledge Graph Search API オペレーションは REST の HTTP 動詞に直接マッピングされています。

Google Knowledge Graph Search API の URI の形式は次のとおりです。

https://kgsearch.googleapis.com/v1/entities:search?query=your_query&parameters

API でサポートされている各オペレーションで使用される URI の完全なセットは、Google Knowledge Graph Search API リファレンス ドキュメントにまとめられています。

JSON の基礎を学習する

Google Knowledge Graph Search API はデータを JSON 形式で返します。

JSON(JavaScript Object Notation)は言語に依存しない一般的なデータ フォーマットで、任意のデータ構造を単純なテキスト形式で表すことができます。詳しくは json.org をご覧ください。