Method: domains.domainStats.query

Truy xuất danh sách số liệu thống kê về miền cho một miền và khoảng thời gian nhất định. Trả về PERMISSION_DENIED nếu bạn không có quyền truy cập vào DomainStats cho miền.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tên tài nguyên mẹ nơi các số liệu thống kê được truy vấn. Định dạng: domains/{domain}

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Trường
metricDefinitions[]

object (MetricDefinition)

Bắt buộc. Các chỉ số cụ thể cần truy vấn. Bạn có thể xác định tên tuỳ chỉnh cho từng chỉ số. Tên này sẽ được dùng trong phản hồi.
timeQuery

object (TimeQuery)

Bắt buộc. Phạm vi thời gian hoặc ngày cụ thể mà bạn muốn truy xuất các chỉ số.
pageSize

integer

Không bắt buộc. Số lượng tối đa tài nguyên DomainStats cần trả về trong phản hồi. Máy chủ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, hệ thống sẽ sử dụng giá trị mặc định là 10. Giá trị tối đa là 200.
pageToken

string

Không bắt buộc. Giá trị nextPageToken được trả về từ một yêu cầu List trước đó (nếu có). Nếu mức độ chi tiết của hoạt động tổng hợp là HÀNG NGÀY, thì mã thông báo trang sẽ là ngày được mã hoá + "/" + tên chỉ số. Nếu độ chi tiết của hoạt động tổng hợp là OVERALL, thì mã thông báo trang sẽ là tên chỉ số được mã hoá.
aggregationGranularity

enum (AggregationGranularity)

Không bắt buộc. Mức độ chi tiết để tổng hợp số liệu thống kê. Nếu bạn không chỉ định, giá trị mặc định sẽ là DAILY.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của QueryDomainStatsResponse.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.