Google Ads API 具有統一的屬性擷取和指標報表機制,可讓您使用 Google Ads 查詢語言建立查詢。這項功能可執行複雜的查詢,並傳回大量個別 Google Ads 帳戶的資料。
您可以使用 Search
或 SearchStream
方法建立查詢。這兩種方式支援相同的查詢,並傳回同等結果。Search
方法會以固定大小的頁面 (10,000 個資料列) 傳回資料,讓您使用分頁功能疊代結果集。舉例來說,在頻寬不足或網路不穩定的情況下,這項功能可將大型結果集分割成較小的回應,如果連線中斷,可以重新擷取。另一方面,SearchStream
方法會將整個結果集串流回單一回應,因此大量擷取資料時效率更高。
Search
和 SearchStream
都使用相同的網址:
https://googleads.googleapis.com/v20/customers/CUSTOMER_ID/googleAds
POST /v20/customers/CUSTOMER_ID/googleAds:search 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'" }
如果結果超過 10,000 列,回應中會傳回 nextPageToken
:
{ "results": [ // ... // ... // ... ], "nextPageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B", "fieldMask": "adGroupCriterion.keyword.text,adGroupCriterion.status" }
使用先前要求中的值重複相同的查詢並新增 pageToken
,即可擷取下一頁結果:
POST /v20/customers/CUSTOMER_ID/googleAds:search 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'", "pageToken": "CPii5aS87vfFTBAKGJvk36qpLiIWUW5SZk8xa1JPaXJVdXdIR05JUUpxZyoCVjMwADjUBkD___________8B" }
如要使用 SearchStream
方法,在單一串流回應中傳回所有結果,請將網址中的服務方法變更為 searchStream
(SearchStream
不需要 pageToken
):
POST /v20/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'" }