Subscriptions

A API Mirror permite que você se inscreva para receber notificações enviadas quando o usuário realiza ações específicas em um item do cronograma ou quando o local do usuário é atualizado.

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

Representações de recursos

Uma assinatura de 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 devem ser entregues (precisa começar com https://).	gravável
collection	string	A coleção em que você quer se inscrever. Os valores permitidos são: timeline: mudanças no cronograma, incluindo inserção, exclusão e atualizações. locations: atualizações de localização. settings: configurações atualizadas.	gravável
id	string	É o ID da assinatura.
kind	string	O tipo de recurso. É sempre mirror#subscription.
notification	nested object	Objeto de 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	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 das 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, esse é o ID do item de menu personalizado que foi selecionado.
notification.userActions[].type	string	O tipo de ação. O 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 desmarcou 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 ao assinar as notificações.
notification.verifyToken	string	O token de verificação do secret fornecido pelo serviço quando ele se inscreveu para receber notificações.
operation[]	list	Uma lista de operações para inscrição. Uma lista vazia indica que todas as operações na coleção precisam estar 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	É o horário em que a assinatura foi modificada pela última vez, formatada de acordo com a 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 para o usuário e o serviço autenticados.

update

Atualiza uma assinatura já existente.