搜索和 SearchStream

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

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

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

    https://searchAds360.googleapis.com/v0/customers/CUSTOMER_ID/searchAds360

基于页面的搜索方法接受一个可选的 pageSize 参数,该参数用于限制单个 API 响应中返回的结果数量。

POST /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchAds360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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 /v0/customers/CUSTOMER_ID/searchAds360:search HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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 方法(该方法会在单个流式响应中返回所有结果),只需将网址中的服务方法更改为 searchStreamSearchStream 不需要 pageSizepageToken):

POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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'"
}