Method: domainStats.batchQuery

여러 도메인에 대한 QueryDomainStats 요청 배치를 실행합니다. 요청된 도메인 중 하나라도 DomainStats에 액세스할 권한이 없으면 PERMISSION_DENIED를 반환합니다.

HTTP 요청

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

URL은 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 값입니다(있는 경우). 집계 세분성이 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에서 사용할 일반적인 메시지 유형 집합이 있습니다.