API de informes: Informe de uso de los clientes

El Informe de uso de los clientes agrega información sobre el uso de los servicios de Google Workspace de todos los usuarios en todo un dominio. El informe de uso del usuario muestra la información de uso de los servicios de Google Workspace en toda tu cuenta. Esta información de uso se organiza por tipo de aplicación, que consta de parámetros específicos de esa aplicación. El período predeterminado y máximo de cada informe comprende los últimos 450 días.

Este informe de uso solo se puede utilizar para fines lícitos de acuerdo con el Acuerdo del Cliente. Además, estos se aplican a Google Workspace y Education.

Recuperar un informe de uso del cliente

Para recuperar el informe de las actividades de tu cuenta, usa la siguiente solicitud HTTP GET e incluye el token de autorización se describe en la documentación de autorización. Para mayor legibilidad, el siguiente ejemplo tiene un formato con resultados de líneas:

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

El valor dates es la fecha en que ocurrió el uso y la marca de tiempo está en formato ISO 8601, aaaa-mm-dd. Le recomendamos que utilice la zona horaria de su cuenta para realizar esta acción. Para obtener más información sobre las cadenas de consulta y las propiedades de la solicitud de la solicitud, consulta la Referencia de la API y la referencia de los parámetros del informe de uso de los clientes.

En el siguiente ejemplo, se obtiene un informe con el total de todos los accesos exitosos a tu cuenta en los últimos 30 días y una lista de aplicaciones autorizadas, con la cantidad de autorizaciones de usuario por aplicación, a partir del 03/03/2013. El maxResults La cadena de consulta muestra que este informe muestra dos eventos por página de informe:

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

Respuesta JSON para el informe de uso del cliente

{
 "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
      },
     ...
     ]
    }
   ]
  }
 ]
}