El informe de uso de entidades muestra las actividades de servicio de Google Workspace relacionadas con las entidades que usan los usuarios de tu cuenta. Estos informes se pueden personalizar y filtrar para usos específicos información. Hay datos disponibles de los últimos 30 días.
El informe de uso de entidades solo se puede utilizar con fines legales en conforme a su Acuerdo del Cliente. Estos informes también se aplican Google Workspace y Education.
Recuperar todas las actividades de uso de las entidades
Actualmente, el único tipo de entidad compatible con esta API son las comunidades de Google+. Para recuperar un
informe de todas las actividades relacionadas con las entidades de aplicaciones de tu cuenta, utiliza el siguiente
solicitud HTTP GET e incluye el token de autorización descrito en el
documentación de autorización. Para
para mayor legibilidad, el siguiente ejemplo tiene un formato con retornos de línea:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
El valor date es la fecha en que ocurrió el uso y la marca de tiempo se encuentra en el Formato ISO 8601, aaaa-mm-dd. Te recomendamos utilice la zona horaria de su cuenta para este fin. Para obtener más información sobre los parámetros de la cadena de consulta y propiedades de respuesta, consulta la API Referencia. Para obtener información acerca de los parámetros del informe de uso de entidades, consulta la Parámetros de uso de entidades referencia.
applicationParameters es una lista de parámetros separados por comas que deseas recuperar.
Cada parámetro tiene el formato de application:parameter_name, por ejemplo:
gplus:community_name Los parámetros disponibles se documentan en el
Parámetros de uso de entidades
referencia. Si no se especifican parámetros, se mostrarán todos.
parameterFilters es una lista de filtros separados por comas que se aplicarán a los resultados. Cada
el filtro tiene el formato
application:parameter_name[relational_operator]parameter_value Por ejemplo, el
filtrar gplus:num_total_members>100 filtra los resultados para que solo contengan resultados
en el que el parámetro gplus:num_total_members tiene un valor superior a 100.
maxResults es la cantidad máxima de resultados que se muestran en una sola recuperación. Si el total
de resultados es mayor que este, la respuesta se truncará y se
Se incluirán nextPageToken (consulta la
ejemplo de respuesta JSON a continuación).
Ejemplos
En el siguiente ejemplo, se obtiene un informe que contiene todos los parámetros
para todas las entidades gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
En el siguiente ejemplo, se obtiene un informe que contiene el parámetro community_name
para todas las entidades gplus_communities.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
En el siguiente ejemplo, se obtiene un informe de community_name y
num_total_members para cada entidad gplus_communities, filtrado por
comunidades con más de 100 miembros. Para ver un ejemplo de respuesta de la API, consulta la
Ejemplo de respuesta JSON.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
Recuperar un informe de una entidad específica
Para recuperar un informe de una entidad específica, usa la siguiente solicitud HTTP GET y
incluir el token de autorización descrito en el
documentación de autorización. Para
para mayor legibilidad, el siguiente ejemplo tiene un formato con retornos de línea.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
El entityKey es un identificador de entidad específico de la aplicación en la que la entidad. Consulta la página Consulta este artículo de referencia para saber cómo obtener el entityKey de la entidad en particular que les interesan. Los otros parámetros están documentados anteriormente en Recupera todas las actividades de uso de las entidades.
Para obtener más información sobre los parámetros de la cadena de consulta y las propiedades de la respuesta, consulta la Referencia de la API. Información acerca de los parámetros del informe de uso de entidades, consulta el Parámetros de uso de entidades referencia.
Ejemplos
En el siguiente ejemplo, se obtiene el informe de entidad de una entidad gplus_community con el
entityKey “1234”:
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
Ejemplo de respuesta JSON de informe de uso
Si la respuesta es correcta, se mostrará un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve un informe. Algunos de los parámetros de la respuesta se han omitida para facilitar la lectura.
Ejemplo de respuesta JSON para el informe de entidades
{
"kind": "reports#usageReports",
"nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
"usageReports": [
{
"kind": "admin#reports#usageReport",
"date": "2017-12-11",
"entity": {
"type": "OBJECT",
"customerId": "C03az79cb",
"objectType": "GPLUS_COMMUNITY",
"objectId": "1234",
},
"parameters": [
{
"name": "gplus:community_name",
"stringValue": "My Community"
},
{
"name": "gplus:num_total_members",
"intValue": 37
},
{
"name": "gplus:num_7day_active_members",
"intValue": 12
},
{
"name": "gplus:num_30day_active_members",
"intValue": 17
},
]
}
]
}
Ejemplo de respuesta JSON para el informe de entidades con advertencias
Se pueden mostrar una o más advertencias en la respuesta si la solicitud no se puede llevar a cabo. En este Por ejemplo, la denuncia no está disponible en el momento en que se realiza la solicitud.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}
Cada entrada del array warnings tiene los siguientes parámetros:
code: Código de advertencia legible por máquinamessage: mensaje de advertencia legible por humanosdata: Es la lista de pares clave-valor que proporcionan información de advertencia detallada.