Search Analytics: query

需要授權

使用您定義的篩選器和參數查詢搜尋流量資料。此方法會傳回零或多個資料列,這些資料列會按照您定義的資料列索引鍵 (維度) 分組。您必須定義一個或數天的日期範圍。

如果日期是其中一個維度,結果清單會忽略任何沒有資料的日期。如要瞭解哪些日期有資料,請針對日期範圍的日期範圍,發出不含篩選器的查詢。

結果會依點擊次數遞減排序。如果兩列的點擊次數相同,就會以任意方式排序。

請參閱 Python 範例來呼叫這個方法。

這個 API 受 Search Console 的內部限制,無法保證會傳回所有資料列,而不是傳回最超出的資料列。

查看可用數據用量的限制

JSON POST 範例:
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}
立即試用

要求

HTTP 要求

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

參數

參數名稱 說明
路徑參數
siteUrl string Search Console 中定義的資源網址。示例: http://www.example.com/ (適用於網址前置字元資源) 或 sc-domain:example.com (網域資源)

授權

這項要求至少需要以下其中一個範圍的授權 (進一步瞭解驗證和授權)。

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

要求主體

在要求主體中,以下列結構提供資料:

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}
資源名稱 說明 附註
startDate string [必要] 要求日期範圍的開始日期,格式為 YYYY-MM-DD,以 PT 時間 (UTC - 7:00/8:00) 表示。必須小於或等於結束日期。這個值包含在範圍內。
endDate string [必要] 要求日期範圍的結束日期,以 YYYY-MM-DD 格式表示,以太平洋時間 (UTC - 7:00/8:00) 表示。必須大於或等於開始日期。這個值包含在範圍內。
dimensions[] list [選用] 提供零或多個維度做為結果分組依據。系統會按照您提供這些維度的順序,將結果分組。您可以在 dimensionFilterGroups[].filters[].dimension 和「日期」中使用任何維度名稱。系統會將分組維度值合併,為每個結果資料列建立專屬鍵。如果沒有指定維度,所有值都會合併成一列。可分類的維度數量沒有上限,但不能按相同維度重複分組。範例:[國家/地區、裝置]
searchType string 已淘汰,請改用 type
type string [選用] 依下列類型篩選結果:
  • discover」:Google 探索結果
  • googleNews」:來自 news.google.com 及 Android 版/iOS 版 Google 新聞應用程式的搜尋結果。但不包括 Google 搜尋中的「新聞」分頁的搜尋結果。
  • news」:Google 搜尋中「新聞」分頁的搜尋結果。
  • image」:Google 搜尋中「圖片」分頁的搜尋結果。
  • video」:影片搜尋結果
  • "web": [預設] 在 Google 搜尋中篩選合併 (「全部」) 分頁的結果。不包含 Google 探索或 Google 新聞搜尋結果。
dimensionFilterGroups[] list [選用] 可套用至維度分組值的零或多組篩選器。所有篩選器群組都必須相符,回應中才會傳回資料列。在單一篩選器群組中,您可以指定所有篩選器是否須相符,或是至少一個篩選器必須相符。
dimensionFilterGroups[].groupType string 這個群組中的所有篩選器都必須傳回「true」(和),或是一或多個必須傳回「true」(尚未支援)。

可接受的值為:
  • "and":針對篩選器群組,群組中的所有篩選器都必須傳回「是」o 為 true。
dimensionFilterGroups[].filters[] list [選用] 零或多個用於對照資料列的篩選器。每個篩選器都是由維度名稱、運算子和值組成。長度上限為 4096 個字元。範例:
country equals FRA
query contains mobile use
device notContains tablet
dimensionFilterGroups[].filters[].dimension string 要套用這個篩選器的維度。您可以按這裡列出的任何維度進行篩選,即使未依該維度分組也一樣。

可接受的值為:
  • country」:依指定國家/地區進行篩選,依 3 個字母的國家/地區代碼 (ISO 3166-1 alpha-3) 進行篩選。
  • device」:根據指定裝置類型篩選結果。支援的值:
    • 電腦
    • 行動裝置
    • 平板電腦
  • page」:根據指定的 URI 字串篩選。
  • query」:依指定查詢字串篩選。
  • searchAppearance」:篩選特定搜尋結果功能。如要查看可用值的清單,請依「searchAppearance」分組執行查詢。
