Google Ads API 提供統一的屬性擷取和指標報表機制,可讓您使用 Google Ads 查詢語言建立查詢。這麼做可執行複雜的查詢,傳回個別 Google Ads 帳戶的大量資料。
您可以使用 Search
或 SearchStream
方法建立查詢。這兩種方法都支援相同的查詢,並傳回相同的結果。Search
方法會以 10,000 列的固定大小頁面傳回資料,讓您可以使用分頁功能逐一處理結果集。在頻寬較低或網路狀況不穩定的情況下,這可能會帶來優勢,例如將大型結果集區分割成較小的回應,以便在連線中斷時重新擷取。另一方面,SearchStream
方法會將整個結果串流傳回單一回應,這可能會更有效率地擷取大量資料。
Search
和 SearchStream
都使用相同的基本網址:
https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds
POST /v18/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 /v18/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 /v18/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'" }