Method: domains.domainStats.query

检索指定网域和时间段的网域统计信息列表。如果您无权访问网域的 DomainStats，则返回 PERMISSION_DENIED。

HTTP 请求

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

请求正文

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

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

object (MetricDefinition)

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

object (TimeQuery)

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

integer

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

string

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

enum (AggregationGranularity)

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

响应正文

如果成功，则响应正文包含一个 QueryDomainStatsResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

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