Se usó la API de Cloud Translation para traducir esta página.

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 la actividad 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

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.

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.
`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 (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á el informe. 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 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.
`groupIdFilter (deprecated)`	`string` `Deprecated`. Este campo dejó de estar disponible y ya no es compatible. 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" Importante: Para filtrar por grupos, debes agregarlos de forma explícita a tu lista de grupos de filtrado permitidos. Para obtener más información sobre cómo agregar grupos a la lista de grupos de filtrado permitido, consulta Cómo filtrar resultados por Grupo de Google

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 supervisar los 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 }

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` Es 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)` Fecha y hora de vencimiento del canal de notificación, expresadas como una marca de tiempo de Unix en milisegundos. Opcional.
`type`	`string` Es el tipo de mecanismo de entrega 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 son los 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)` Son parámetros adicionales que controlan el comportamiento del canal de entrega. Opcional. Es un objeto que contiene una lista de pares `"key": value`. Ejemplo: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`resourceId`	`string` Es un ID opaco que identifica el recurso que se observa 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 este elemento como un canal de notificaciones que se usa para supervisar los cambios en un recurso, que es "`api#channel`".

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