Method: userUsageReport.get

계정 사용자의 속성 및 통계 모음인 보고서를 검색합니다. 자세한 내용은 사용자 사용량 보고서 가이드를 참고하세요. 사용자 보고서의 매개변수에 대한 자세한 내용은 사용자 사용 매개변수 참조 가이드를 확인하세요.

HTTP 요청

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

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

경로 매개변수

매개변수
userKey or all

string

데이터를 필터링해야 하는 프로필 ID 또는 사용자 이메일을 나타냅니다. 모든 정보의 경우 all, 사용자의 고유한 Google Workspace 프로필 ID 또는 기본 이메일 주소의 경우 userKey일 수 있습니다. 삭제된 사용자가 아니어야 합니다. 삭제된 사용자의 경우 showDeleted=true를 사용하여 Directory API에서 users.list를 호출하고 반환된 ID를 userKey로 사용합니다.
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/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

관계 연산자는 다음과 같습니다.

  • == - '같음'.
  • <> - '같지 않음'. URL로 인코딩됩니다 (%3C%3E).
  • < - '미만'. URL로 인코딩됩니다 (%3C).
  • <= - '이하'. URL로 인코딩됩니다 (%3C=).
  • > - '초과'. URL로 인코딩됩니다 (%3E).
  • >= - '보다 크거나 같음'. URL로 인코딩됩니다 (%3E=).
maxResults

integer (uint32 format)

각 응답 페이지에 표시되는 활동 기록 수를 결정합니다. 예를 들어 요청에서 maxResults=1를 설정하고 보고서에 두 개의 활동이 있는 경우 보고서에는 두 개의 페이지가 포함됩니다. 응답의 nextPageToken 속성에 두 번째 페이지에 대한 토큰이 있습니다.
maxResults 쿼리 문자열은 선택사항입니다.
orgUnitID

string

보고할 조직 단위의 ID입니다. 사용자 활동은 지정된 조직 단위에 속한 사용자의 경우에만 표시됩니다.

pageToken

string

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

string

parameters 쿼리 문자열은 보고서 결과를 미세 조정하는 쉼표로 구분된 이벤트 매개변수 목록입니다. 매개변수는 특정 애플리케이션과 연결됩니다. 고객 사용 보고서의 애플리케이션 값에는 accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, sites이 포함됩니다.
parameters 쿼리 문자열은 app_name1:param_name1, app_name2:param_name2의 CSV 형식입니다.

groupIdFilter

string

사용자 활동이 필터링되는 쉼표로 구분된 그룹 ID (난독화)입니다. 즉, 응답은 여기에 언급된 그룹 ID 중 하나 이상에 속하는 사용자의 활동만 포함합니다. 형식: 'id:abc123,id:xyz456'

요청 본문

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

응답 본문

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

승인 범위

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

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

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