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

Notificaciones push

En este documento, se describe cómo usar notificaciones push que informan a tu aplicación cuando cambia un recurso.

Descripción general

La API del SDK de Admin proporciona notificaciones push que te permiten supervisar los cambios en los recursos. Puedes usar esta función para mejorar el rendimiento de tu aplicación. Te permite eliminar los costos adicionales de red y procesamiento que implican los recursos de sondeo para determinar si cambiaron. Cada vez que cambia un recurso observado, la API del SDK de Admin notifica a tu aplicación.

Para usar las notificaciones push, debes hacer dos cosas:

Configura tu URL de recepción o el receptor de devolución de llamada de "webhook".
Este es un servidor HTTPS que controla los mensajes de notificación de la API que se activan cuando cambia un recurso.
Configura un (canal de notificaciones) para cada extremo de recurso que quieras observar.
Un canal especifica la información de enrutamiento para los mensajes de notificación. Como parte de la configuración del canal, debes identificar la URL específica en la que deseas recibir notificaciones. Cada vez que cambia el recurso de un canal, la API del SDK de Admin envía un mensaje de notificación como una solicitud POST a esa URL.

Actualmente, la API del SDK de Admin admite notificaciones de cambios en el recurso Activities.

Crea canales de notificaciones

Para solicitar notificaciones push, debes configurar un canal de notificaciones para cada recurso que desees supervisar. Después de configurar los canales de notificaciones, la API del SDK de Admin informa a tu aplicación cuando cambia un recurso observado.

Realiza solicitudes de reloj

Cada recurso de la API del SDK de Admin que se puede mirar tiene un método watch asociado en un URI de la siguiente forma:

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

Para configurar un canal de notificación para mensajes sobre cambios en un recurso en particular, envía una solicitud POST al método watch del recurso.

Cada canal de notificación está asociado con un usuario y un recurso (o conjunto de recursos) en particular. Una solicitud watch no se realizará correctamente a menos que el usuario o la cuenta de servicio actuales sean propietarios de este recurso o tengan permiso para acceder a él.

Ejemplos

Todas las solicitudes de reloj para el recurso Activities tienen el siguiente formato general:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/userKey or all/applications/applicationName/watch
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "payload": true, // (Optional) Whether to include the payload (message body) in notifications.
  "expiration": 3600 // (Optional) Your requested channel expiration time.
}

Puedes usar los parámetros userKey, applicationName, eventName y filters para recibir solo notificaciones de eventos, usuarios o aplicaciones específicos.

Nota: En los siguientes ejemplos, se omite el cuerpo de la solicitud para mayor claridad.

Mira todas las actividades del administrador:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin/watch

Mira todas las actividades de documentos:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/docs/watch

Observa la actividad de administrador de un usuario específico:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/liz@example.com/applications/admin/watch

Detecta un evento específico, como el cambio de la contraseña de un usuario:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin/watch?eventName=CHANGE_PASSWORD

Observa los cambios en un documento específico:

POST https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/docs/watch?eventName=EDIT&filters==doc_id=123456abcdef

Propiedades obligatorias

Con cada solicitud watch, debes proporcionar estos campos:

Una cadena de propiedad id que identifica de forma única este canal de notificaciones nuevo dentro del proyecto. Te recomendamos que uses un identificador único universal (UUID) o cualquier cadena única similar. Longitud máxima: 64 caracteres.

El valor de ID que estableces se repite en el encabezado HTTP X-Goog-Channel-Id de cada mensaje de notificación que recibes para este canal.
Una cadena de propiedades type establecida en el valor web_hook
Es una cadena de propiedad address establecida en la URL que escucha y responde a las notificaciones de este canal de notificaciones. Esta es la URL de devolución de llamada de tu webhook y debe usar HTTPS.

Ten en cuenta que la API del SDK de Admin puede enviar notificaciones a esta dirección HTTPS solo si hay un certificado SSL válido instalado en tu servidor web. Entre los certificados no válidos, se incluyen los siguientes:
- Certificados autofirmados
- Certificados firmados por una fuente no confiable
- Certificados revocados
- Certificados que tienen un asunto que no coincide con el nombre de host de destino

Propiedades opcionales

También puedes especificar estos campos opcionales con tu solicitud watch:

