Method: domains.domainStats.query

指定したドメインと期間のドメイン統計情報のリストを取得します。ドメインの DomainStats にアクセスする権限がない場合は、PERMISSION_DENIED を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 値（存在する場合）。集計の粒度が DAILY の場合、ページトークンはエンコードされた日付 + 「/」 + 指標名になります。集計の粒度が OVERALL の場合、ページトークンはエンコードされた指標名になります。
aggregationGranularity

enum (AggregationGranularity)

省略可。統計情報を集計する粒度。指定しない場合、デフォルトは DAILY です。

レスポンスの本文

成功した場合、レスポンスの本文には QueryDomainStatsResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、承認ガイドをご覧ください。