API de informes: informe de uso de entidades

El informe de uso de entidades muestra 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 obtener información de uso específica. Los datos están disponibles para los últimos 30 días.

El informe de uso de las entidades se puede usar solo con fines legales de acuerdo con su Acuerdo con el Cliente. Estos informes también se aplican a Google Workspace y Education.

Recuperar todas las actividades de uso de entidades

Actualmente, el único tipo de entidad que admite esta API son las comunidades de Google+. Para recuperar un informe de todas las actividades relacionadas con entidades de apps de 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 tiene 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 la que se produjo el uso y la marca de tiempo está en formato ISO 8601, aaaa-mm-dd. Para ello, te recomendamos que uses la zona horaria de tu cuenta. Para obtener más información sobre los parámetros de las strings 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 de entidades, consulta la referencia de los parámetros de uso de las entidades.

applicationParameters es una lista de parámetros separados por comas que deseas recuperar. Cada parámetro tiene el formato application:parameter_name, por ejemplo, gplus:community_name. Los parámetros disponibles se documentan en la referencia de Parámetros de uso de entidades. Si no se especifican parámetros, se muestran todos.

parameterFilters es una lista de filtros separados por comas para aplicar a los resultados. Cada filtro tiene el formato application:parameter_name[relational_operator]parameter_value. Por ejemplo, el filtro gplus:num_total_members>100 filtra los resultados para contener solo resultados en los que el parámetro gplus:num_total_members tiene un valor mayor que 100.

maxResults es la cantidad máxima de resultados que se mostrarán en una sola recuperación. Si la cantidad total de resultados es mayor que esta, la respuesta se truncará y se incluirá un nextPageToken (consulta el ejemplo de respuesta de 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 una respuesta de la API, consulta el ejemplo de respuesta de 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

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

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

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