Method: domainStats.batchQuery

针对多个网域执行一批 QueryDomainStats 请求。如果您无权访问任何所请求网域的 DomainStats，则返回 PERMISSION_DENIED。

HTTP 请求

POST https://gmailpostmastertools.googleapis.com/v2beta/domainStats:batchQuery

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
字段
requests[]

object (QueryDomainStatsRequest)

必需。各个查询请求的列表。每个请求可以针对不同的网域。单个批次中最多可包含 100 个请求。

响应正文

针对 domainStats.batchQuery 的响应消息。

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

JSON 表示法 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
字段
results[]

object (BatchQueryDomainStatsResult)

响应列表，BatchQueryDomainStatsRequest 中的每个查询对应一个响应。响应的顺序将与请求的顺序一致。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

如需了解详情，请参阅授权指南。

QueryDomainStatsRequest

针对 QueryDomainStats 的请求消息。

JSON 表示法 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
字段
parent

string

必需。查询统计信息的父级资源名称。格式：domains/{domain}
metricDefinitions[]

object (MetricDefinition)

必需。要查询的具体指标。您可以为每个指标定义自定义名称，该名称将用于响应中。
timeQuery

object (TimeQuery)

必需。要检索指标的时间范围或具体日期。
pageSize

integer

可选。响应中要返回的 DomainStats 资源数量上限。服务器返回的值可能小于此值。如果未指定，则使用默认值 10。最大值为 200。
pageToken

string

可选。从上一个 List 请求返回的 nextPageToken 值（如果有）。如果聚合粒度为 DAILY，则网页令牌将是编码后的日期 +“/”+ 指标名称。如果聚合粒度为 OVERALL，则网页令牌将是编码后的指标名称。
aggregationGranularity

enum (AggregationGranularity)

可选。用于汇总统计信息的粒度。如果未指定，则默认为 DAILY。

BatchQueryDomainStatsResult

表示批处理中单个 QueryDomainStatsRequest 的结果。

JSON 表示法 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
字段
联合字段 result。各个查询的结果。result 只能是下列其中一项：
response

object (QueryDomainStatsResponse)

单个查询的成功响应。
error

object (Status)

相应查询失败时的错误状态。

状态

Status 类型定义了适用于不同编程环境（包括 REST API 和 RPC API）的逻辑错误模型。此类型供 gRPC 使用。每条 Status 消息包含三部分数据：错误代码、错误消息和错误详细信息。

如需详细了解该错误模型及其使用方法，请参阅 API 设计指南。

JSON 表示法 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
字段
code

integer

状态代码，应为 google.rpc.Code 的枚举值。
message

string

面向开发者的错误消息（应采用英语）。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送，或者由客户端进行本地化。
details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。