【Python】Google Search Console URL Inspection APIの使い方とサンプルコード

Googleサーチコンソールの検査ツールのAPI(Google Search Console URL Inspection API)がリリースされたとの事なので早速使ってみました。

取り急ぎサンプルコードを載せますのでよければご利用ください。

📢 Today we’re launching the Google Search Console URL Inspection API, a new way for developers & SEOs to debug and optimize their pages 🔎 https://t.co/ckRPcFRPNJ pic.twitter.com/u7DCE66bc3
— Google Search Central (@googlesearchc) January 31, 2022

事前準備
サンプルコード
実行結果

事前準備

Google Search Console URL Inspection APIを利用する為には

Googleのサービスアカウント作成
APIを利用する為の認証キーの発行
作成したサービスアカウントをサーチコンソールへ登録

などが必要となります。

以下のサイトで丁寧に説明されておられますので、こちらの1の手順を実施してください。

また、本サンプルを実行する為には参考サイトの手順実施でダウンロードする「json形式の認証ファイル」が必要となります。

Pythonを使ってGoogle search console（サーチコンソール）のAPIを叩いてみた！｜スタビジ

当サイト【スタビジ】の本記事では、Pythonを使ってGoogle search console（サーチコンソール）のAPIを利用してみます。PythonはAPIを利用するのに非常に便利です。Googleプロダクトは各種APIを提供していてAPIを使うことで様々なことができるので試してみましょう！

上記サイトの手順実施が完了しjsonファイルまでダウンロードしたら、以下のコマンドを実行してgoogleの認証ライブラリとpython用クライアントをインストールしてください。

$ pip install --upgrade google-auth
$ pip install google-api-python-client

サンプルコード

from google.oauth2 import service_account
from googleapiclient.discovery import build
 
credentials_json = "認証ファイルへのパスを記載"
  
SCOPE = [
    'https://www.googleapis.com/auth/webmasters',
    'https://www.googleapis.com/auth/webmasters.readonly'
    ]
 
credentials = service_account.Credentials.from_service_account_file(credentials_json, scopes=SCOPE)
service = build('searchconsole','v1',credentials=credentials)
 
request_param = {
  'siteUrl': '検査するプロパティを記載',
  'inspectionUrl': '検査するURLを記載'
}
 
response = service.urlInspection().index().inspect(body=request_param).execute()
inspection_result = response['inspectionResult']
print(inspection_result)

credentials_json	事前準備でダウンロードしたjsonファイルへのパスを記載します	例：credentials.json
siteUrl	検査したいプロパティを記載します。プロパティがドメインの場合は「sc-domain:ドメイン名」としてください	例 URLプロパティの場合： https://blog.fetinomori.com/ ドメインプロパティの場合： sc-domain:blog.fetinomori.com
inspectionUrl	検査したいURLを記載します。 siteUrlで指定したプロパティの配下にあるものを指定する必要があります	例：https://blog.fetinomori.com/privacy-policy/

実行結果

サンプルとして当サイトのルートURLを検査してみました。

[XXXXX@XXXXXXXX]$ python3 inspection_sample.py 
{'inspectionResultLink': 'https://search.google.com/search-console/inspect?{'inspectionResultLink': 'https://search.google.com/search-console/inspect?resource_id=https://blog.fetinomori.com/&id=XXXXXXXXXXXXXXXXX&utm_medium=link&utm_source=api', 'indexStatusResult': {'verdict': 'PASS', 'coverageState': 'Indexed, not submitted in sitemap', 'robotsTxtState': 'ALLOWED', 'indexingState': 'INDEXING_ALLOWED', 'lastCrawlTime': '2022-01-30T18:42:28Z', 'pageFetchState': 'SUCCESSFUL', 'googleCanonical': 'https://blog.fetinomori.com/', 'userCanonical': 'https://blog.fetinomori.com/', 'referringUrls': ['https://d.hatena.ne.jp/keywordtouch/VPS', 'https://d.hatena.ne.jp/keyword/%E3%82%A2%E3%83%95%E3%82%A3%E3%83%96%E3%83%AD%E3%82%B0'], 'crawledAs': 'MOBILE'}, 'mobileUsabilityResult': {'verdict': 'PASS'}}

出力結果の説明は公式ドキュメントで確認できます。