Subscriptions

Com a API Mirror, você pode se inscrever para receber notificações enviadas quando o usuário realiza ações específicas em um item da linha do tempo ou quando a localização dele é atualizada.

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Uma assinatura para eventos em uma coleção.

{
  "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
  }
}
Nome da propriedade Valor Descrição Observações
callbackUrl string O URL em que as notificações serão entregues (precisa começar com https://). gravável
collection string A coleção na qual se inscrever. Os valores permitidos são:
  • timeline: mudanças na linha do tempo, incluindo inserção, exclusão e atualizações.
  • locations: atualizações de localização.
  • settings - Atualizações de configurações.
 gravável
id string O ID da assinatura.
kind string O tipo de recurso. É sempre mirror#subscription.
notification nested object Objeto contêiner para notificações. Isso não é preenchido no recurso Subscription.
notification.collection string A coleção que gerou a notificação.
notification.itemId string O ID do item que gerou a notificação.
notification.operation string O tipo de operação que gerou a notificação.

Os valores aceitáveis são:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Uma lista de ações realizadas pelo usuário que acionou a notificação.
notification.userActions[].payload string Um payload opcional para a ação.

Para ações do tipo CUSTOM, este é o ID do item de menu personalizado que foi selecionado.
notification.userActions[].type string O tipo de ação. Esse valor pode ser:
  • SHARE: o usuário compartilhou um item.
  • REPLY: o usuário respondeu a um item.
  • REPLY_ALL: o usuário respondeu a todos os destinatários de um item.
  • CUSTOM: o usuário selecionou um item de menu personalizado no item da linha do tempo.
  • DELETE: o usuário excluiu o item.
  • PIN: o usuário fixou o item.
  • UNPIN: o usuário liberou o item.
  • LAUNCH: o usuário iniciou um comando de voz.
No futuro, outros tipos poderão ser adicionados. As ações do usuário com tipos não reconhecidos devem ser ignoradas.
notification.userToken string O token de usuário fornecido pelo serviço quando ele se inscreveu para notificações.
notification.verifyToken string O token de verificação secreto fornecido pelo serviço quando ele se inscreveu para receber notificações.
operation[] list Uma lista de operações nas quais é preciso se inscrever. Uma lista vazia indica que todas as operações na coleção devem ser inscritas. Os valores permitidos são:
  • UPDATE: o item foi atualizado.
  • INSERT: um novo item foi inserido.
  • DELETE: o item foi excluído.
 gravável
updated datetime A hora em que esta assinatura foi modificada pela última vez, formatada de acordo com RFC 3339.
userToken string Um token opaco enviado ao assinante nas notificações para que ele possa determinar o ID do usuário. gravável
verifyToken string Um token secreto enviado ao assinante nas notificações para que ele possa verificar se a notificação foi gerada pelo Google. gravável

Métodos

delete
Exclui uma assinatura.
inserir
Cria uma nova assinatura.
list
Recupera uma lista de assinaturas do serviço e do usuário autenticado.
update
Atualiza uma assinatura em vigor.