Method: customers.searchAds360.searchStream

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

抛出的错误列表:AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

HTTP 请求

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

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

请求正文

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

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

string

必需。查询字符串。

batchSize

integer

每个数据流响应批次中返回的行数。如果请求的批量大小过大,服务器可能会决定进一步限制返回的行数。

summaryRowSetting

enum (SummaryRowSetting)

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

响应正文

SearchAds360Service.SearchStream 的响应消息。

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

JSON 表示法
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
字段
results[]

object (SearchAds360Row)

与查询匹配的行的列表。

fieldMask

string (FieldMask format)

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

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

summaryRow

object (SearchAds360Row)

摘要行,其中包含结果中指标的摘要。指标摘要是指针对所有结果的指标汇总,此处的汇总可以是求和、平均值、比率等。

customColumnHeaders[]

object (CustomColumnHeader)

结果中自定义列的标题。

conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

结果中转化自定义指标的标题。

conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

结果中转化自定义维度的标题。

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

结果中原始事件转化指标的标头。

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

结果中原始事件转化维度的标头。

requestId

string

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

授权范围

需要以下 OAuth 范围:

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