Method: domains.trafficStats.list

사용 가능한 모든 날짜의 트래픽 통계를 나열합니다. 사용자에게 도메인의 TrafficStats 액세스 권한이 없는 경우 PERMISSION_DENIED를 반환합니다.

HTTP 요청

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

트래픽 통계를 나열하려는 도메인의 리소스 이름입니다. domains/{domain_name} 형식이어야 하며 여기서 domain_name은 정규화된 도메인 이름입니다.

쿼리 매개변수

매개변수
startDate

object (Date)

검색할 측정항목의 최초 날짜(해당 날짜 포함)입니다. startDate 및 endDate를 모두 지정하거나 지정하지 않은 채로 두어야 합니다. 하나만 지정되거나 endDate가 startDate보다 빠른 경우 INVALID_ARGUMENT가 반환됩니다.

endDate

object (Date)

제외를 가져올 측정항목의 가장 최근 날짜입니다. startDate 및 endDate를 모두 지정하거나 지정하지 않은 채로 두어야 합니다. 하나만 지정되거나 endDate가 startDate보다 빠른 경우 INVALID_ARGUMENT가 반환됩니다.

pageSize

integer

요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 TrafficStats를 반환할 수 있습니다. 지정하지 않으면 서버에서 적절한 기본값을 선택합니다.

pageToken

string

이전 List 요청에서 반환된 nextPageToken 값입니다(있는 경우). 이전 trafficStats.list 메서드 호출에서 반환된 ListTrafficStatsResponse.next_page_token의 값입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

TrafficStats.list의 응답 메시지입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
필드
trafficStats[]

object (TrafficStats)

TrafficStats 목록입니다.

nextPageToken

string

결과의 다음 페이지를 검색하는 토큰이거나 목록에 더 이상 결과가 없으면 비어 있습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

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

날짜

생일과 같은 전체 또는 부분 달력 날짜를 나타냅니다. 시간과 시간대는 아무 곳으로 지정되거나 중요하지 않습니다. 날짜는 그레고리력을 기준으로 합니다. 이는 다음 중 하나를 나타낼 수 있습니다.

  • 연도, 월, 일 값이 0이 아닌 전체 날짜
  • 월과 일, 연도는 0(예: 기념일)
  • 연도만, 월과 일은 0
  • 연도와 월, 일은 0(예: 신용카드 만료일)

관련 유형:

JSON 표현
{
  "year": integer,
  "month": integer,
  "day": integer
}
필드
year

integer

날짜의 연도입니다. 1~9999 사이여야 하며, 연도 없이 날짜를 지정하려면 0이어야 합니다.

month

integer

연도의 월입니다. 1~12 사이여야 하며, 월과 일 없이 연도를 지정하려면 0이어야 합니다.

day

integer

월의 일입니다. 1~31 사이여야 하고 해당 연도 및 월에 유효해야 합니다. 또는 연도만 지정하거나 일이 중요하지 않아 연도와 월을 지정하려면 0이어야 합니다.