Method: domainStats.batchQuery

複数のドメインに対して QueryDomainStats リクエストのバッチを実行します。リクエストされたドメインのいずれかについて DomainStats にアクセスする権限がない場合は、PERMISSION_DENIED を返します。

HTTP リクエスト

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

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
フィールド
requests[]

object (QueryDomainStatsRequest)

必須。個々のクエリ リクエストのリスト。リクエストごとに異なるドメインを指定できます。1 つのバッチに含めることができるリクエストは最大 100 個です。

レスポンスの本文

domainStats.batchQuery のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
フィールド
results[]

object (BatchQueryDomainStatsResult)

レスポンスのリスト。BatchQueryDomainStatsRequest の各クエリに 1 つのレスポンスがあります。レスポンスの順序はリクエストの順序に対応します。

認可スコープ

次の 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 値（存在する場合）。集計の粒度が DAILY の場合、ページトークンはエンコードされた日付 + 「/」 + 指標名になります。集計の粒度が 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 メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと使い方について詳しくは、API 設計ガイドをご覧ください。

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。