Reports API: 고객 사용 보고서

고객 사용 보고서 전체 도메인에서 모든 사용자의 Google Workspace 서비스 사용 정보를 집계합니다. 사용자 사용량 보고서는 계정 전반의 Google Workspace 서비스 사용량 정보를 반환합니다. 이러한 사용 정보는 애플리케이션 유형별로 구성되며, 유형별로 해당 애플리케이션과 관련된 매개변수로 구성됩니다. 각 보고서의 기본 및 최대 기간은 최근 450일입니다.

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

고객 사용량 보고서 가져오기

계정 활동 보고서를 가져오려면 다음 GET HTTP 요청을 사용하고 승인 토큰을 포함하세요. 자세한 내용은 승인 문서에 설명되어 있습니다. 가독성을 위해 다음 예는 줄 반환으로 형식이 지정됩니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

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

다음 예는 지난 30일 동안 계정에 성공한 모든 로그인의 총 횟수와 목록이 포함된 보고서를 가져옵니다. 2013년 3월 3일부터 애플리케이션별 사용자 승인 수가 포함된 승인된 애플리케이션의 수 maxResults 쿼리 문자열은 이 보고서가 보고서 페이지당 2개의 이벤트를 반환함을 보여줍니다.

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

고객 사용량 보고서에 대한 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": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}