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

Comienza 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 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. 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 muestra 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 La dirección de protocolo de Internet (IP) del host donde se realizó el evento. Esta es una forma adicional de filtrar el resumen de un informe mediante 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 es compatible con las versiones de dirección IPv4 e 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 el tiempo aproximado de la solicitud a la API. Un informe de API tiene tres conceptos básicos de tiempo: Fecha de la solicitud de un informe por parte de la API: cuándo la API creó y recuperó el informe. Hora de inicio del informe: Indica el comienzo del período que se muestra en el informe. El valor de startTime debe ser anterior a endTime (si se especifica) y la hora actual en la que se realiza la solicitud; de lo contrario, la API mostrará un error. Hora de finalización del informe: Indica el final del período que se muestra en el informe. Por ejemplo, la duración de los eventos resumidos en un informe puede comenzar en abril y finalizar en mayo. El informe se puede solicitar en agosto. Si no se especifica la endTime, el informe muestra todas las actividades desde la startTime hasta la hora actual o hasta los 180 días más recientes si la startTime tiene más de 180 días en el pasado.
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 del calendario tiene todas las actividades de eventName del calendario informadas por la API. Cuando un administrador cambia un parámetro de configuración de 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 para varias aplicaciones que aparece más arriba en applicationName.
filters	string La cadena de consulta filters es una lista separada por comas compuesta por parámetros de evento 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 evento 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, luego haz clic en 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 consta de todos los eventos edit en los que el valor del parámetro doc_id coincide con las condiciones que definió el operador relacional. En el primer ejemplo, la solicitud muestra todos los documentos editados con un valor doc_id igual a 12345. En el segundo ejemplo, el informe muestra los documentos editados en los que el valor de doc_id no es igual a 98765. El operador <> está codificado en formato 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 que o igual a". Debe estar codificado en formato URL (%3C=). >: "mayor que". Debe estar codificado en formato URL (%3E). >=: "mayor que o igual a". Debe estar codificado en formato URL (%3E=). Nota: La API no acepta múltiples valores para el 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 para 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 se admite. ID de la unidad organizativa sobre la que se informará. 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 El token que se especifica en la página siguiente. Un informe con varias páginas incluye una propiedad nextPageToken en la respuesta. En tu 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 el startTime hasta el endTime. El valor de startTime debe ser anterior a endTime (si se especifica) y la hora actual en la que se realiza la solicitud; de lo contrario, la API mostrará un error.
groupIdFilter	string Identificadores de grupo separados por comas (ofuscados) en los que se filtran las actividades del usuario, es decir, la respuesta contendrá actividades solo para aquellos usuarios que forman parte de al menos uno de los IDs de grupo que se mencionan aquí. Formato: "id:abc123,id:xyz456"

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de SubscriptionChannel.

Cuerpo de la respuesta

Un canal de notificaciones que se usa para buscar 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 Una cadena arbitraria entregada a la dirección de destino con cada notificación entregada a través de este canal. Opcional.
expiration	string (int64 format) Es la fecha y hora del vencimiento del canal de notificación, 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 Un valor booleano para indicar si se desea la carga útil. Una carga útil son datos que se envían en el cuerpo de un mensaje HTTP POST, PUT o PATCH y contienen 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 mira en este canal. Estable en diferentes versiones de la API.
resourceUri	string 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 la Transparencia de acceso de Google Workspace devuelven 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 Calendario de Google devuelven 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 de Google muestran información sobre varios eventos de actividad de Grupos.
groups_enterprise	Los informes de actividad de Grupos de empresas devuelven información sobre varios eventos de actividad del Grupo de empresas.
jamboard	Los informes de actividad de Jamboard devuelven 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	En el informe Actividad de auditoría del dispositivo, se muestra información sobre diferentes tipos de eventos de actividad de auditoría de dispositivos.
rules	En este informe, se muestra información sobre diferentes tipos de eventos de actividad de reglas.
saml	En el informe Actividad de SAML, se muestra información sobre diferentes tipos de eventos de actividad de SAML.
token	Los informes de actividad de la aplicación de token muestran información de la cuenta sobre diferentes tipos de eventos de actividad de token.
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 del acceso adaptado al contexto devuelven información Acceso a eventos denegados debido a reglas de acceso adaptado al contexto
chrome	Los informes de actividad de Chrome muestran información sobre los eventos del navegador Chrome y del Sistema operativo Chrome.
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.