前提条件

このドキュメントでは、最初のクライアント アプリケーションを作成する前に行うべきことについて説明します。

Google アカウントを取得する

この API を使用するには、Google アカウントが必要です。 特定のプロパティで対象メソッドを呼び出すには、アカウントにそのプロパティに対する適切な Search Console 権限が必要です。たとえば、searchAnalytics.query を実行するには、そのプロパティの読み取り権限が必要です。

Google Search Console を使ってみる

この API ドキュメントは、Google Search Console を使用していて、ウェブ プログラミングの概念とウェブデータの形式に精通していることを前提としています。

Google Search Console を初めて使用する場合は、コーディングを始める前にユーザー インターフェースを使ってみてください。 各 API は、Search Console のレポートの機能を表します。受信するデータを理解するには、API を使用する前に同等のレポートに関するドキュメントをご覧ください

クライアントのプロジェクトと認証情報を作成する

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

Testing Tools API を除くすべての Search Console API には、OAuth2 認証情報が必要です。Python と Java のクイックスタート ガイドでは、プロジェクトを作成し、クライアントの認証情報を取得する方法について詳しく紹介しています。

REST の基本を理解する

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

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

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 Search Console API の REST

Google Search Console API オペレーションは、REST HTTP 動詞に直接マッピングされます。

ほとんどの Google Search Console API URI の形式は次のとおりです。

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

各メソッドで使用される URI と動詞の一覧については、Google Search Console API リファレンスの概要をご覧ください。

JSON の基本を理解する

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

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