Method: entityUsageReports.get

계정 내에서 사용자가 사용하는 항목의 속성과 통계 모음인 보고서를 가져옵니다. 자세한 내용은 항목 사용량 보고서 가이드를 참고하세요. 항목 보고서의 매개변수에 대한 자세한 내용은 항목 사용량 매개변수 참조 가이드를 참고하세요.

HTTP 요청

GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}

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

경로 매개변수

매개변수
entityType

enum (EntityType)

보고서의 항목 유형을 나타냅니다.
entityKey

string

데이터를 필터링할 객체의 키를 나타냅니다. all 값을 사용하여 모든 사용자의 활동 이벤트를 가져오거나 앱별 항목의 다른 값을 가져올 수 있는 문자열입니다. 특정 entityType의 entityKey를 가져오는 방법에 관한 자세한 내용은 항목 사용량 매개변수 참조 가이드를 참고하세요.
date

string

UTC-8:00 (태평양 표준시)을 기준으로 사용이 발생한 날짜를 나타냅니다. 타임스탬프는 ISO 8601 형식(yyyy-mm-dd)입니다.

쿼리 매개변수

매개변수
customerId

string

데이터를 검색할 고객의 고유 ID입니다.
filters

string

filters 쿼리 문자열은 애플리케이션의 이벤트 매개변수 목록으로, 쉼표로 구분되며 매개변수 값이 관계 연산자로 조작됩니다. filters 쿼리 문자열에는 보고서에 사용량이 반환되는 애플리케이션의 이름이 포함됩니다. 항목 사용 보고서의 애플리케이션 값에는 accounts, docs, gmail가 포함됩니다.

필터는 [application name]:[parameter name][relational operator][parameter value],... 형식입니다.

이 예에서 <> '같지 않음' 연산자는 요청의 쿼리 문자열 (%3C%3E)에 URL 인코딩됩니다. 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

관계 연산자에는 다음이 포함됩니다.

  • == - '같음'.
  • <> - '같지 않음'. URL로 인코딩됩니다 (%3C%3E).
  • < - '보다 작음'. URL로 인코딩됩니다 (%3C).
  • <= - '작거나 같음' URL로 인코딩됩니다 (%3C=).
  • > - '보다 큼'. URL로 인코딩됩니다 (%3E).
  • >= - '크거나 같음' URL로 인코딩됩니다 (%3E=).
필터는 숫자 매개변수에만 적용할 수 있습니다.
maxResults

integer (uint32 format)

각 응답 페이지에 표시되는 활동 레코드 수를 결정합니다. 예를 들어 요청에서 <span>maxResults=1</span>를 설정하고 보고서에 활동이 두 개 있는 경우 보고서에는 페이지가 두 개 있습니다. 응답의 <span>nextPageToken</span> 속성에는 두 번째 페이지의 토큰이 있습니다.
pageToken

string

다음 페이지를 지정하는 토큰입니다. 페이지가 여러 개인 보고서의 응답에는 nextPageToken 속성이 있습니다. 보고서의 다음 페이지를 가져오는 후속 요청에서 pageToken 쿼리 문자열에 nextPageToken 값을 입력합니다.
parameters

string

parameters 쿼리 문자열은 보고서 결과를 세분화하는 쉼표로 구분된 이벤트 매개변수 목록입니다. 매개변수는 특정 애플리케이션과 연결됩니다. 항목 사용 보고서의 애플리케이션 값은 gplus뿐입니다.
parameter 쿼리 문자열은 [app_name1:param_name1], [app_name2:param_name2]...의 CSV 형식입니다.

요청 본문

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

응답 본문

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

승인 범위

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

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

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

EntityType

열거형
gplus_communities Google+ 커뮤니티에 대한 보고서를 반환합니다.