Method: activities.watch

• Solicitud HTTP
• Parámetros de ruta de acceso
• Parámetros de consulta
• Cuerpo de la solicitud
• Cuerpo de la respuesta
  • Representación JSON
• Permisos de autorización
• ApplicationName

Comenzar a recibir notificaciones sobre las actividades de la cuenta Para obtener más información, consulta Cómo recibir notificaciones push.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
userKey	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 El ID único del cliente cuyos datos se recuperarán.
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 El nombre del evento que la API consulta. Cada eventName está relacionado 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 en formato URL (%3C%3E). <: "Menor que". Debe estar codificado en formato URL (%3C). <=: "Menor o igual que". Debe estar codificada como URL (%3C=). >: "mayor que". Debe estar codificada como URL (%3E). >=: "Mayor que o igual a". Debe estar codificada como URL (%3E=). Nota: La API no acepta varios valores del mismo parámetro. Si un parámetro se proporciona más de una vez en la solicitud a la 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, la API ignora ese parámetro y devuelve 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 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 (deprecated)	string Deprecated. Este campo dejó de estar disponible y ya no es compatible. 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. Los datos anteriores al 17 de diciembre de 2018 no aparecen en los resultados filtrados.
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 comienzo 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 forman 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 contiene una instancia de SubscriptionChannel.

Cuerpo de la respuesta

Es un canal de notificación que se usa para detectar cambios en los recursos.

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

Representación JSON
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string }

Campos
id	string Un UUID o una cadena única similar que identifica este canal.
token	string Es una cadena arbitraria que se entrega a la dirección de destino con cada notificación que se envía a través de este canal. Opcional.
expiration	string (int64 format) Es la fecha y hora de vencimiento del canal de notificaciones, expresada como una marca de tiempo de Unix, en milisegundos. Opcional.
type	string Es el tipo de mecanismo de publicación que se usa para este canal. El valor se debe establecer en "web_hook".
address	string Es la dirección a la que se envían las notificaciones de este canal.
payload	boolean Es un valor booleano que indica si se desea la carga útil. Una carga útil es un conjunto de datos que se envía en el cuerpo de un mensaje HTTP POST, PUT o PATCH y contiene información importante sobre la solicitud. Opcional.
params	map (key: string, value: string) Parámetros adicionales que controlan el comportamiento del canal de publicación. Opcional. Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
resourceId	string Un ID opaco que identifica el recurso que se está mirando en este canal. Es estable en diferentes versiones de la API.
resourceUri	string Es un identificador específico de la versión para el recurso observado.
kind	string Identifica esto como un canal de notificaciones que se usa para detectar cambios en un recurso, que es "api#channel".

Alcances 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

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

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 Google Workspace 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 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	En el informe Actividad de auditoría de Meet, se muestra información sobre diferentes tipos de eventos de actividad de auditoría de Meet.
mobile	El informe de actividad de la auditoría de dispositivos muestra información sobre los diferentes tipos de eventos de actividad de la auditoría de dispositivos.
rules	En este informe, se muestra información sobre diferentes tipos de eventos de actividad de reglas.
saml	El informe de actividad de SAML muestra información sobre los 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.