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 aplicación de Google Drive. Para obtener más información, consulta las guías sobre los informes de actividad de administrador y Google Drive. Para obtener más información sobre los parámetros del informe de actividad, 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 del 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 único del perfil de Google Workspace de un usuario o su dirección de correo electrónico principal. No debe ser un usuario borrado. En el caso de un usuario borrado, llama a users.list en la API de Directory con showDeleted=true y, luego, usa el ID que se devolvió como userKey.

applicationName

enum (ApplicationName)

Nombre de la aplicación para la que se recuperarán los eventos.

Parámetros de consulta

Parámetros
actorIpAddress

string

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 para el que se recuperarán los datos.

endTime

string

Establece el final del período que se muestra en el informe. La fecha está en 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 la API tiene tres conceptos básicos de tiempo:

  • Fecha de la solicitud de un informe de la API: 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 al endTime (si se especifica) y a la hora actual en el momento en que se realiza la solicitud. De lo contrario, la API devolverá 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, pero 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 se remonta a más de 180 días en el pasado.

En el caso de las solicitudes de Gmail, se deben proporcionar startTime y endTime, y la diferencia no debe ser superior a 30 días.

eventName

string

Es el nombre del evento sobre el que se realiza la consulta a 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 de Calendario de Google en los informes de la aplicación de la Consola del administrador. La estructura type de Calendar Settings contiene todas las actividades de Calendar eventName 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 Calendar Settings. Para obtener más información sobre los parámetros y las cadenas de consulta de eventName, consulta la lista de nombres de eventos para varias aplicaciones que se encuentra más arriba en applicationName.

filters

string

La cadena de consulta filters es una lista separada por comas compuesta por 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 a 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 para acceder a la página Eventos de actividad en el Apéndice de la aplicación que desees.

En los siguientes ejemplos de actividad de Drive, la lista que se muestra incluye 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 devuelve todos los documentos editados con un valor doc_id igual a 12345. En el segundo ejemplo, el informe muestra todos los documentos editados en los que el valor de 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 de filters admite estos operadores relacionales:

  • ==: "igual a".
  • <>: "no es igual a". Debe estar codificado como URL (%3C%3E).
  • <: "Menor que". Debe estar codificado como URL (%3C).
  • <=: "menor o igual que". Debe estar codificado como URL (%3C=).
  • >: "mayor que". Debe estar codificado como URL (%3E).
  • >=: "mayor que o igual a". Debe estar codificado como URL (%3D%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 de API, la API solo acepta 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 ignorará y devolverá la respuesta correspondiente a los parámetros válidos restantes. Si no se solicitan parámetros, se devuelven 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 tendrá 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á el informe. 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 de nextPageToken en la cadena de consulta pageToken.

startTime

string

Establece el comienzo del período que se muestra en el informe. La fecha está en formato RFC 3339, por ejemplo, 2010-10-28T10:26:35.000Z. El informe devuelve todas las actividades desde startTime hasta endTime. El startTime debe ser anterior al endTime (si se especifica) y a la hora actual en el momento en que se realiza la solicitud. De lo contrario, la API devolverá un error.

En el caso de las solicitudes de Gmail, se deben proporcionar startTime y endTime, y la diferencia no debe ser superior a 30 días.

groupIdFilter

string

Son los IDs de grupos separados por comas (ofuscados) según los cuales se filtran las actividades del usuario, es decir, la respuesta contendrá actividades solo para aquellos usuarios que formen parte de al menos uno de los IDs de grupos mencionados aquí. Formato: "id:abc123,id:xyz456"

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es una 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)

Es cada registro de actividad en la respuesta.

nextPageToken

string

Es el 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 del 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.
gmail Los informes de actividad de la aplicación de Gmail muestran información sobre varios eventos de actividad de Gmail.
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 Enterprise Groups muestran información sobre varios eventos de actividad de Enterprise Groups.

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 Auditoría de Meet devuelve información sobre diferentes tipos de eventos de actividad de Auditoría de Meet.
mobile El informe de actividad de auditoría de dispositivos muestra información sobre diferentes tipos de eventos de actividad de auditoría de dispositivos.
rules

El informe de actividad de reglas devuelve información sobre diferentes tipos de eventos de actividad de reglas.

saml

