搜索和 SearchStream

视频:报告

Google Ads API 具有统一的属性检索和指标报告机制,可让您使用 Google Ads 查询语言创建查询。这样,您就可以执行复杂的查询,从而返回有关各个 Google Ads 账号的大量数据。

您可以使用 SearchSearchStream 方法创建查询。这两种方法支持相同的查询,并返回等效的结果。Search 方法会以固定大小(1 万行)的页面返回数据,以便您使用分页功能迭代结果集。在带宽较低或网络不可靠的情况下,这可能会很有用,例如,将大型结果集细分为较小的响应,以便在连接断开时重新提取。另一方面,SearchStream 方法会在单个响应中串流整个结果集,这对于批量数据检索而言可能更高效。

SearchSearchStream 都使用相同的基准网址:

    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 方法(该方法会在单个流式响应中返回所有结果),请将网址中的服务方法更改为 searchStreamSearchStream 不需要 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'"
}