Method: customers.googleAds.searchStream

返回与搜索串流查询匹配的所有行。

抛出的错误列表：AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP 请求

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

必需。要查询的客户的 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
字段
query

string

必需。查询字符串。
summaryRowSetting

enum (SummaryRowSetting)

确定是否会返回摘要行。默认情况下，系统不会返回摘要行。如果请求，系统会在返回所有其他查询结果后单独在响应中发送摘要行。

响应正文

GoogleAdsService.SearchStream 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
字段
results[]

object (GoogleAdsRow)

与查询匹配的行列表。
fieldMask

string (FieldMask format)

表示用户请求了哪些字段的 FieldMask。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。
summaryRow

object (GoogleAdsRow)

摘要行，其中包含结果中指标的摘要。指标摘要是指对所有结果中的指标进行汇总，汇总方式可以是求和、平均值、比率等。
requestId

string

请求的唯一 ID，用于调试目的。
queryResourceConsumption

string (int64 format)

用于处理查询的资源用量。摘要行和非摘要响应的 queryResourceConsumption 分别在各自的行中返回。非摘要响应的 queryResourceConsumption 会在最终批次结果中返回。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/adwords

如需了解详情，请参阅 OAuth 2.0 Overview。

SummaryRowSetting

用于描述退货摘要行设置的枚举。

枚举
UNSPECIFIED 未指定。
UNKNOWN 表示退货明细行的未知值。
NO_SUMMARY_ROW 不返回摘要行。
SUMMARY_ROW_WITH_RESULTS 返回摘要行以及结果。摘要行将仅在最后一批中返回（最后一批将不包含任何结果）。
SUMMARY_ROW_ONLY 仅返回摘要行，不返回任何结果。