【URL Inspection API】Google URL検査ツールとは?全データをAPI経由で取得可能

URL Inspection API
  • URLをコピーしました!
URL Inspection API
URL Inspection API

Search ConsoleのURL検査とは?がAPIになることになりました。制限もウェブサイトプロパティ単位で1日2000クエリ、1分600クエリとかなりある。

目次

URL Inspection APIとは

この API は、Search Console で管理しているプロパティの URL レベルのデータにプログラムからアクセスできるようにするものです。

Search ConsoleのAPIは、外部のアプリケーションや製品を通じて、Search Console以外のデータにアクセスするための手段です。

開発者やSEOツールはすでにAPIを使用して、プロパティやサイトマップの表示、追加、削除を行うカスタムソリューションを構築したり、Searchパフォーマンスデータに対して高度なクエリを実行しています。

新しいURL Inspection APIにより、開発者がページをデバッグし、最適化するための新しいツールを提供します。

 Search Consoleが持つ、インデックスされたバージョンのURLに関するデータを要求することができます。APIは、URL Inspectionツールで現在利用可能なインデックスされた情報を返します。

APIを呼び出すと、関連するすべての結果を含む応答が返され、リクエストに失敗した場合はエラーメッセージが表示されます。特定の分析結果がレスポンスに含まれていない場合は、検査したURLでその分析が利用できなかったことを意味します。以下は、APIから取得するレスポンスの例です。

引用元:Method: index.inspect

  • 本日、Google検索コンソールのURL検査APIをリリースします。これは、デベロッパーとSEOがページをデバッグおよび最適化するための新しい方法です(Twitter翻訳)
https://twitter.com/googlesearchc/status/1488097572459888640?s=20&t=3jL7q9r6XstRao7QOyCDfA

UI 版(Search Console 内)の URL 検査ツールで提供されるすべてのデータを URL Inspection API で取得することが可能になるようですね。

  • インデックスの状況
  • モバイルユーザビリティ
  • AMP
  • リッチリザルト
  • URL が検出されたサイトマップ
  • 前回のクロール
  • robots.txt でブロックされているか(クロールが許可されているか)
  • ユーザーが指定した正規 URL
  • Google が選択した正規 URL
  • etc.

利用制限

1 日に 2,000 クエリまで
1 分間に 600 クエリまで

想定される事例

新しいAPIを構築する際、様々なSEO担当者やパブリッシャーに、このデータを使ってどのようにソリューションを提供するか。

・SEOの代理店は、重要なページの継続的な監視や、単一ページのデバッグオプションを提供することができます。例

えば、ユーザーが宣言したカノニカルとGoogleが選択したカノニカルの間に違いがあるかどうかをチェックしたり、ページのグループから構造化データの問題をデバッグしたりすることができます。

・SEOツールや代理店は、重要なページの継続的な監視や、単一ページのデバッグオプションを提供することができます。

例えば、ユーザーが宣言したカノニカルとGoogleが選択したカノニカルの間に違いがあるかどうかをチェックしたり、ページのグループから構造化データの問題をデバッグしたりすることができます。

実装方法

z

URL Inspection API
URL Inspection API

リクエストパラメータには、検査したいURLと、Search Consoleで定義されているプロパティのURLを指定します。

レスポンスには、インデックスステータス、AMP、リッチリザルト、モバイルユーザビリティなど、Search Consoleの情報を含む解析結果が含まれます。

詳しくは、「パラメータ一覧」と「インデックスされたURLの結果」の説明をご覧ください。

APIを呼び出すと、関連するすべての結果を含む応答が返され、リクエストに失敗した場合はエラーメッセージが表示されます。

特定の分析結果がレスポンスに含まれていない場合は、検査したURLでその分析が利用できなかったことを意味します。以下は、APIから取得するレスポンスの例です。

API 開発ドキュメント向け:https://developers.google.com/search/blog/2022/01/url-inspection-api

APIパラメータ一覧:https://developers.google.com/webmaster-tools/v1/urlInspection.index/UrlInspectionResult

インデックスされたURLの結果説明:https://support.google.com/webmasters/answer/9012289#indexed_inspection

引用元:Welcoming the new Search Console URL Inspection API

  {
  "inspectionResult": {
    "inspectionResultLink": "https://search.google.com/search-console/inspect?resource_id=https://developers.google.com/search/&id=odaUL5Dqq3q8n0EicQzawg&utm_medium=link&utm_source=api",
    "indexStatusResult": {
      "verdict": "PASS",
      "coverageState": "Indexed, not submitted in sitemap",
      "robotsTxtState": "ALLOWED",
      "indexingState": "INDEXING_ALLOWED",
      "lastCrawlTime": "2022-01-31T08:39:51Z",
      "pageFetchState": "SUCCESSFUL",
      "googleCanonical": "https://developers.google.com/search/help/site-appearance-faq",
      "userCanonical": "https://developers.google.com/search/help/site-appearance-faq",
      "referringUrls": [
        "https://developers.google.com/search/updates",
        "https://developers.google.com/search/help/crawling-index-faq"
      ],
      "crawledAs": "MOBILE"
    },
    "mobileUsabilityResult": {
      "verdict": "PASS"
    },
    "richResultsResult": {
      "verdict": "PASS",
      "detectedItems": [
        {
          "richResultType": "Breadcrumbs",
          "items": [
            {
              "name": "Unnamed item"
            }
          ]
        },
        {
          "richResultType": "FAQ",
          "items": [
            {
              "name": "Unnamed item"
            }
          ]
        }
      ]
    }
  }
}

HTTP request

POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect

URLはgRPC Transcodingシンタックスを使用しています。

JSONの表現方法
{
  "inspectionUrl": string,
  "siteUrl": string,
  "langu
フィールド
inspectionUrlstring

必須検査するURLです。

siteUrl “で指定されたプロパティの下にある必要があります。

siteUrlstring

必須Search Consoleで定義されたプロパティのURL。

例: URL-prefixプロパティの場合はhttp://www.example.com/、

Domainプロパティの場合はsc-domain:example.com。

languageCodestring

オプション。翻訳されたイシューメッセージに要求された言語を表すIETF BCP-47の言語コード(例:”en-US”、”de-CH”)。デフォルトは “en-US “です。

レスポンス

成功した場合、レスポンスボディは以下の構造を持つデータを含みます。

インデックス-ステータス検査応答。

JSON representation
{
  "inspectionResult": {
    object (UrlInspectionResult) }
Fields
inspectionResultobject (UrlInspectionResult)

URLの検査結果です。

認証スコープ

以下のOAuthスコープのいずれかが必要です。

https://www.googleapis.com/auth/webmasters
https://www.googleapis.com/auth/webmasters.readonly

「OAuth 2.0の概要」をご覧ください。

ゲームができるようになりました。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次