2020 年 12 月 9 日（水）
Search Console API のパフォーマンスを改善して需要の拡大に対応するため、数か月前に API インフラストラクチャのアップグレードを発表しました。本日は、今後予定されているいくつかの更新についてお知らせいたします。
- Search Console API に最新データとニュース フィルタを追加
- Sitemaps API でドメイン プロパティをサポート
- ディスカバリ ドキュメントを移行する方法についてのガイドラインを追加
API に対して独自の呼び出しを行う場合は、以下をお読みください。
Search Console API の最新データとニュース フィルタ
パフォーマンス レポートでは、1 日以内の最新データがすでにサポートされています。リクエスト パラメータ dataState の値を all に設定して渡すことで、API を介してこのデータを確認できるようになりました。この値で取得したデータには、まだ確定していない最新データも含まれます。最終データのみを取得する場合は、このパラメータの値を final に設定して渡してください。また、何も渡さなくても、デフォルトで最終データのみが取得されます。
数か月前、パフォーマンス レポートの検索フィルタに [ニュース] タブが追加されました。この情報も API でご確認いただけるようになりました。この情報を確認するには、リクエストの searchType パラメータの値を news に設定します。
Sitemaps API でドメイン プロパティをサポート
他の Search Console API と同じように、Sitemaps API でもドメイン プロパティがサポートされるようになりました。ドメイン プロパティでサイトマップのクエリ、追加、削除ができます。次に例を示します。
GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps
ディスカバリ ドキュメントの移行
Google は、Webmasters ディスカバリ ドキュメントのサポートを終了いたします。外部の API ライブラリを使用して Search Console API にクエリを実行する場合、または Webmasters API ディスカバリ ドキュメントに直接クエリを実行する場合は、API 呼び出しを更新して次の変更を行う必要があります。
API ライブラリの変更
API ライブラリの変更に関する最新情報については、Java と Python のクイックスタート ガイドで最新の API 使用ガイドをご覧ください。
Java
Webmasters サービスに関連したすべてのインポートについて、webmasters パッケージを searchconsole.v1 パッケージに変更し、サービス名の Webmasters を SearchConsole に変更します。以下に例を示します。
- API サービスのインポート:
import com.google.api.services.webmasters.Webmasters;import com.google.api.services.searchconsole.v1.SearchConsole; - レスポンス オブジェクトのインポート:
import com.google.api.services.webmasters.model.WmxSite;import com.google.api.services.searchconsole.v1.model.WmxSite;
サービス オブジェクト以外の API オブジェクトは以前とまったく同じで、パッケージのみが変更されています。
Python
Webmasters サービスのオブジェクトを作成する際は、次のように変更します。
webmasters_service = build('webmasters', 'v3', http=http)
webmasters_service = build('searchconsole', 'v1', http=http)
ここでも、オブジェクトの動作には変更はありません。
ディスカバリ ドキュメントに対する直接的なクエリ
ディスカバリ ドキュメントへのクエリには、次のような変更を加える必要があります。
- URL の変更
https://www.googleapis.com/discovery/v1/apis/webmasters/v3/resthttps://searchconsole.googleapis.com/$discovery/rest - コンテンツの変更
nameフィールドがwebmastersからsearchconsoleに変更されました。versionフィールドがv3からv1に変更されました。
ご不明な点がありましたら、検索セントラル コミュニティまたは Twitter でお問い合わせください。