Method: customers.searchAds360.search

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

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

请求正文

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

JSON 表示法 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
字段
query

string

必需。查询字符串。
pageToken

string

要检索的页面的令牌。如果未指定，则返回第一页结果。使用从上一个响应中的 nextPageToken 获取的值来请求下一页结果。
pageSize

integer

要在单个页面中检索的元素数量。如果请求的页面过大，服务器可能会决定进一步限制返回的资源数量。
validateOnly

boolean

如果为 true，则系统会验证请求，但不会执行该请求。
returnTotalResultsCount

boolean

如果为 true，则响应中将包含与查询匹配的结果的总数（忽略 LIMIT 子句）。默认值为 false。
summaryRowSetting

enum (SummaryRowSetting)

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

响应正文

SearchAds360Service.Search 的响应消息。

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

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

object (SearchAds360Row)

与查询匹配的行列表。
nextPageToken

string

用于检索下一页结果的分页令牌。将此字符串的内容作为下一个请求的 pageToken 属性传递。系统不会为最后一页返回 nextPageToken。
totalResultsCount

string (int64 format)

与查询匹配的结果的总数（忽略 LIMIT 子句）。
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)

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

授权范围

需要以下 OAuth 范围：

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