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 Entities Usage.
Solicitud HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
Representa la clave del objeto con el que se filtrarán los datos. Es una cadena que puede tomar el valor all a fin de obtener eventos de actividad para todos los usuarios o cualquier otro valor para una entidad específica de la app. Si quieres obtener detalles sobre cómo obtener el entityKey para un entityType en particular, consulta las guías de referencia de los parámetros de Entities Usage.
date
string
Representa la fecha en que ocurrió el uso, en función de 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 cuyos datos se recuperarán.
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 entidades incluyen accounts, docs y gmail.
Los filtros tienen el formato [application name]:[parameter
name][relational operator][parameter value],....
En este ejemplo, el valor de <> "no es igual a" está codificado como 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
Los operadores relacionales incluyen los siguientes:
==: "igual a".
<>: "no es igual a". Está codificado en formato URL (%3C%3E).
<: "menor que". Está codificado en formato URL (%3C).
<=: "menor que o igual a". Está codificado en formato URL (%3C=).
>: "mayor que". Está codificado en formato URL (%3E).
>=: "mayor que o igual a". Está codificado en formato URL (%3E=).
Solo se pueden aplicar filtros a parámetros numéricos.
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 tendrá dos páginas. La propiedad <span>nextPageToken</span> de la respuesta tiene el token para la segunda página.
pageToken
string
Token para especificar la página siguiente. Un informe con varias páginas incluye una propiedad nextPageToken en la respuesta. En tu 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 separada por comas de los parámetros de evento 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 tiene 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.
