Notificaciones push

En este documento, se describe cómo usar las 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 implica sondear los recursos para determinar si cambiaron. Cada vez que cambia un recurso supervisado, 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 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 supervisar.

    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 sobre 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. Una vez que se configuran tus canales de notificaciones, la API del SDK de Admin informa a tu aplicación cuando cambia algún recurso supervisado.

Cómo realizar solicitudes de reloj

Cada recurso de la API del SDK de Admin que se puede observar tiene un método watch asociado en un URI con el siguiente formato:

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

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

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

Ejemplos

Todas las solicitudes de observación del 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",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myFilesChannelDest",
  "payload": true,
  "expiration": 3600
}

El cuerpo de la solicitud tiene las siguientes propiedades:

  • id: Es un UUID o una cadena única similar que identifica este canal.
  • type: Es el tipo de mecanismo de entrega. El valor de este campo debe ser web_hook.
  • address: Es la URL a la que se envían las notificaciones.
  • token: Es una cadena arbitraria que se entrega a la dirección de destino con cada notificación para verificar que la notificación provenga de una fuente confiable.
  • payload: Es una marca booleana que indica si la carga útil se debe incluir en la notificación.
  • expiration: Es el tiempo de vida útil en segundos del canal de notificaciones.

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

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

Supervisa todas las actividades del administrador:

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

Supervisa todas las actividades de los documentos:

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

Para supervisar la actividad de administrador de un usuario específico, haz lo siguiente:

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

Observa 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 los siguientes campos:

  • Es una cadena de propiedad id que identifica de forma única este nuevo canal de notificaciones dentro de tu proyecto. Recomendamos usar un identificador único universal (UUID) o cualquier cadena única similar. La longitud máxima es de 64 caracteres.

    El valor del ID que estableces se devuelve en el encabezado HTTP X-Goog-Channel-Id de cada mensaje de notificación que recibes para este canal.

  • Es una cadena de propiedad type establecida en el valor web_hook.

  • Es una cadena de propiedad de 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 del 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 de canales de notificación para varios propósitos. 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 suplante la notificación, o bien 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 recibe tu aplicación para este canal.

    Si usas tokens de canales de notificación, te recomendamos que hagas lo siguiente:

    • Usa un formato de codificación extensible, como los parámetros de consulta de URL. Ejemplo: forwardTo=hr&createdBy=mobile

    • No incluyas datos sensibles, como tokens de OAuth.

  • Es una cadena de propiedad expiration establecida en una marca de tiempo de Unix (en milisegundos) de la fecha y hora en 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 para las personas) en cada mensaje de notificación que recibe tu aplicación para este canal.

Para obtener más detalles sobre la solicitud, consulta el método watch del recurso Activities en la referencia de la API.

Respuesta del reloj

Si la solicitud watch crea correctamente un canal de notificaciones, devuelve 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",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://admin.googleapis.com/admin/reports/v1/activity/userKey/applications/applicationName",
  "token": "target=myApp-myFilesChannelDest",
  "expiration": 3600
}

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

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

Para obtener más detalles sobre la respuesta, consulta el método watch del recurso Activities en la referencia de la API.

Mensaje de sincronización

Después de crear un canal de notificaciones para observar 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 de sync, 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 a dejar de recibir notificaciones. También puedes usar la notificación sync para realizar alguna inicialización y prepararte para 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 mayor que el anterior, aunque los números de mensaje no serán secuenciales.

Renueva los canales de notificaciones

Un canal de notificación puede tener una hora de vencimiento, con un valor determinado por tu solicitud o por los límites o valores predeterminados internos de cualquier API del SDK de Admin (se usa el valor más restrictivo). La hora de vencimiento del canal, si tiene una, 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 tu aplicación recibe 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 un canal esté cerca de vencer, debes 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 notificación para el mismo recurso estén activos.

Recibir notificaciones

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

Interpreta 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 Es el UUID o alguna otra cadena única que proporcionaste para identificar este canal de notificación.
X-Goog-Message-Number Es un número entero que identifica este mensaje para este canal de notificaciones. El valor siempre es 1 para los mensajes sync. Los números de los mensajes aumentan para cada mensaje posterior en el canal, pero no son secuenciales.
X-Goog-Resource-ID Es 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 estado del recurso nuevo que activó la notificación. Los valores posibles son: sync o un nombre de evento.
X-Goog-Resource-URI Es un identificador específico de la versión de la API para el recurso observado.
A veces presente
X-Goog-Channel-Expiration Fecha y hora de vencimiento del canal de notificación, expresadas en formato legible. Solo está presente si se define.
X-Goog-Channel-Token Es el token del canal de notificación 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 este objeto como un recurso de Activity. Valor: La cadena fija "admin#reports#activity".
id Es el identificador único del registro de actividad.
id.time Es la hora en que ocurrió la actividad. El valor está en formato de fecha y hora ISO 8601. La hora es la fecha completa más horas, minutos y segundos en el formato AAAAMMDDThh:mm:ssTZD. 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. Los valores posibles incluyen los siguientes:
id.customerId Es el identificador único de una cuenta de Google Workspace.
actor Es el 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 la entidad USER o de OAuth 2LO que realizó la acción que se indica en el informe .
actor.email Es la dirección de correo electrónico principal del usuario cuyas actividades se registran.
actor.profileId Es el ID único del perfil de Google Workspace del usuario.
ownerDomain Es el dominio de la Consola del administrador o del propietario del documento de la aplicación de Documentos. Es el dominio afectado por el evento del informe.
ipAddress Es la dirección IP del usuario que realiza la acción. Esta es la dirección de Protocolo de Internet (IP) del usuario cuando accede a Google Workspace, que puede reflejar o no su ubicación física. Por ejemplo, la dirección IP puede ser la dirección del servidor proxy del usuario o la dirección de una red privada virtual (VPN). La API admite IPv4 y IPv6.
events[] Son los eventos de actividad incluidos en el informe.
events[].type 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.
events[].name 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 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. Es posible que las actividades devueltas tengan otras propiedades de eventName además de la solicitada.
events[].parameters[] Son pares de valores de parámetros para diversas 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 Activity tienen la siguiente forma general:

POST https://mydomain.com/notifications
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 del administrador:

POST https://mydomain.com/notifications
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 la operación se realizó correctamente, puedes devolver 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 devuelve 500,502, 503 o 504, la API del SDK de Admin vuelve a intentarlo con retraso exponencial. Todos los demás códigos de estado de devolución se consideran errores 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: mensajes de sincronización y notificaciones de eventos. 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 las notificaciones automáticamente. 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 las propiedades id y 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 adecuado pueden detener un canal. En particular:

  • Si el canal se creó con una cuenta de usuario normal, solo el mismo usuario desde el mismo cliente (identificado por los IDs de cliente de OAuth 2.0 de los tokens de autorización) que creó el canal puede detenerlo.
  • Si el canal se creó con una cuenta de servicio, 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"
}