Es una propiedad token que especifica un valor de cadena arbitrario para usar como token de canal. Puedes usar tokens del canal de notificaciones para varios fines. Por ejemplo, puedes usar el token para verificar que cada mensaje entrante sea para un canal que creó tu aplicación (para asegurarte de que no se esté falsificando la notificación) o para enrutar el mensaje al destino correcto dentro de tu aplicación según el propósito de este canal. Longitud máxima: 256 caracteres.
El token se incluye en el encabezado HTTP X-Goog-Channel-Token en cada mensaje de notificación que tu aplicación recibe para este canal.

Si usas tokens de canal de notificaciones, te recomendamos que hagas lo siguiente:
- Usa un formato de codificación extensible, como los parámetros de consulta de la URL. Ejemplo: forwardTo=hr&createdBy=mobile
- No incluyas datos sensibles, como tokens de OAuth.
Nota: Si debes enviar datos muy sensibles, asegúrate de que estén encriptados antes de agregarlos al token.
Es una cadena de propiedad expiration establecida en una marca de tiempo de Unix (en milisegundos) de la fecha y hora en la que deseas que la API del SDK de Admin deje de enviar mensajes para este canal de notificaciones.

Si un canal tiene una hora de vencimiento, se incluye como el valor del encabezado HTTP X-Goog-Channel-Expiration (en formato legible por humanos) en cada mensaje de notificación que recibe tu aplicación para este canal.

Nota: Para la API del SDK de Admin, el tiempo de vencimiento máximo es de 21,600 segundos. Si no configuras la propiedad expiration en tu solicitud, el tiempo de vencimiento predeterminado será de 21,600 segundos después de la hora actual.

Si deseas obtener más detalles sobre la solicitud, consulta el método watch para el recurso Activities en la Referencia de la API.

Mirar respuesta

Si la solicitud de watch crea un canal de notificación correctamente, muestra un código de estado HTTP 200 OK.

El cuerpo del mensaje de la respuesta de observación proporciona información sobre el canal de notificaciones que acabas de crear, como se muestra en el siguiente ejemplo.

