API de informes: Informe de uso de los clientes

En el informe de uso de los clientes, se agrega la información de uso del servicio de Google Workspace para todos los usuarios en un dominio completo. En el informe de uso del usuario, se muestra información de uso del servicio de Google Workspace en tu cuenta. Esta información de uso está organizada por tipo de aplicación, que se compone 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.

Estos informes de uso se pueden utilizar únicamente con fines legales de acuerdo con su Acuerdo de cliente. Además, estos informes se aplican a Google Workspace y Education.

Recuperar un informe de uso de los clientes

Para recuperar el informe de las actividades de tu cuenta, usa la siguiente solicitud HTTP GET e incluye el token de autorización descrito en la documentación de autorización. Para facilitar la lectura, el siguiente ejemplo tiene formato con saltos de línea:

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 se produjo el uso y la marca de tiempo está en formato ISO 8601, aaaa-mm-dd. Para ello, te recomendamos que uses la zona horaria de tu cuenta. Para obtener más información sobre las strings de consulta y las propiedades de respuesta de la solicitud, consulta la Referencia de la API y la referencia de los parámetros del informe de uso del cliente.

El siguiente ejemplo recibe un informe con la cantidad total de 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 3 de marzo de 2013. La string de consulta maxResults 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
      },
     ...
     ]
    }
   ]
  }
 ]
}