Reports API: 사용자 사용량 보고서

사용자 사용량 보고서에는 도메인 내 특정 사용자의 Google Workspace 서비스 사용 정보가 반환됩니다. 이러한 보고서는 특정 사용 정보로 맞춤설정하고 필터링할 수 있습니다. 각 보고서의 기본 기간 및 최대 기간은 최근 450일입니다.

이러한 사용자 사용 보고서는 고객 계약에 따라 합법적인 목적으로만 사용할 수 있습니다. 이 보고서는 Google Workspace 및 Education에 적용됩니다.

모든 사용자 사용 활동 검색

계정의 모든 사용자 활동 보고서를 검색하려면 다음 GET HTTP 요청을 사용하고 승인 문서에 설명된 승인 토큰을 포함합니다. 다음 예는 가독성을 위해 라인 반환 형식을 사용합니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

dates 값은 사용량이 발생한 날짜이며 타임스탬프는 ISO 8601 형식(yyyy-mm-dd)입니다. 쿼리 문자열 매개변수 및 응답 속성에 대한 자세한 내용은 API 참조를 확인하세요. 사용자 사용량 보고서 매개변수에 대한 자세한 내용은 사용자 사용량 매개변수 참조를 참고하세요.

다음 예는 계정의 모든 사용자 활동에 대한 보고서를 가져옵니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

다음 예는 특정 고객 계정의 모든 사용자 활동에 대한 보고서를 가져옵니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

다음 예에서는 계정 사용자의 마지막 로그인 타임스탬프에 대한 보고서를 가져옵니다. API 응답의 예는 JSON 응답 예를 참조하세요.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

다음 예에서는 특정 시간 이후에 로그인한 사용자로 필터링된 계정 사용자의 마지막 로그인 타임스탬프에 대한 보고서를 가져옵니다. API 응답의 예는 JSON 응답 예를 참조하세요.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

다음 예에서는 계정 사용자의 마지막 로그인 타임스탬프 및 정지된 상태에 대한 보고서를 가져옵니다. API 응답의 예는 JSON 응답 예를 참조하세요.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

특정 사용자의 사용 활동 검색

계정에서 특정 사용자의 활동 보고서를 검색하려면 다음 GET HTTP 요청을 사용하고 승인 문서에 설명된 승인 토큰을 포함합니다. 다음 예는 가독성을 위해 라인 반환 형식을 사용합니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

userKey은 보고서에 포함된 사용자의 기본 이메일 주소 또는 사용자의 고유한 Google Workspace profileId일 수 있습니다. dates 값은 사용량이 발생한 날짜이며 타임스탬프는 ISO 8601 형식(yyyy-mm-dd)입니다. 쿼리 문자열 매개변수 및 응답 속성에 대한 자세한 내용은 API 참조를 확인하세요. 사용자 사용량 보고서 매개변수에 대한 자세한 내용은 사용자 사용량 매개변수 참조를 참고하세요.

다음 예는 john@example.com의 사용량 보고서를 가져옵니다.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

사용량 보고서 예시 JSON 응답

성공적인 응답은 HTTP 200 상태 코드를 반환합니다. 응답은 상태 코드와 함께 보고서를 반환합니다.

사용자 보고서에 대한 JSON 응답

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
{
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}