Google Ads API 提供統一的屬性擷取和指標報表機制,可讓您使用 Google Ads 查詢語言建立查詢。這可讓複雜的查詢傳回個別 Google Ads 帳戶的大量資料。
您可以使用 Search
或 SearchStream
方法建立查詢。這兩種方法都支援相同的查詢,並傳回相等的結果。Search
方法會以可自訂的網頁大小傳回資料,讓您可以使用分頁對結果集進行疊代作業。這在低頻寬或不穩定網路狀況下可帶來優勢,例如將大型結果組合成較小的回應,以便在連線遺失時重新擷取。另一方面,SearchStream
方法會將整個結果集串流回單一回應中,這對於大量資料擷取更有效率。
Search
和 SearchStream
都會使用相同的基準網址:
https://googleads.googleapis.com/v16/customers/CUSTOMER_ID/googleAds
頁面式搜尋方法使用選用的 pageSize
參數,可限制單一 API 回應傳回的結果數量。
POST /v16/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "pageSize": 10000, "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }
如果結果中有超過 pageSize
的資料列,系統會在回應中傳回 nextPageToken
:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
使用上述值加入 pageToken
重複相同的查詢,會擷取下一頁的結果:
POST /v16/customers/CUSTOMER_ID/googleAds:search HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "pageSize": 10000, "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'", "pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B" }
如要使用 SearchStream
方法,以便在單一串流回應中傳回所有結果,只要將網址中的服務方法變更為 searchStream
即可 (SearchStream
不必要求 pageSize
和 pageToken
):
POST /v16/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1 Host: googleads.googleapis.com Content-Type: application/json Authorization: Bearer ACCESS_TOKEN developer-token: DEVELOPER_TOKEN { "query": "SELECT ad_group_criterion.keyword.text, ad_group_criterion.status FROM ad_group_criterion WHERE ad_group_criterion.type = 'KEYWORD' AND ad_group_criterion.status = 'ENABLED'" }