Method: entityUsageReports.get

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

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
entityType

enum (EntityType)

Representa el tipo de entidad del informe.
entityKey

string

Representa la clave del objeto con la que se filtrarán los datos. Es una cadena que puede tomar el valor all para obtener eventos de actividad para todos los usuarios, o cualquier otro valor para una entidad específica de la aplicación. Para obtener detalles sobre cómo obtener el entityKey de un entityType en particular, consulta las guías de referencia de los Parámetros de uso de entidades.
date

string

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

Parámetros de consulta

Parámetros
customerId

string

Es el ID único del cliente del que se recuperarán los datos.
filters

string

La cadena de consulta filters es una lista separada por comas de los parámetros de evento 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 aplicación para el informe de uso de entidades incluyen accounts, docs y gmail.

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

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

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

Entre los operadores relacionales, se incluyen los siguientes:

  • ==: "igual a".
  • <>: "no es igual a". Está codificada como URL (%3C%3E).
  • <: "Menor que". Está codificado en formato URL (%3C).
  • <=: "menor que o igual a". Está codificado como URL (%3C=).
  • >: "Mayor que". Está codificado como URL (%3E).
  • >=: "Mayor o igual que". Está codificado como URL (%3E=).
Solo se pueden aplicar filtros a parámetros numéricos.
maxResults

integer (uint32 format)

Determina cuántos registros de actividad se muestran en cada página de respuesta. Por ejemplo, si la solicitud establece <span>maxResults=1</span> y el informe tiene dos actividades, el informe tiene dos páginas. La propiedad <span>nextPageToken</span> de la respuesta tiene el token de la segunda página.
pageToken

string

Es un token para especificar la página siguiente. Un informe con varias páginas tiene una propiedad nextPageToken en la respuesta. En la solicitud de seguimiento para obtener 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 separados por comas que definen 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 entidades son solo gplus.
Una cadena de consulta parameter está en el formato CSV de [app_name1:param_name1], [app_name2:param_name2]....

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.

EntityType

Enumeraciones
gplus_communities Muestra un informe sobre las comunidades de Google+.