El informe de actividad de SAML devuelve 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 devuelven 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.
gemini_in_workspace_apps Los informes de actividad de Gemini para Workspace muestran información sobre varios tipos de eventos de actividad de Gemini que realizan los usuarios en una aplicación de Workspace.
classroom Los informes de actividad de Classroom muestran información sobre diferentes tipos de eventos de actividad de Classroom.

Actividad

Es una 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
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "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

Es la ETag de la entrada.

ownerDomain

string

Es el dominio afectado por el evento del informe. Es el dominio de ejemplo de la Consola del administrador o del 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 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). La API admite IPv4 y IPv6.

events[]

object

Son los eventos de actividad incluidos en el informe.

events[].type

string

Es el tipo de evento. El servicio o la función de Google Workspace que modifica 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 de type de la API, consulta la lista de nombres de eventos para diversas aplicaciones que se encuentra más arriba en applicationName.

events[].name

string

Nombre del evento. Es el nombre específico de la actividad que informa 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.
Para los parámetros de solicitud de eventName en general:

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

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

events[].parameters[]

object

Son pares de valores de parámetros para diversas aplicaciones. Para obtener más información sobre los parámetros de eventName, consulta la lista de nombres de eventos para varias aplicaciones que se encuentra más arriba en applicationName.

events[].parameters[].messageValue

object

Son los pares de valores de parámetros anidados asociados con este parámetro. Los tipos de valores complejos para un parámetro se devuelven 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

Son los 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)

Son los 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

Son los IDs de recursos asociados con el evento.

id

object

Es el identificador único de cada registro de actividad.

id.time

string

Hora en que ocurrió la actividad. Se expresa en segundos desde la época UNIX.

id.uniqueQualifier

string (int64 format)

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

id.applicationName

string

Nombre de la aplicación a la 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

Es el usuario que realiza la acción.

actor.profileId

string

Es el ID único del perfil de Google Workspace del actor. Este valor puede estar ausente si el actor no es un usuario de Google Workspace o 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 al 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 las cuentas de robots.

actor.applicationInfo

object

Son los 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

Nombre de la aplicación que se usó para realizar la acción.

actor.applicationInfo.impersonation

boolean

Indica si la aplicación suplantó la identidad de un usuario.

networkInfo

object (NetworkInfo)

Es la información de la red del usuario que realiza la acción.

resourceDetails[]

object (ResourceDetails)

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

NetworkInfo

Es la información de la red del usuario que realiza la acción.

Representación JSON
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
Campos
ipAsn[]

integer

Es la dirección IP del usuario que realiza la acción.

regionCode

string

Es el código de región ISO 3166-1 alpha-2 del usuario que realiza la acción.

subdivisionCode

string

Es el código de región ISO 3166-2 (estados y provincias) para los países del usuario que realiza 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, 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, mensaje de chat

appliedLabels[]

object (AppliedLabel)

activities.list de etiquetas aplicadas al recurso

relation

string

Define la relación del recurso con los eventos

AppliedLabel

Son los detalles de la etiqueta aplicada al recurso.

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

string

Es el 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 of fields which are part of the label and have been set by the user. Si la etiqueta tiene un campo que el usuario no configuró, no estará presente en esta lista.

reason

object (Reason)

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

FieldValue

Son los detalles del valor del campo establecido por 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

Identificador del campo

displayName

string

Nombre visible del campo

type

string

Tipo del campo

reason

object (Reason)

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

Campo de unión value. Los valores almacenados en el campo value solo pueden ser uno de los siguientes:
unsetValue

boolean

Si el campo no está configurado, el valor será verdadero.

longTextValue

string

Establecer un valor de texto largo

textValue

string

Establecer un valor de texto

textListValue

object (TextListValue)

Establece un valor de lista de texto.

selectionValue

object (SelectionValue)

Establecer 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 un menú desplegable

integerValue

string (int64 format)

Establece un valor entero.

userValue

object (UserValue)

Establecer un valor del usuario seleccionando un solo usuario

userListValue

object (UserListValue)

Establece 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

Es una lista de valores de texto de las actividades.

SelectionValue

Establecer 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 un menú desplegable

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

object (SelectionValue)

activities.list de selecciones.

UserValue

Establecer un valor del usuario seleccionando un solo usuario

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

string

Es el correo electrónico del usuario.

UserListValue

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