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 值。如果匯總細微程度為「每日」，頁面符記會是編碼日期 +「/」+ 指標名稱。如果匯總精細度為 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 使用的一組常用訊息類型。