Method: domainStats.batchQuery

Thực thi một loạt yêu cầu QueryDomainStats cho nhiều miền. Trả về PERMISSION_DENIED nếu bạn không có quyền truy cập vào DomainStats cho bất kỳ miền nào được yêu cầu.

Yêu cầu HTTP

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

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

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 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Trường
requests[]

object (QueryDomainStatsRequest)

Bắt buộc. Danh sách các yêu cầu truy vấn riêng lẻ. Mỗi yêu cầu có thể dành cho một miền khác nhau. Bạn có thể đưa tối đa 100 yêu cầu vào một lô.

Nội dung phản hồi

Thông báo phản hồi cho domainStats.batchQuery.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Trường
results[]

object (BatchQueryDomainStatsResult)

Danh sách các phản hồi, mỗi phản hồi cho một truy vấn trong BatchQueryDomainStatsRequest. Thứ tự của các phản hồi sẽ tương ứng với thứ tự của các yêu cầu.

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.

QueryDomainStatsRequest

Thông báo yêu cầu cho QueryDomainStats.

Biểu diễn dưới dạng JSON 
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Trường
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}
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.

BatchQueryDomainStatsResult

Biểu thị kết quả của một QueryDomainStatsRequest duy nhất trong một lô.

Biểu diễn dưới dạng 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.
}
Trường
Trường nhóm result. Kết quả của từng truy vấn. result chỉ có thể là một trong những trạng thái sau:
response

object (QueryDomainStatsResponse)

Phản hồi thành công cho truy vấn riêng lẻ.
error

object (Status)

Trạng thái lỗi nếu truy vấn riêng lẻ không thành công.

Trạng thái

Loại Status xác định một mô hình lỗi logic phù hợp với nhiều môi trường lập trình, trong đó có API REST và API RPC. gRPC sử dụng loại này. Mỗi thông báo Status chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và thông tin cụ thể về lỗi.

Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách xử lý mô hình này trong Hướng dẫn thiết kế API.

Biểu diễn dưới dạng JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Trường
code

integer

Mã trạng thái, phải là giá trị enum của google.rpc.Code.
message

string

Thông báo lỗi dành cho nhà phát triển, phải bằng tiếng Anh. Mọi thông báo lỗi mà người dùng thấy đều phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng khách bản địa hoá.
details[]

object

Danh sách các thông báo chứa thông tin cụ thể về lỗi. Có một nhóm gồm nhiều loại thông báo chung để API sử dụng.