Method: accounts.reports.search

检索由搜索查询定义的报告。响应中包含的行数可能少于 pageSize 指定的行数。依赖 nextPageToken 来确定是否有更多行要请求。

HTTP 请求

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。发出调用的账号的 ID。必须是独立账号或 MCA 子账号。格式：accounts/{account}

请求正文

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

JSON 表示法 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
字段
query

string

必需。用于定义要检索的报告的查询。

如需详细了解如何构建查询，请参阅“查询语言”指南。如需查看可用表格和字段的完整列表，请参阅“可用字段”。
pageSize

integer

可选。要在单个页面中检索的 ReportRows 的数量。默认值为 1000。大于 5000 的值会强制转换为 5000。
pageToken

string

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

响应正文

ReportService.Search 方法的响应消息。

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

JSON 表示法 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
字段
results[]

object (ReportRow)

与搜索查询匹配的行。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

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

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