API de informes: Informe de uso de los usuarios

El informe de uso del usuario muestra la información de uso del servicio de Google Workspace de un usuario específico de tu dominio. Estos informes se pueden personalizar y filtrar para obtener información de uso específica. El período predeterminado y máximo de cada informe comprende los últimos 450 días.

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

Recuperar todas las actividades de uso del usuario

Para recuperar un informe de todas las actividades del usuario en 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 está formateado con líneas que muestran lo siguiente:

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

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. Si deseas obtener más información sobre los parámetros de la cadena de consulta y las propiedades de respuesta, consulta la Referencia de la API. Para obtener información sobre los parámetros del informe de uso del usuario, consulta la referencia de los parámetros de uso del usuario.

En el siguiente ejemplo, se obtiene un informe sobre todas las actividades del usuario de la cuenta.

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

En el siguiente ejemplo, se obtiene un informe sobre todas las actividades de los usuarios de una cuenta de cliente específica.

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

En el siguiente ejemplo, se obtiene un informe sobre las marcas de tiempo del último acceso de los usuarios en la cuenta. Para ver un ejemplo de una respuesta a la API, consulta el ejemplo de respuesta de JSON.

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

En el siguiente ejemplo, se obtiene un informe de las marcas de tiempo de acceso más reciente de los usuarios en la cuenta, filtrado por usuarios que accedieron después de un período específico. Para ver un ejemplo de una respuesta a la API, consulta el ejemplo de respuesta de 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"

En el siguiente ejemplo, se obtiene un informe de las marcas de tiempo de acceso más recientes y el estado de suspensión de los usuarios en la cuenta. Para ver un ejemplo de una respuesta a la API, consulta el ejemplo de respuesta de JSON.

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

Cómo recuperar las actividades de uso de un usuario específico

Para recuperar un informe de las actividades de un usuario específico en 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 está formateado con resultados de líneas.

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

El objeto userKey puede ser la dirección de correo electrónico principal del usuario en el informe o la profileId única de Google Workspace del usuario. 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. Si deseas obtener más información sobre los parámetros de la cadena de consulta y las propiedades de respuesta, consulta la Referencia de la API. Para obtener información sobre los parámetros del informe de uso del usuario, consulta la referencia de los parámetros de uso del usuario.

En el siguiente ejemplo, se obtiene el informe de uso para juan@example.com.

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

Ejemplo de respuesta JSON de informe de uso

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra un informe.

Respuesta JSON para el informe del usuario

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