{
  "kind": "api#channel",
  "id": "reportsApiId", // ID you specified for this channel.
  "resourceId": "o3hgv1538sdjfh", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 3600, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

Además de las propiedades que enviaste como parte de tu solicitud, la información que se muestra también incluye resourceId y resourceUri para identificar el recurso que se está mirando en este canal de notificaciones.

Nota: La propiedad resourceId es un identificador estable e independiente de la versión para el recurso. La propiedad resourceUri es el URI canónico del recurso supervisado en el contexto de la versión actual de la API, por lo que es específico de la versión.

Puedes pasar la información que se muestra a otras operaciones del canal de notificaciones, por ejemplo, cuando quieras dejar de recibir notificaciones.

Si deseas obtener más detalles sobre la respuesta, consulta el método watch para el recurso Activities en la Referencia de la API.

Mensaje de sincronización

Después de crear un canal de notificaciones para supervisar un recurso, la API del SDK de Admin envía un mensaje sync para indicar que se están iniciando las notificaciones. El valor del encabezado HTTP X-Goog-Resource-State para estos mensajes es sync. Debido a problemas de sincronización de la red, es posible que recibas el mensaje sync incluso antes de recibir la respuesta del método watch.

Puedes ignorar la notificación sync de forma segura, pero también puedes usarla. Por ejemplo, si decides que no quieres conservar el canal, puedes usar los valores X-Goog-Channel-ID y X-Goog-Resource-ID en una llamada para dejar de recibir notificaciones. También puedes usar la notificación sync para realizar la inicialización y prepararte para los eventos posteriores.

A continuación, se muestra el formato de los mensajes de sync que la API del SDK de Admin envía a tu URL de recepción.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

Los mensajes de sincronización siempre tienen un valor de encabezado HTTP X-Goog-Message-Number de 1. Cada notificación posterior de este canal tiene un número de mensaje que es mayor que la anterior, aunque los números de mensaje no serán secuenciales.

Cómo renovar canales de notificaciones

Un canal de notificaciones puede tener una fecha de vencimiento, con un valor determinado por tu solicitud o por cualquier límite interno o predeterminado de la API de Admin (se usa el valor más restrictivo). La fecha de vencimiento del canal, si la tiene, se incluye como una marca de tiempo de Unix (en milisegundos) en la información que muestra el método watch. Además, la fecha y hora de vencimiento se incluyen (en formato legible) en cada mensaje de notificación que recibe tu aplicación para este canal en el encabezado HTTP X-Goog-Channel-Expiration.

Actualmente, no hay una forma automática de renovar un canal de notificaciones. Cuando esté por vencer un canal, deberás reemplazarlo por uno nuevo llamando al método watch. Como siempre, debes usar un valor único para la propiedad id del canal nuevo. Ten en cuenta que es probable que haya un período de “superposición” en el que los dos canales de notificaciones para el mismo recurso están activos.

Recepción de notificaciones

Cada vez que cambia un recurso observado, tu aplicación recibe un mensaje de notificación en el que se describe el cambio. La API del SDK de Admin envía estos mensajes como solicitudes de POST HTTPS a la URL que especificaste como la propiedad address para este canal de notificaciones.

Nota: Las solicitudes HTTPS de entrega de notificaciones especifican un usuario-agente de APIs-Google y respetan las directivas de robots.txt, como se describe en Usuario-agente de las APIs de Google.

Cómo interpretar el formato del mensaje de notificación

Todos los mensajes de notificación incluyen un conjunto de encabezados HTTP que tienen prefijos X-Goog-. Algunos tipos de notificaciones también pueden incluir un cuerpo del mensaje.

Encabezados

Los mensajes de notificación que publica la API del SDK de Admin en tu URL de recepción incluyen los siguientes encabezados HTTP:

Encabezado	Descripción
Siempre presente
`X-Goog-Channel-ID`	UUID o alguna otra cadena única que hayas proporcionado para identificar este canal de notificaciones
`X-Goog-Message-Number`	Es un número entero que identifica este mensaje para este canal de notificaciones. El valor es siempre `1` para los mensajes de `sync`. Los números de mensajes aumentan para cada mensaje posterior en el canal, pero no son secuenciales.
`X-Goog-Resource-ID`	Un valor opaco que identifica el recurso observado. Este ID es estable en todas las versiones de la API.
`X-Goog-Resource-State`	Es el nuevo estado del recurso que activó la notificación. Valores posibles: `sync` o un nombre de evento.
`X-Goog-Resource-URI`	Un identificador específico de la versión de la API para el recurso observado.
A veces está presente
`X-Goog-Channel-Expiration`	Es la fecha y hora de vencimiento del canal de notificación, expresadas en un formato legible. Solo está presente si se define.
`X-Goog-Channel-Token`	Es el token del canal de notificaciones que configuró tu aplicación y que puedes usar para verificar la fuente de la notificación. Solo está presente si se define.

Los mensajes de notificación de las actividades contienen la siguiente información en el cuerpo de la solicitud:

Propiedad	Descripción
`kind`	Identifica esto como un recurso de actividad. Valor: La cadena fija "`admin#reports#activity`".
`id`	Es el identificador único del registro de actividad.
`id.time`	Hora en que ocurrió la actividad. El valor está en el formato de fecha y hora ISO 8601. La hora es la fecha completa más horas, minutos y segundos en el formato AAAA-MM-DDThh:mm:ssZH. Por ejemplo, 2010-04-05T17:30:04+01:00.
`id.uniqueQualifier`	Es un calificador único si varios eventos tienen la misma hora.
`id.applicationName`	Nombre de la aplicación a la que pertenece el evento. Entre los valores posibles, se incluyen los siguientes: admin calendario en automóvil grupos groups_enterprise login móvil saml token user_accounts
`id.customerId`	Es el identificador único de una cuenta de Google Workspace.
`actor`	Usuario que realiza la acción.
`actor.callerType`	Es el tipo de autor que realizó la actividad que se indica en el informe. En esta versión de la API, `callerType` es la solicitud de entidad de OAuth 2LO o `USER` que realizó la acción que se indica en el informe .
`actor.email`	La dirección de correo electrónico principal del usuario cuyas actividades se están denunciando.
`actor.profileId`	El ID único de perfil de Google Workspace del usuario.
`ownerDomain`	Es el dominio de la Consola del administrador o el propietario del documento de la aplicación de Documentos. Este es el dominio que se ve afectado por el evento del informe.
`ipAddress`	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, la cual puede reflejar su ubicación física o no. 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[]`	Eventos de actividad en el informe
`events[].type`	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`.
`events[].name`	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. En general, para los parámetros de solicitud `eventName`: 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`. Es posible que las actividades que se devuelvan tengan otras propiedades `eventName` además de la solicitada.
`events[].parameters[]`	Pares de valores de parámetros para varias aplicaciones.
`events[].parameters[].name`	El nombre del parámetro.
`events[].parameters[].value`	Es el valor de cadena del parámetro.
`events[].parameters[].intValue`	Es el valor entero del parámetro.
`events[].parameters[].boolValue`	Es el valor booleano del parámetro.

Ejemplos

Los mensajes de notificación para los eventos de recursos de actividad tienen el siguiente formato general:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName
X-Goog-Resource-State:  eventName
X-Goog-Message-Number: 10

{
  "kind": "admin#reports#activity",
  "id": {
    "time": datetime,
    "uniqueQualifier": long,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "callerType": string,
    "email": string,
    "profileId": long
  },
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "name": string,
          "value": string,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

Ejemplo de un evento de actividad de administrador:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 596
X-Goog-Channel-ID: reportsApiId
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret987df98743md8g
X-Goog-Resource-URI: https://admin.googleapis.com/admin/reports/v1/activity/users/all/applications/admin?alt=json
X-Goog-Resource-State:  CREATE_USER
X-Goog-Message-Number: 23

{
  "kind": "admin#reports#activity",
  "id": {
    "time": "2013-09-10T18:23:35.808Z",
    "uniqueQualifier": "-0987654321",
    "applicationName": "admin",
    "customerId": "ABCD012345"
  },
  "actor": {
    "callerType": "USER",
    "email": "admin@example.com",
    "profileId": "0123456789987654321"
  },
  "ownerDomain": "apps-reporting.example.com",
  "ipAddress": "192.0.2.0",
  "events": [
    {
      "type": "USER_SETTINGS",
      "name": "CREATE_USER",
      "parameters": [
        {
          "name": "USER_EMAIL",
          "value": "liz@example.com"
        }
      ]
    }
  ]
}

Responder notificaciones

Para indicar que se realizó correctamente, puedes mostrar cualquiera de los siguientes códigos de estado: 200, 201, 202, 204 o 102.

Si tu servicio usa la biblioteca cliente de la API de Google y muestra 500,502, 503 o 504, la API del SDK de Admin vuelve a intentarlo con un tiempo de espera exponencial. Todos los demás códigos de estado de devolución se consideran un error de mensaje.

Comprende los eventos de notificación de la API del SDK de Admin

En esta sección, se proporcionan detalles sobre los mensajes de notificación que puedes recibir cuando usas notificaciones push con la API del SDK de Admin.

Las notificaciones push de la API de Reports contienen dos tipos de mensajes: notificaciones de eventos y mensajes de sincronización. El tipo de mensaje se indica en el encabezado HTTP X-Goog-Resource-State. Los valores posibles para las notificaciones de eventos son los mismos que para el método activities.list. Cada aplicación tiene eventos únicos:

Detener notificaciones

La propiedad expiration controla cuándo se detienen automáticamente las notificaciones. Puedes dejar de recibir notificaciones de un canal en particular antes de que venza llamando al método stop en el siguiente URI:

https://www.googleapis.com/admin/reports_v1/channels/stop

Este método requiere que proporciones al menos el id y las propiedades resourceId del canal, como se muestra en el siguiente ejemplo. Ten en cuenta que, si la API del SDK de Admin tiene varios tipos de recursos que tienen métodos watch, solo hay un método stop.

Solo los usuarios con el permiso correcto pueden detener un canal. En particular:

Si el canal se creó con una cuenta de usuario normal, solo el mismo usuario del mismo cliente (identificado por los ID de cliente OAuth 2.0 de los tokens de autenticación) que creó el canal puede detenerlo.
Si una cuenta de servicio creó el canal, cualquier usuario del mismo cliente puede detenerlo.

En la siguiente muestra de código, se indica cómo dejar de recibir notificaciones:

POST https://www.googleapis.com/admin/reports_v1/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}