Search Console API 相關更新內容

2020 年 12 月 9 日,星期三

我們在幾個月前宣布要升級 API 基礎架構,以此提升 Search Console API 效能來因應日益增長的使用需求。今天,很高興能向您介紹其他幾項即將推出的改善措施:

  • 在 Search Console API 中加入最新資料功能和新聞篩選器
  • Sitemap API 支援網域資源
  • 提供如何遷移探索文件的說明

如果您會自行呼叫 API,請參閱下文。

Search Console API 中的最新資料功能與新聞篩選器

先前,我們已在成效報表中提供一天內的最新資料,現在您只要在傳遞要求參數 dataState 時將值設為 all,就可以透過 API 存取這些資料。在透過這個值獲得的資料中,會包含尚未最終確定的最新資料,如果您只想要取得最終資料,可以傳遞設為 final 的參數值,或完全不傳遞此參數,這樣根據預設就只會取得最終資料。

幾個月前,我們在成效報表中新增了 Google 搜尋「新聞」分頁的篩選器,現在 API 也能顯示這項資訊,您只要將要求中的 searchType 參數值設為 news 即可存取。

Sitemap API 支援網域資源

如同其他 Search Console API,Sitemaps API 現在也支援網域資源。您可以查詢、新增和刪除網域資源中的 Sitemap,例如:

GET https://www.googleapis.com/webmasters/v3/sites/sc-domain:example.com/sitemaps

探索文件遷移作業

我們將停止支援 Webmasters 探索文件。如果您使用外部 API 程式庫來查詢 Search Console API,或是直接查詢 Webmasters API 探索文件,就必須更新 API 呼叫以納入下列變更。

API 程式庫異動

如要瞭解 API 程式庫異動的最新資訊,請參閱 JavaPython 快速入門導覽課程指南,以取得更新版 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)

同樣地,物件的行為也沒有任何改變。

直接查詢探索文件

探索文件查詢作業的變更包括:

  • 網址變更

    https://www.googleapis.com/discovery/v1/apis/webmasters/v3/rest

    https://searchconsole.googleapis.com/$discovery/rest

  • 內容變更
    • name 欄位已從 webmasters 變更為 searchconsole
    • version 欄位已從 v3 變更為 v1

如有任何問題,歡迎透過搜尋中心社群Twitter 提問。