このドキュメントでは、最初のクライアント アプリケーションを作成する前に、行うべきことについて説明します。
Google アカウントを取得する
この API を使用するには Google アカウントが必要です。特定のプロパティでメソッドを呼び出すには、そのプロパティに対する適切な Search Console 権限がアカウントに付与されている必要があります。たとえば、searchAnalytics.query を実行するには、そのプロパティに対する読み取り権限が必要です。
Google Search Console を試す
この API ドキュメントは、Google Search Console を使用していて、ウェブ プログラミングの概念やウェブデータ形式の知識があることを前提としています。
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 つの方法で呼び出すことができます。
- HTTP リクエストを送信し、レスポンスを解析する。
- クライアント ライブラリを使用する。
クライアント ライブラリを使用しない場合は、REST の基礎を理解する必要があります。
REST の基本
REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャのスタイルです。
REST という用語は「Representational State Transfer」の省略形です。Google API のコンテキストでは、HTTP 動詞を使用して、Google が保存しているデータ表現を取得および変更することを表しています。
RESTful システムでは、リソースはデータストアに保存されており、クライアントはサーバーが特定のアクション（リソースの作成、取得、更新、削除など）を実行するようにリクエストを送信します。サーバーはそのアクションを実行し、多くの場合、指定されたリソースの表現形式でレスポンスを送信します。
Google の RESTful API では、クライアントは POST、GET、PUT、DELETE などの HTTP 動詞を使用してアクションを指定します。次の形式のグローバルに一意な URI でリソースを指定します。
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータ キャッシュを有効にし、ウェブの分散インフラストラクチャで動作するように最適化されています。
HTTP 1.1 標準のドキュメントのメソッド定義をご覧ください。GET、POST、PUT、DELETE の仕様が記載されています。
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 をご覧ください。