dimensionFilterGroups[].filters[].operator string [選用] 指定值如何與資料列的維度值相符 (或不相符)。

可接受的值為:
  • contains」:資料列值必須包含或等於您的運算式 (不區分大小寫)。
  • "equals": [預設] 運算式必須與資料列值完全相同 (網頁和查詢維度必須區分大小寫)。
  • notContains」:資料列值不得包含子字串或完整比對 (不區分大小寫)。
  • notEquals」:運算式不得與資料列值完全相同 (網頁和查詢維度須區分大小寫)。
  • includingRegex」:必須比對的 RE2 語法規則運算式。
  • excludingRegex」:不應比對的 RE2 語法規則運算式。
dimensionFilterGroups[].filters[].expression string 篩選器要比對或排除的值,視運算子而定。
aggregationType string

[選用] 資料的匯總方式,如果依資源匯總,系統會匯總相同資源的所有資料;如果依網頁匯總,所有資料皆會按標準 URI 匯總。如要依網頁篩選或分組,請選擇「自動」,否則您可以根據所需資料計算方式,依資源或網頁進行匯總。請參閱說明文件,瞭解依網站和依網頁計算資料的方式不同。

注意: 如果您依網頁分組或篩選,就無法依資源進行匯總。

如果指定自動以外的值,結果中的匯總類型就會與要求的類型相符,或是如果要求無效類型,則會收到錯誤訊息。如果要求的類型無效,API 一律不會變更匯總類型。

可接受的值如下:
  • "auto": [預設] 讓服務決定適當的匯總類型。
  • byNewsShowcasePanel」:依新聞編輯推薦面板匯總值。 必須與 NEWS_SHOWCASE searchAppearance 篩選器以及 type=discovertype=googleNews 搭配使用。如果您依照網頁進行分組、依網頁篩選,或篩選出另一個 searchAppearance,就無法依照 byNewsShowcasePanel 匯總。
  • byPage」:依 URI 匯總值。
  • byProperty」:依屬性匯總值。不支援 type=discovertype=googleNews
rowLimit integer [選用;有效範圍介於 1 到 25,000 之間,預設值為 1,000 列。如要逐頁瀏覽結果,請使用 startRow 偏移。
startRow integer [選用;預設值為 0] 回應中第一列的零從零開始索引。必須為非負數。如果 startRow 超過查詢的結果數量,回應就會是零個成功的回應。
dataState string [選用] 如果為「all」(不區分大小寫),則資料會包含新的資料。如果「最終」(不區分大小寫) 或省略這個參數,則傳回的資料只會包含最終資料。

回應

結果會根據要求中指定的維度分組。系統會將含有同一組維度值的所有值歸入單一資料列。舉例來說,如果您依國家/地區維度分組,則「usa」的所有結果都會歸為一組,「mdv」的所有結果都將歸為一組,以此類推。如果您依國家/地區和裝置進行分組,則「美國、平板電腦」的所有搜尋結果都會分組,以此類推。請參閱搜尋分析報表說明文件,進一步瞭解點擊次數、曝光次數等資料的計算方式和意義。

除非你按照日期分組,否則搜尋結果會依照日期遞增排序 (由新到舊,由新到舊)。如果兩個資料列之間相同,則排序順序可以任意決定。

請查看要求中的 rowLimit 屬性,瞭解可傳回的值數量上限。

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}
資源名稱 說明 附註
rows[] list 依查詢中的指定順序,按鍵值分組的資料列清單。
rows[].keys[] list 該列的維度值清單,根據要求中的維度按照要求指定順序分組。
rows[].clicks double 資料列的點擊次數。
rows[].impressions double 資料列的曝光次數。
rows[].ctr double 該列的點閱率 (CTR)。值的範圍介於 0 到 1.0 (含首尾)。
rows[].position double 搜尋結果中的平均排名。
responseAggregationType string 結果的匯總方式。請參閱說明文件,瞭解依網站和個別網頁計算資料的方式不同。

可接受的值為:
  • "auto"
  • byPage」:結果依網頁匯總。
  • byProperty」:結果是依資源匯總。

試試看!

您可以使用下方的 APIs Explorer,針對即時資料呼叫這個方法,然後查看回應。