Subscriptions

La API de Mirror te permite suscribirte a las notificaciones que se envían cuando el usuario realiza acciones específicas en un elemento del cronograma o cuando se actualiza la ubicación del usuario.

Para obtener una lista de métodos para este recurso, consulta al final de esta página.

Representaciones de recursos

Una suscripción a eventos de una colección.

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
Nombre de la propiedad Valor Descripción Notas
callbackUrl string Es la URL en la que se deben entregar las notificaciones (debe comenzar con https://). admite escritura
collection string La colección a la que te suscribiste. Los valores permitidos son los siguientes:
  • timeline: Son cambios en el cronograma, incluidas la inserción, la eliminación y las actualizaciones.
  • locations: Actualizaciones de ubicación.
  • settings: actualizaciones de configuración.
 admite escritura
id string El ID de la suscripción.
kind string Es el tipo de recurso. Siempre es mirror#subscription.
notification nested object Objeto de contenedor para notificaciones. No se propaga en el recurso Subscription.
notification.collection string La colección que generó la notificación.
notification.itemId string El ID del elemento que generó la notificación.
notification.operation string El tipo de operación que generó la notificación.

Los valores aceptables son los siguientes:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Una lista de las acciones que realizó el usuario y que activaron la notificación.
notification.userActions[].payload string Una carga útil opcional para la acción.

Para las acciones de tipo CUSTOM, este es el ID del elemento de menú personalizado que se seleccionó.
notification.userActions[].type string El tipo de acción. El valor puede ser el siguiente:
  • SHARE: El usuario compartió un elemento.
  • REPLY: El usuario respondió a un elemento.
  • REPLY_ALL: El usuario respondió a todos los destinatarios de un elemento.
  • CUSTOM: El usuario seleccionó un elemento de menú personalizado en el elemento de cronograma.
  • DELETE: El usuario borró el elemento.
  • PIN: El usuario fijó el elemento.
  • UNPIN: El usuario dejó de fijar el elemento.
  • LAUNCH: El usuario inició un comando por voz.
Es posible que se agreguen tipos adicionales en el futuro. Se deben ignorar UserActions con tipos no reconocidos.
notification.userToken string El token de usuario que proporcionó el servicio cuando se suscribió para recibir notificaciones.
notification.verifyToken string El token de verificación secreto que proporcionó el servicio cuando se suscribió para recibir notificaciones.
operation[] list Una lista de operaciones a las que se debe suscribir. Una lista vacía indica que todas las operaciones de la colección deben estar suscritas. Los valores permitidos son los siguientes:
  • UPDATE: se actualizó el elemento.
  • INSERT: Se insertó un nuevo elemento.
  • DELETE: se borró el elemento.
 admite escritura
updated datetime El momento en que se modificó por última vez esta suscripción, con el formato indicado en RFC 3339.
userToken string Un token opaco que se envía al suscriptor en las notificaciones para que pueda determinar el ID del usuario. admite escritura
verifyToken string Un token secreto que se envía al suscriptor en las notificaciones para que pueda verificar que Google generó la notificación. admite escritura

Métodos

borrar
Borra una suscripción.
insertar
Crea una suscripción nueva.
list
Recupera una lista de suscripciones para el usuario y el servicio autenticados.
actualización
Actualiza una suscripción existente.