API Reference

Search Console API には、次のサービスが用意されています。

  • 検索アナリティクス - サイトのトラフィック データをクエリします。
  • サイトマップ - すべてのサイトマップを一覧表示し、特定のサイトマップに関する情報をリクエストして、Google にサイトマップを送信します。
  • サイト - Search Console アカウントのプロパティを一覧表示、追加、削除できます。
  • URL 検査 - Google インデックス内のページのステータスを検査します（Search Console の URL 検査に相当）。

検索アナリティクス

検索分析リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/webmasters/v3 を基準とします。
query POST  /sites/siteUrl/searchAnalytics/query

定義したフィルタとパラメータを使用して、検索トラフィック データのクエリを実行できます。このメソッドは、定義した行キー（ディメンション）でグループ化された 0 個以上の行を返します。1 日以上の期間を定義する必要があります。

日付がディメンションの場合、データのない日は結果リストから除外されます。データがある日を調べるには、日付でグループ化されたフィルタなしで対象の日付範囲を指定してクエリを発行します。

結果はクリック数の降順で並べ替えられます。クリック数が同じ 2 つの行は任意の順序で並べ替えられます。

このメソッドを呼び出す方法については、Python サンプルをご覧ください。

JSON POST の例: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

サイトマップ

サイトマップ リソースの詳細については、リソース表現ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/webmasters/v3 を基準とします。
delete DELETE  /sites/siteUrl/sitemaps/feedpath このサイトからサイトマップを削除します。
get GET  /sites/siteUrl/sitemaps/feedpath 特定のサイトマップに関する情報を取得します。
list GET  /sites/siteUrl/sitemaps そのサイトに関して送信された sitemaps-entries またはサイトマップ インデックス ファイル（リクエストで sitemapIndex が指定されている場合）のリストを取得します。
submit PUT  /sites/siteUrl/sitemaps/feedpath サイトのサイトマップを送信します。

Google サイト

Google サイトリソースの詳細については、リソース表現ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/webmasters/v3 を基準とします。
add PUT  /sites/siteUrl Search Console でユーザーの一連のサイトにサイトを追加します。
delete DELETE  /sites/siteUrl ユーザーの一連の Search Console サイトから 1 つのサイトを削除します。
get GET  /sites/siteUrl 特定のサイトに関する情報を取得します。
list GET  /sites ユーザーの Search Console サイトを一覧表示します。

URL の検査

URL 検査リソースの詳細については、リソースの表記ページをご覧ください。

メソッド HTTP リクエスト 説明
https://searchconsole.googleapis.com/v1 を基準とする相対 URI
index.inspect POST /urlInspection/index:inspect

Google インデックスで指定された URL の情報。

JSON POST の例: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}