Subscriptions

L'API Mirror vous permet de vous abonner aux notifications envoyées lorsque l'utilisateur effectue des actions spécifiques sur un élément de l'historique ou lorsque la position de l'utilisateur a été mise à jour.

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

Abonnement aux événements d'une collection.

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

Nom de propriété	Valeur	Description	Remarques
callbackUrl	string	URL à laquelle les notifications doivent être envoyées (doit commencer par https://).	accessible en écriture
collection	string	Collection à laquelle vous abonner. Valeurs autorisées: timeline : modifications apportées à la chronologie, y compris l'insertion, la suppression et les mises à jour. locations : mises à jour de la position géographique. settings - Mise à jour des paramètres.	accessible en écriture
id	string	ID de l'abonnement.
kind	string	Type de ressource. Il s'agit toujours de mirror#subscription.
notification	nested object	Objet conteneur pour les notifications. Ce champ n'est pas renseigné dans la ressource Subscription.
notification.collection	string	Collection ayant généré la notification.
notification.itemId	string	ID de l'élément ayant généré la notification.
notification.operation	string	Type d'opération ayant généré la notification. Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder"> </ph> "DELETE" "INSERT" "MENU_ACTION" "UPDATE"
notification.userActions[]	list	Liste des actions effectuées par l'utilisateur ayant déclenché la notification.
notification.userActions[].payload	string	Charge utile facultative pour l'action. Pour les actions de type CUSTOM, il s'agit de l'ID de l'élément de menu personnalisé sélectionné.
notification.userActions[].type	string	Type d'action. La valeur de ce paramètre peut être: SHARE : l'utilisateur a partagé un élément. REPLY : l'utilisateur a répondu à un élément. REPLY_ALL : l'utilisateur a répondu à tous les destinataires d'un élément. CUSTOM : l'utilisateur a sélectionné un élément de menu personnalisé sur l'élément de la chronologie. DELETE : l'utilisateur a supprimé l'élément. PIN : l'utilisateur a épinglé l'élément. UNPIN : l'utilisateur a retiré l'élément. LAUNCH : l'utilisateur a lancé une commande vocale. À l'avenir, d'autres types pourront être ajoutés. Les actions utilisateur dont les types ne sont pas reconnus doivent être ignorées.
notification.userToken	string	Jeton d'utilisateur fourni par le service lors de l'abonnement aux notifications.
notification.verifyToken	string	Jeton de validation secret fourni par le service lors de l'abonnement aux notifications.
operation[]	list	Liste des opérations auxquelles s'abonner. Une liste vide indique que toutes les opérations effectuées sur la collection doivent être abonnées. Valeurs autorisées: UPDATE : l'élément a été mis à jour. INSERT : un nouvel article a été inséré. DELETE : l'élément a été supprimé.	accessible en écriture
updated	datetime	Date et heure de la dernière modification de l'abonnement, dans un format conforme à la norme RFC 3339.
userToken	string	Jeton opaque envoyé à l'abonné dans les notifications afin qu'il puisse déterminer l'identifiant de l'utilisateur.	accessible en écriture
verifyToken	string	Jeton secret envoyé à l'abonné dans les notifications pour lui permettre de vérifier que la notification a bien été générée par Google.	accessible en écriture

Méthodes

supprimer

Supprime un abonnement.

insérer

Crée un abonnement.

liste

Récupère la liste des abonnements pour l'utilisateur et le service authentifiés.

mise à jour

Met à jour un abonnement existant.