Method: activities.list

Recupera una lista de actividades para la cuenta y la aplicación de un cliente específico, como la aplicación de la Consola del administrador o la de Google Drive. Para obtener más información, consulta las guías de los informes de actividad de administrador y de Google Drive. Para obtener más información sobre los parámetros del informe de actividades, consulta las guías de referencia de los parámetros de actividad.

Solicitud HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

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.
applicationName

enum (ApplicationName)

Es el nombre de la aplicación para la que se recuperarán los eventos.

Parámetros de consulta

Parámetros
actorIpAddress

string

Es la dirección de protocolo de Internet (IP) del host en el que se realizó el evento. Esta es una forma adicional de filtrar el resumen de un informe con la dirección IP del usuario cuya actividad se informa. Esta dirección IP puede reflejar o no la ubicación física del usuario. Por ejemplo, la dirección IP puede ser la dirección del servidor proxy del usuario o una dirección de red privada virtual (VPN). Este parámetro admite las versiones de direcciones IPv4 y IPv6.
customerId

string

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

string

Establece el final del intervalo de tiempo que se muestra en el informe. La fecha está en el formato RFC 3339, por ejemplo, 2010-10-28T10:26:35.000Z. El valor predeterminado es la hora aproximada de la solicitud a la API. Un informe de API tiene tres conceptos básicos de tiempo:

  • Fecha de la solicitud de la API para un informe: Es la fecha en la que la API creó y recuperó el informe.
  • Hora de inicio del informe: Es el comienzo del período que se muestra en el informe. El startTime debe ser anterior a endTime (si se especifica) y a la hora actual en la que se realiza la solicitud, o la API mostrará un error.
  • Hora de finalización del informe: Es el final del período que se muestra en el informe. Por ejemplo, el período de los eventos resumidos en un informe puede comenzar en abril y finalizar en mayo. El informe en sí se puede solicitar en agosto.
Si no se especifica endTime, el informe muestra todas las actividades desde startTime hasta la hora actual o los 180 días más recientes si startTime es anterior a ese período.
eventName

string

Es el nombre del evento que consulta la API. Cada eventName se relaciona con un servicio o una función específicos de Google Workspace que la API organiza en tipos de eventos. Un ejemplo son los eventos del Calendario de Google en los informes de la aplicación de la Consola del administrador. La estructura type de la configuración de Calendario tiene todas las actividades eventName de Calendario que informa la API. Cuando un administrador cambia un parámetro de configuración del Calendario, la API informa esta actividad en los parámetros type y eventName de la configuración del Calendario. Para obtener más información sobre las cadenas de consulta y los parámetros de eventName, consulta la lista de nombres de eventos de varias aplicaciones que se encuentra más arriba en applicationName.
filters

string

La cadena de consulta filters es una lista separada por comas compuesta de parámetros de eventos manipulados por operadores relacionales. Los parámetros de eventos tienen el formato {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},....

Estos parámetros de eventos están asociados con un eventName específico. Se muestra un informe vacío si el parámetro de la solicitud no pertenece a eventName. Para obtener más información sobre los campos eventName disponibles para cada aplicación y sus parámetros asociados, ve a la tabla ApplicationName y, luego, haz clic en la página Activity Events del Apéndice de la aplicación que deseas.

