返回与搜索流查询匹配的所有行。
抛出的错误的列表:AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
HTTP 请求
POST https://googleads.googleapis.com/v17/customers/{customerId}/googleAds:searchStream
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customerId |
必需。要查询的客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"query": string,
"summaryRowSetting": enum ( |
字段 | |
---|---|
query |
必需。查询字符串。 |
summaryRowSetting |
确定是否返回摘要行。默认情况下,系统不会返回摘要行。如果请求,则在返回所有其他查询结果后,摘要行将在响应中单独发送。 |
响应正文
GoogleAdsService.SearchStream
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "results": [ { object ( |
字段 | |
---|---|
results[] |
与查询匹配的行的列表。 |
fieldMask |
表示用户请求哪些字段的 FieldMask。 这是完全限定字段名称的逗号分隔列表。示例: |
summaryRow |
摘要行,包含结果中的指标摘要。指标摘要是指针对所有结果的指标汇总,此处的汇总可以是求和、平均值、比率等。 |
requestId |
用于调试的请求的唯一 ID。 |
queryResourceConsumption |
处理查询所消耗的资源量。摘要行和非摘要响应的 queryResourceConsumption 分别在各自的行中返回。非摘要响应的 queryResourceConsumption 将在最后一批结果中返回。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/adwords
如需了解详情,请参阅 OAuth 2.0 概览。