Method: domains.domainStats.query

지정된 도메인 및 기간의 도메인 통계 목록을 가져옵니다. 도메인의 DomainStats에 액세스할 권한이 없는 경우 PERMISSION_DENIED를 반환합니다.

HTTP 요청

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

URL은 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 값입니다(있는 경우). 집계 세분성이 DAILY인 경우 페이지 토큰은 인코딩된 날짜 + '/' + 측정항목 이름이 됩니다. 집계 세분성이 OVERALL인 경우 페이지 토큰은 인코딩된 측정항목 이름입니다.
aggregationGranularity

enum (AggregationGranularity)

선택사항입니다. 통계를 집계할 세부사항입니다. 지정하지 않으면 기본값은 DAILY입니다.

응답 본문

성공한 경우 응답 본문에 QueryDomainStatsResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.