搜索和 SearchStream

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

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

Search 和 SearchStream 都使用相同的基本网址:

    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 方法(该方法会在单个流式响应中返回所有结果),只需将网址中的服务方法更改为 searchStream(SearchStream 不需要 pageSize 和 pageToken):

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'"
}