需要授權
使用您定義的篩選器和參數,查詢搜尋聯播網流量資料。這個方法會傳回零或多個資料列,並依您定義的資料列索引鍵 (維度) 分組。您必須定義一或多天的日期範圍。
如果日期是其中一個維度,結果清單會省略沒有資料的日期。如要瞭解哪些日期有資料,請針對感興趣的日期範圍,發出不含篩選條件的查詢,並依日期分組。
結果會依點擊次數遞減排序。如果兩列的點擊次數相同,則會隨機排序。
如要瞭解如何呼叫這個方法,請參閱 Python 範例。
API 受到 Search Console 的內部限制,不保證會傳回所有資料列,而是傳回熱門資料列。
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
}
],
"filterLists": [
{
"dimension": string,
"expressions": [
string
]
}
]
}
],
"aggregationType": string,
"rowLimit": integer,
"startRow": integer
}| 屬性名稱 | 值 | 說明 | 附註 |
|---|---|---|---|
startDate |
string |
[必填] 所需日期範圍的開始日期,格式為 YYYY-MM-DD,時區為太平洋時間 (UTC - 7:00/8:00)。必須早於或等於結束日期。這個值包含在範圍內。 | |
endDate |
string |
[必填] 所要求日期範圍的結束日期,格式為 YYYY-MM-DD,時間為太平洋時間 (UTC - 7:00/8:00)。必須大於或等於開始日期。這個值包含在範圍內。 | |
dimensions[] |
list |
[選用] 零或多個維度,用於將結果分組。結果會按照您提供這些維度的順序分組。您可以使用 dimensionFilterGroups[].filters[].dimension 中的任何維度名稱,以及「date」和「hour」。系統會合併分組維度值,為每個結果列建立專屬鍵。如未指定維度,所有值都會合併為單一資料列。可分組的維度數量沒有限制,但無法依相同維度分組兩次。範例:[country, device] | |
searchType |
string |
已淘汰,請改用 type
|
|
type |
string |
[選用] 將結果篩選為下列類型:
|
|
dimensionFilterGroups[] |
list |
[選用] 零或多組篩選器,用於套用至維度群組值。所有篩選器群組都必須相符,系統才會在回應中傳回資料列。在單一篩選器群組中,您可以指定是否必須符合所有篩選器,或至少符合一個篩選器。 | |
dimensionFilterGroups[].groupType |
string |
這個群組中的所有篩選器是否都必須傳回 true (「and」),或一或多個篩選器必須傳回 true (尚不支援)。
可接受的值如下:
|
|
dimensionFilterGroups[].filters[] |
list |
[選用] 零或多個要對資料列測試的篩選器。每個篩選器都包含維度名稱、運算子和值。長度上限為 4096 個字元。範例:country equals FRA query contains mobile use device notContains tablet |
|
dimensionFilterGroups[].filters[].dimension |
string |
要套用這項篩選條件的維度。您可以依這裡列出的任何維度進行篩選,即使您並未依該維度分組也沒問題。
可接受的值如下:
|
|
dimensionFilterGroups[].filters[].operator |
string |
[選用] 指定的值必須與資料列的維度值相符 (或不相符)。
可接受的值如下: |
|
dimensionFilterGroups[].filters[].expression |
string |
篩選器要比對或排除的值,取決於運算子。 | |
dimensionFilterGroups[].filterLists[] |
list |
[選用] 零或多個多值維度篩選器,用於測試資料列。
filters[] 只能比對每個項目的單一值,filterLists[] 則可比對單一維度的多個完全比對值。如果資料列的指定 dimension 值等於任何提供的 expressions,則該資料列與篩選器清單相符。請注意,單一要求無法同時在 filters 和 filterLists 中篩選相同維度。 |
|
dimensionFilterGroups[].filterLists[].dimension |
string |
[必要] 套用這份篩選器清單的維度。
可接受的值如下:
|
|
dimensionFilterGroups[].filterLists[].expressions[] |
list |
[必要] 要篩選的值清單 (string)。 |
|
aggregationType |
string |
[選用] 資料匯總方式。如果依資源匯總,系統會匯總相同資源的所有資料;如果依網頁匯總,系統會依標準 URI 匯總所有資料。如果依網頁篩選或分組,請選擇「自動」;否則,您可以依資源或網頁匯總,具體取決於您希望如何計算資料;請參閱說明文件,瞭解依網站和依網頁計算資料的方式有何不同。 注意: 如果依網頁分組或篩選,就無法依資源匯總。 如果指定 auto 以外的值,結果中的匯總類型會與要求的類型相符;如果要求的類型無效,則會收到錯誤訊息。如果要求的類型無效,API 絕不會變更匯總類型。 可接受的值如下:
|
|
rowLimit |
integer |
[選用;有效範圍為 1 至 25,000;預設值為 1,000] 要傳回的資料列數量上限。如要逐頁瀏覽結果,請使用 startRow 偏移值。 |
|
startRow |
integer |
[選用;預設值為 0] 回應中第一列的索引 (從零開始)。必須為非負數。如果 startRow 超過查詢結果數量,系統會傳回成功回應,但資料列數為零。 |
|
dataState |
string |
[選用] 如果是「all」(不區分大小寫),資料會包含最新資料。如果設為「final」(不區分大小寫) 或省略這個參數,傳回的資料只會包含最終資料。 如果設為「hourly_all」(不區分大小寫),資料會包含每小時細目。這表示每小時資料包含部分資料,且應在依 HOUR API 維度分組時使用。 |
回應
結果會依要求中指定的維度分組。具有相同維度值組合的所有值都會分組到同一列。舉例來說,如果依國家/地區維度分組,系統會將「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 |
該列的點閱率。值必須介於 0 到 1.0 (含)。 | |
rows[].position |
double |
搜尋結果中的平均排名。 | |
responseAggregationType |
string |
結果匯總方式。請參閱說明文件,瞭解依網站和依網頁計算資料的方式有何不同。
可接受的值如下:
|
|
metadata |
object |
可能與查詢結果一併傳回的物件,提供資料狀態的相關背景資訊。 當您要求近期資料 (使用 這個物件中提供的所有日期和時間都採用 這個物件中傳回的特定欄位,取決於您在要求中將資料分組的方式:
|
試試看!
使用下方的 APIs Explorer,對即時資料呼叫這個方法,並查看回應。