Method: userUsageReport.get

Recupera un informe, que es una colección de propiedades y estadísticas para un conjunto de usuarios de la cuenta. Para obtener más información, consulta la guía del Informe de uso del usuario. Para obtener más información sobre los parámetros del informe de usuarios, consulta las guías de referencia de Parámetros de uso de los usuarios.

Solicitud HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
userKey or all

string

Representa el ID de perfil o el correo electrónico del usuario para el que se deben filtrar los datos. Puede ser all para toda la información, o userKey para el ID de perfil único de Google Workspace de un usuario o su dirección de correo electrónico principal. No debe ser un usuario borrado. Para un usuario borrado, llama a users.list en la API de Directory con showDeleted=true y, luego, usa el ID que se muestra como userKey.
date

string

Representa la fecha en la que se produjo el uso, según UTC-8:00 (hora estándar del Pacífico). La marca de tiempo tiene el formato ISO 8601, yyyy-mm-dd.

Parámetros de consulta

Parámetros
customerId

string

El ID único del cliente para el que se recuperan los datos.
filters

string

La cadena de consulta filters es una lista separada por comas de los parámetros de eventos de una aplicación, en la que un operador relacional manipula el valor del parámetro. La cadena de consulta filters incluye el nombre de la aplicación cuyo uso se muestra en el informe. Los valores de la aplicación para el Informe de uso de los usuarios incluyen accounts, docs y gmail.

Los filtros tienen el formato [application name]:[parameter name][relational operator][parameter value],....

En este ejemplo, el operador <> “no igual a” está codificado en formato de URL en la cadena de consulta de la solicitud (%3C%3E): 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

Los operadores relacionales incluyen lo siguiente:

  • ==: "igual a".
  • <>: "no es igual a". Está codificada en formato URL (%3C%3E).
  • <: "menor que". Está codificada en URL (%3C).
  • <=: "menor que o igual a". Está codificada como URL (%3C=).
  • >: "mayor que". Está codificada en URL (%3E).
  • >=: "mayor que o igual a". Está codificada como URL (%3E=).
maxResults

integer (uint32 format)

Determina cuántos registros de actividad se muestran en cada página de respuesta. Por ejemplo, si la solicitud establece maxResults=1 y el informe tiene dos actividades, el informe tendrá dos páginas. La propiedad nextPageToken de la respuesta tiene el token de la segunda página.
La cadena de consulta maxResults es opcional.
orgUnitID

string

ID de la unidad organizativa sobre la que se informará. La actividad del usuario solo se mostrará a los usuarios que pertenezcan a la unidad organizativa especificada.

pageToken

string

Token para especificar la página siguiente. Un informe con varias páginas tiene una propiedad nextPageToken en la respuesta. En tu solicitud de seguimiento que obtenga la siguiente página del informe, ingresa el valor nextPageToken en la cadena de consulta pageToken.
parameters

string

La cadena de consulta parameters es una lista de parámetros de eventos separada por comas que define mejor los resultados de un informe. El parámetro está asociado con una aplicación específica. Los valores de la aplicación para el informe de uso de los clientes incluyen accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet y sites.
Una cadena de consulta parameters está en formato CSV de app_name1:param_name1, app_name2:param_name2.

groupIdFilter

string

Son los IDs de grupo separados por comas (ofuscados) en los que se filtran las actividades del usuario; es decir, la respuesta contendrá actividades solo para los usuarios que forman parte de al menos uno de los IDs de grupo mencionados aquí. Formato: “id:abc123,id:xyz456”

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de UsageReports.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Para obtener más información, consulta la guía de autorización.