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.

Si quieres obtener una lista de métodos para este recurso, consulta el final de esta página.

Representaciones de recursos

Una suscripción a eventos en 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 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 quieres suscribir. Los valores permitidos son:
  • timeline: Cambios en el cronograma que incluyen la inserción, la eliminación y las actualizaciones.
  • locations: actualizaciones de ubicación.
  • settings: actualizaciones de configuración.
 admite escritura
id string Es el ID de la suscripción.
kind string El tipo de recurso. Siempre es mirror#subscription.
notification nested object Objeto contenedor para notificaciones. Esto no se propaga en el recurso Subscription.
notification.collection string La colección que generó la notificación.
notification.itemId string Es el ID del artículo 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 acciones realizadas por el usuario que activó la notificación.
notification.userActions[].payload string Una carga útil opcional para la acción.

Para acciones de tipo CUSTOM, este es el ID del elemento de menú personalizado que se seleccionó.
notification.userActions[].type string Es el tipo de acción. El valor puede ser:
  • 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 más tipos en el futuro. Se deben ignorar UserActions con tipos no reconocidos.
notification.userToken string El token de usuario que proporciona el servicio cuando se suscribe para recibir notificaciones.
notification.verifyToken string El token de verificación secreto que proporciona el servicio cuando se suscribe a las 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:
  • UPDATE: se actualizó el elemento.
  • INSERT: Se insertó un nuevo elemento.
  • DELETE: el elemento se ha eliminado.
 admite escritura
updated datetime El momento en que se modificó esta suscripción por última vez, según el formato RFC 3339.
userToken string Un token opaco enviado al suscriptor en notificaciones para que pueda determinar el ID del usuario. admite escritura
verifyToken string Un token secreto enviado al suscriptor en notificaciones para que pueda verificar que la generó Google. 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.
actualizar
Actualiza la suscripción existente.