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 值。如果匯總細微程度為「每日」，頁面符記會是編碼日期 +「/」+ 指標名稱。如果匯總精細度為 OVERALL，頁面符記會是經過編碼的指標名稱。
aggregationGranularity

enum (AggregationGranularity)

(選用步驟) 匯總統計資料的精細程度。如未指定，預設值為 DAILY。

回應主體

如果成功，回應主體會包含 QueryDomainStatsResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。