En los siguientes ejemplos de actividades de Drive, la lista que se muestra consta de todos los eventos edit en los que el valor del parámetro doc_id coincide con las condiciones definidas por el operador relacional. En el primer ejemplo, la solicitud muestra todos los documentos editados con un valor de doc_id igual a 12345. En el segundo ejemplo, el informe muestra todos los documentos editados en los que el valor doc_id no es igual a 98765. El operador <> está codificado en la URL en la cadena de consulta de la solicitud (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Una consulta filters admite estos operadores relacionales:

  • ==: "Igual a".
  • <>: "No es igual a". Debe estar codificado como URL (%3C%3E).
  • <: "Menor que". Debe estar codificada como URL (%3C).
  • <=: "Menor o igual que". Debe estar codificada como URL (%3C=).
  • >: "mayor que". Debe estar codificado como URL (%3E).
  • >=: "Mayor que o igual a". Debe estar codificado como URL (%3E=).

Nota: La API no acepta varios valores del mismo parámetro. Si se proporciona un parámetro más de una vez en la solicitud a la API, esta solo aceptará el último valor de ese parámetro. Además, si se proporciona un parámetro no válido en la solicitud a la API, esta lo ignora y muestra la respuesta correspondiente a los parámetros válidos restantes. Si no se solicitan parámetros, se muestran todos.
maxResults

integer

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 tiene dos páginas. La propiedad nextPageToken de la respuesta tiene el token de la segunda página. La cadena de consulta maxResults es opcional en la solicitud. El valor predeterminado es 1,000.
orgUnitID

string

Es el ID de la unidad organizacional sobre la que se generarán los informes. Los registros de actividad solo se mostrarán para los usuarios que pertenezcan a la unidad organizativa especificada.

pageToken

string

Es el 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.
startTime

string

Establece el inicio del intervalo de tiempo que se muestra en el informe. La fecha está en el formato RFC 3339, por ejemplo, 2010-10-28T10:26:35.000Z. El informe muestra todas las actividades desde startTime hasta endTime. El startTime debe ser anterior a endTime (si se especifica) y a la hora actual en la que se realiza la solicitud, o la API mostrará un error.
groupIdFilter

string

IDs de grupo separados por comas (ofuscados) en los que se filtran las actividades de los usuarios; es decir, la respuesta contendrá actividades solo para los usuarios que formen 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

Plantilla JSON para una colección de actividades.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Es el tipo de recurso de la API. Para un informe de actividad, el valor es reports#activities.
etag

string

ETag del recurso.
items[]

object (Activity)

Cada registro de actividad en la respuesta.
nextPageToken

string

Es un token para recuperar la siguiente página del informe. El valor nextPageToken se usa en la cadena de consulta pageToken de la solicitud.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

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

ApplicationName

Enumeraciones
access_transparency

Los informes de actividad de Transparencia de acceso de Google Workspace muestran información sobre diferentes tipos de eventos de actividad de Transparencia de acceso.
admin

Los informes de actividad de la aplicación de la Consola del administrador muestran información de la cuenta sobre diferentes tipos de eventos de actividad del administrador.
calendar

Los informes de actividad de la aplicación de Calendario de Google muestran información sobre varios eventos de actividad del Calendario.
chat

Los informes de actividad de Chat muestran información sobre varios eventos de actividad de Chat.
drive

Los informes de actividad de la aplicación de Google Drive muestran información sobre varios eventos de actividad de Google Drive. El informe de actividad de Drive solo está disponible para los clientes de Google Workspace Business y Enterprise.
gcp

Los informes de actividad de la aplicación de Google Cloud Platform muestran información sobre varios eventos de actividad de GCP.
gplus

Los informes de actividad de la aplicación de Google+ muestran información sobre varios eventos de actividad de Google+.
groups

Los informes de actividad de la aplicación de Grupos de Google muestran información sobre varios eventos de actividad de Grupos.
groups_enterprise

Los informes de actividad de los grupos de Enterprise muestran información sobre varios eventos de actividad de los grupos de Enterprise.
jamboard

Los informes de actividad de Jamboard muestran información sobre varios eventos de actividad de Jamboard.
login

Los informes de actividad de la aplicación de acceso muestran información de la cuenta sobre diferentes tipos de eventos de actividad de acceso.
meet

El informe de actividad de la auditoría de Meet muestra información sobre los diferentes tipos de eventos de actividad de la auditoría de Meet.
mobile

El informe de actividad de la auditoría de dispositivos muestra información sobre diferentes tipos de eventos de actividad de la auditoría de dispositivos.
rules

El informe de actividad de las reglas muestra información sobre los diferentes tipos de eventos de actividad de las reglas.
saml

El informe de actividad de SAML muestra información sobre diferentes tipos de eventos de actividad de SAML.
token

Los informes de actividad de la aplicación de tokens muestran información de la cuenta sobre diferentes tipos de eventos de actividad de tokens.
user_accounts

Los informes de actividad de la aplicación Cuentas de usuario muestran información de la cuenta sobre diferentes tipos de eventos de actividad de Cuentas de usuario.
context_aware_access

Los informes de actividad de acceso adaptado al contexto muestran información sobre los eventos de acceso denegado de los usuarios debido a las reglas de acceso adaptado al contexto.
chrome

Los informes de actividad de Chrome muestran información sobre los eventos del navegador Chrome y ChromeOS.
data_studio

Los informes de actividad de Data Studio muestran información sobre varios tipos de eventos de actividad de Data Studio.
keep

Los informes de actividad de la aplicación de Keep muestran información sobre varios eventos de actividad de Google Keep. El informe de actividad de Keep solo está disponible para los clientes de Google Workspace Business y Enterprise.
vault Los informes de actividad de Vault muestran información sobre varios tipos de eventos de actividad de Vault.

Actividad

Es la plantilla JSON para el recurso de actividad.

Representación JSON 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
Campos
kind

string

Es el tipo de recurso de la API. Para un informe de actividad, el valor es audit#activity.
etag

string

ETag de la entrada.
ownerDomain

string

Es el dominio que se ve afectado por el evento del informe. Por ejemplo, el dominio de la Consola del administrador o el propietario del documento de la aplicación de Drive.
ipAddress

string

Es la dirección IP del usuario que realiza la acción. Es la dirección de protocolo de Internet (IP) del usuario cuando accede a Google Workspace, que puede reflejar o no su ubicación física. Por ejemplo, la dirección IP puede ser la dirección del servidor proxy del usuario o una dirección de red privada virtual (VPN). La API admite IPv4 y IPv6.
events[]

object

Eventos de actividad en el informe
events[].type

string

Es el tipo de evento. El servicio o la función de Google Workspace que cambia un administrador se identifica en la propiedad type, que identifica un evento con la propiedad eventName. Para obtener una lista completa de las categorías type de la API, consulta la lista de nombres de eventos de varias aplicaciones en applicationName.
events[].name

string

Nombre del evento. Este es el nombre específico de la actividad que informa la API. Además, cada eventName se relaciona con un servicio o una función específicos de Google Workspace que la API organiza en tipos de eventos.
Para los parámetros de solicitud eventName en general:

  • Si no se proporciona un eventName, el informe muestra todas las instancias posibles de un eventName.
  • Cuando solicitas un eventName, la respuesta de la API muestra todas las actividades que contienen ese eventName.

Para obtener más información sobre las propiedades eventName, consulta la lista de nombres de eventos de varias aplicaciones que se encuentra más arriba en applicationName.
events[].parameters[]

object

Pares de valores de parámetros para varias aplicaciones. Para obtener más información sobre los parámetros de eventName, consulta la lista de nombres de eventos de varias aplicaciones que se encuentra más arriba en applicationName.
events[].parameters[].messageValue

object

Pares de valores de parámetros anidados asociados con este parámetro. El tipo de valor complejo de un parámetro se muestra como una lista de valores de parámetros. Por ejemplo, el parámetro de dirección puede tener un valor como [{parameter: [{name: city, value: abc}]}].
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Valores de los parámetros
events[].parameters[].name

string

El nombre del parámetro.
events[].parameters[].value

string

Es el valor de cadena del parámetro.
events[].parameters[].multiValue[]

string

Valores de cadena del parámetro.
events[].parameters[].intValue

string (int64 format)

Es el valor entero del parámetro.
events[].parameters[].multiIntValue[]

string (int64 format)

Valores enteros del parámetro.
events[].parameters[].boolValue

boolean

Es el valor booleano del parámetro.
events[].parameters[].multiMessageValue[]

object

activities.list de objetos messageValue.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Valores de los parámetros
events[].resourceIds[]

string

Los IDs de recursos asociados con el evento
id

object

Es un identificador único para cada registro de actividad.
id.time

string

Hora en que ocurrió la actividad. Esto se expresa en tiempo de época UNIX en segundos.
id.uniqueQualifier

string (int64 format)

Es un calificador único si varios eventos tienen la misma hora.
id.applicationName

string

Es el nombre de la aplicación al que pertenece el evento. Para conocer los valores posibles, consulta la lista de aplicaciones anterior en applicationName.
id.customerId

string

Es el identificador único de una cuenta de Google Workspace.
actor

object

El usuario realiza la acción.
actor.profileId

string

El ID de perfil único de Google Workspace del usuario. Es posible que este valor no esté presente si el usuario no es de Google Workspace, o bien puede ser el número 105250506097979753968, que actúa como un ID de marcador de posición.
actor.email

string

Es la dirección de correo electrónico principal del actor. Puede estar ausente si no hay una dirección de correo electrónico asociada con el actor.
actor.callerType

string

Es el tipo de actor.
actor.key

string

Solo está presente cuando callerType es KEY. Puede ser el consumer_key del solicitante para las solicitudes a la API de OAuth 2LO o un identificador para cuentas de robots.
actor.applicationInfo

object

Detalles de la aplicación que fue el actor de la actividad.
actor.applicationInfo.oauthClientId

string

Es el ID de cliente de OAuth de la aplicación de terceros que se usa para realizar la acción.
actor.applicationInfo.applicationName

string

Es el nombre de la aplicación que se usó para realizar la acción.
actor.applicationInfo.impersonation

boolean

Indica si la aplicación estaba suplantando la identidad de un usuario.
resourceDetails[]

object (ResourceDetails)

Son los detalles del recurso en el que se realizó la acción.

ResourceDetails

Son los detalles del recurso en el que se realizó la acción.

Representación JSON 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Campos
id

string

Es el identificador del recurso.
title

string

Es el título del recurso. Por ejemplo, en el caso de un documento de Drive, este sería el título del documento. En el caso de un correo electrónico, este sería el asunto.
type

string

Tipo de recurso: documento, correo electrónico o mensaje de chat
appliedLabels[]

object (AppliedLabel)

activities.list of labels applied on the resource
relation

string

Define la relación del recurso con los eventos

AppliedLabel

Detalles de la etiqueta aplicada al recurso.

Representación JSON 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Campos
id

string

Identificador de la etiqueta: Solo el ID de la etiqueta, no el nombre completo del recurso de OnePlatform.
title

string

Título de la etiqueta
fieldValues[]

object (FieldValue)

activities.list de campos que forman parte de la etiqueta y que el usuario estableció. Si la etiqueta tiene un campo que el usuario no configuró, no estará presente en esta lista.
reason

object (Reason)

El motivo por el que se aplicó la etiqueta al recurso.

FieldValue

Detalles del valor del campo que estableció el usuario para la etiqueta en particular.

Representación JSON 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Campos
id

string

Es el identificador del campo.
displayName

string

Es el nombre visible del campo.
type

string

Tipo de campo
reason

object (Reason)

El motivo por el que se aplicó el campo a la etiqueta.
Campo de unión value. Almacena los valores almacenados en el campo value, que puede ser uno de los siguientes:
unsetValue

boolean

Si el campo no está establecido, este valor será verdadero.
longTextValue

string

Establece un valor de texto largo.
textValue

string

Establece un valor de texto.
textListValue

object (TextListValue)

Establece un valor de lista de texto.
selectionValue

object (SelectionValue)

Establece un valor de selección seleccionando un solo valor de un menú desplegable.
selectionListValue

object (SelectionListValue)

Establecer un valor de lista de selección seleccionando varios valores de una lista desplegable
integerValue

string (int64 format)

Establece un valor entero.
userValue

object (UserValue)

Establecer un valor de usuario seleccionando un solo usuario
userListValue

object (UserListValue)

Establecer un valor de lista de usuarios seleccionando varios usuarios
dateValue

object (Date)

Establece un valor de fecha.

TextListValue

Establece un valor de lista de texto.

Representación JSON 
{
  "values": [
    string
  ]
}
Campos
values[]

string

activities.list de valores de texto.

SelectionValue

Establece un valor de selección seleccionando un solo valor de un menú desplegable.

Representación JSON 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Campos
id

string

Es el identificador de la selección.
displayName

string

Es el nombre visible de la selección.
badged

boolean

Indica si la selección tiene una insignia.

SelectionListValue

Establecer un valor de lista de selección seleccionando varios valores de una lista desplegable

Representación JSON 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Campos
values[]

object (SelectionValue)

activities.list of selections.

UserValue

Establecer un valor de usuario seleccionando un solo usuario

Representación JSON 
{
  "email": string
}
Campos
email

string

Es el correo electrónico del usuario.

UserListValue

Establecer un valor de lista de usuarios seleccionando varios usuarios

Representación JSON 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Campos
values[]

object (UserValue)

activities.list of users.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

Motivo

Es el motivo por el que se aplicó la etiqueta o el campo.

Representación JSON 
{
  "reasonType": string
}
Campos
reasonType

string

Es el tipo de motivo.