Search Console API では、次のサービスを提供しています。
- 検索アナリティクス - サイトのトラフィック データをクエリします。
- サイトマップ - すべてのサイトマップのリストを取得して、特定のサイトマップに関する情報をリクエストし、Google にサイトマップを送信します。
- サイト - Search Console アカウントのプロパティを一覧表示 / 追加または削除します。
- URL 検査 - Google インデックスのページのステータスを調べることができます(Search Console の URL 検査と同じです)。
アナリティクスを検索
Search Analytics Resource の詳細については、リソース表現ページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
特に明記されていない限り、URI は https://www.googleapis.com/webmasters/v3 を基準とします。 | ||
query |
POST /sites/siteUrl/searchAnalytics/query
|
定義したフィルタとパラメータを使用して、検索トラフィック データをクエリします。このメソッドは、定義した行キー(ディメンション)ごとにグループ化された 0 個以上の行を返します。1 日以上の期間を定義する必要があります。 日付がディメンションの 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
|
このサイト用に送信された、またはサイトマップ インデックス ファイルに含まれていた maps-entries を一覧表示します(リクエストに sitemapIndex が指定されている場合)。 |
送信 |
PUT /sites/siteUrl/sitemaps/feedpath
|
サイトのサイトマップを送信します。 |
サイト
サイトリソースについて詳しくは、リソース表現のページをご覧ください。
メソッド | HTTP リクエスト | 説明 |
---|---|---|
特に明記されていない限り、URI は https://www.googleapis.com/webmasters/v3 を基準とします。 | ||
追加 |
PUT /sites/siteUrl
|
Search Console で一連のユーザーのサイトに追加します。 |
delete |
DELETE /sites/siteUrl
|
ユーザーの Search Console サイトからサイトを削除します。 |
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"} |