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 la chronologie ou lorsque sa position est 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 à des événements dans 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 de la page sur laquelle les notifications doivent être envoyées (doit commencer par https://)	accessible en écriture
collection	string	Collection à laquelle s'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. settings - Mises à 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 qui a généré la notification.
notification.operation	string	Type d'opération qui a généré la notification. Les valeurs autorisées sont les suivantes : "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 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 timeline. 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 initié une commande vocale. À l'avenir, d'autres types pourront être ajoutés. Les UserActions dont le type n'est pas reconnu doivent être ignorées.
notification.userToken	string	Jeton utilisateur fourni par le service lors de son abonnement aux notifications.
notification.verifyToken	string	Jeton de validation secret fourni par le service lors de son abonnement aux notifications.
operation[]	list	Liste des opérations auxquelles les utilisateurs doivent être abonnés. Une liste vide indique que toutes les opérations de la collection doivent être abonnées. Valeurs autorisées: UPDATE : l'article a été mis à jour. INSERT : un nouvel élément 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 cet abonnement, au format RFC 3339.
userToken	string	Jeton opaque envoyé à l'abonné dans les notifications afin qu'il puisse déterminer l'ID de l'utilisateur.	accessible en écriture
verifyToken	string	Jeton secret envoyé à l'abonné dans les notifications afin qu'il puisse vérifier que la notification a été générée par Google.	accessible en écriture

Méthodes

supprimer

Supprime un abonnement.

insérer

Crée un abonnement.

list

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

mettre à jour

Met à jour un abonnement existant.