Method: domains.trafficStats.list

列出所有可用日期的流量统计信息。如果用户无权访问网域的 TrafficStats，则返回 PERMISSION_DENIED。

HTTP 请求

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

我们要列出其流量统计信息的网域的资源名称。域名应为 domains/{domain_name}，其中 domain_name 是完全限定域名。

查询参数

参数
startDate

object (Date)

要检索的指标的最早日期（含）。必须同时指定 startDate 和 endDate，或两者都未指定。如果仅指定了 1 个参数，或者 endDate 的时间早于 startDate，则返回 INVALID_STRING。
endDate

object (Date)

要检索的指标的最近日期（不包含该日期）。必须同时指定 startDate 和 endDate，或同时未指定二者。如果仅指定了 1 个参数，或者 endDate 的时间早于 startDate，则返回 INVALID_STRING。
pageSize

integer

请求的页面大小。服务器返回的 TrafficStats 可能少于请求的 TrafficStats。如果未指定，服务器将选择合适的默认值。
pageToken

string

从上一个 List 请求返回的 nextPageToken 值（如果有）。这是上一次调用 trafficStats.list 方法后返回的 ListTrafficStatsResponse.next_page_token 值。

请求正文

请求正文必须为空。

响应正文

trafficStats.list 的响应消息。

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

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

object (TrafficStats)

TrafficStats 列表。
nextPageToken

string

用于检索下一页结果的令牌。如果列表中没有更多结果，则为空。

授权范围

需要以下 OAuth 作用域：

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

有关详情，请参阅授权指南。

日期

表示整个或部分日历日期，例如生日。一天中的时间和时区要么在别处指定，要么不重要。该日期相对于公历。它可以表示以下其中一项：

  • 包含非零年、月和日值的完整日期。
  • 月份和日期，年份为 0（例如周年纪念日）。
  • 单独的一年，零月零日。
  • 年份和月份，日期为零（例如信用卡失效日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须是 1 到 9999 之间的数字，如果使用 0，则可以指定不含年份的日期。
month

integer

一年中的某月。必须是 1 到 12 之间的数字，如果为 0，则表示不包含月份和日期。
day

integer

一个月中的第几天。必须是 1 到 31 之间的数字，并且对年份和月份有效，或者为 0 表示单独指定年份，或者在日期不重要的情况下指定年份和月份。