Notificaciones push

Propiedades obligatorias

Con cada solicitud watch, debes proporcionar lo siguiente:

• Una string de propiedad id que identifica de forma única este nuevo canal de notificación dentro de tu proyecto. Te recomendamos usar un identificador único universal (UUID) o cualquier string ú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 string de propiedad type establecida en el valor web_hook.

• Una string de propiedad address configurada en la URL que escucha y responde las notificaciones de este canal de notificaciones. Esta es tu URL de devolución de llamada de webhook y debe usar HTTPS.

  Ten en cuenta que la API del SDK de Admin podrá 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
  • Los certificados 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:

• Una propiedad token que especifica un valor de string arbitrario para usar como token de canal. Puedes usar tokens de canal de notificaciones para varios propósitos. Por ejemplo, puedes usar el token a fin de verificar que cada mensaje entrante sea para un canal que creó tu aplicación (a fin de 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 búsqueda de URL. Ejemplo: forwardTo=hr&createdBy=mobile

  • No incluyas datos sensibles, como tokens de OAuth.

• Una string de propiedad expiration configurada en una marca de tiempo de Unix (en ms) de la fecha y la hora en que deseas que la API del SDK de Admin deje de enviar mensajes para este canal de notificaciones.

  Si un canal tiene un plazo de vencimiento, se incluye como el valor del encabezado HTTP X-Goog-Channel-Expiration (esta vez en formato legible) en todos los mensajes de notificación que tu aplicación recibe para este canal.

Ver respuesta

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

El cuerpo del mensaje de la respuesta del reloj 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 mira en este canal de notificaciones.

Puedes pasar la información que se muestra a otras operaciones de canal de notificación, como cuando deseas dejar de recibir notificaciones.

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

Sincronizar mensaje

Después de crear un nuevo canal de notificaciones para mirar un recurso, la API del SDK de Admin envía un mensaje sync para indicar que comienzan 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 recibir el mensaje sync incluso antes de recibir la respuesta del método watch.

Es seguro ignorar la notificación de sync, pero también puedes usarla. Por ejemplo, si decides que no deseas mantener 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 a fin de realizar una inicialización para 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 receptora.

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 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 tendrá un número de mensaje mayor que el anterior, aunque los números de mensaje no serán secuenciales.

Renovación de 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 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 ms) en la información que muestra el método watch. Además, se incluyen la fecha y hora de vencimiento (en formato legible) en cada mensaje de notificación que tu aplicación reciba para este canal en el encabezado HTTP X-Goog-Channel-Expiration.

Actualmente, no hay manera automática de renovar un canal de notificación. Cuando un canal está cerca de vencer, debes llamar al método watch para crear uno nuevo. 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.

Información sobre el formato de los mensajes 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 el cuerpo del mensaje.

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

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
        }
      ]
    }
  ]
}

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"
        }
      ]
    }
  ]
}

Cómo responder notificaciones

Para indicar el éxito, 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 la retirada exponencial. El resto del código de estado de devolución se considera un error de mensaje.

Información sobre 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 informes 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:

• administrador
• calendario
• drive
• grupos
• login
• móvil
• saml [saml]
• token
• cuentas_de_usuario