Subscriptions

L'API Mirror ti consente di iscriverti alle notifiche che vengono inviate quando l'utente intraprende azioni specifiche su un elemento della sequenza temporale o quando la posizione dell'utente è stata aggiornata.

Per un elenco di metodi per questa risorsa, vai alla fine di questa pagina.

Rappresentazioni delle risorse

Un abbonamento a eventi in una raccolta.

{
  "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 proprietà Valore Descrizione Note
callbackUrl string L'URL a cui devono essere inviate le notifiche (deve iniziare con https://). accessibile in scrittura
collection string La raccolta a cui iscriverti. I valori consentiti sono:
  • timeline: modifiche nella sequenza temporale, tra cui inserimento, eliminazione e aggiornamenti.
  • locations - Aggiornamenti sulla posizione.
  • settings - Aggiornamenti delle impostazioni.
 accessibile in scrittura
id string L'ID dell'abbonamento.
kind string Il tipo di risorsa. Il valore è sempre mirror#subscription.
notification nested object Oggetto container per le notifiche. Questo campo non viene compilato nella risorsa Subscription.
notification.collection string La raccolta che ha generato la notifica.
notification.itemId string L'ID dell'elemento che ha generato la notifica.
notification.operation string Il tipo di operazione che ha generato la notifica.

I valori accettati sono:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Un elenco di azioni eseguite dall'utente che ha attivato la notifica.
notification.userActions[].payload string Payload facoltativo per l'azione.

Per le azioni di tipo CUSTOM, questo è l'ID della voce di menu personalizzata selezionata.
notification.userActions[].type string Il tipo di azione. Il valore può essere:
  • SHARE: l'utente ha condiviso un elemento.
  • REPLY: l'utente ha risposto a un elemento.
  • REPLY_ALL: l'utente ha risposto a tutti i destinatari di un articolo.
  • CUSTOM: l'utente ha selezionato una voce di menu personalizzata nella voce della sequenza temporale.
  • DELETE: l'utente ha eliminato l'elemento.
  • PIN: l'utente ha messo in primo piano l'elemento.
  • UNPIN: l'utente ha sbloccato l'elemento.
  • LAUNCH: l'utente ha avviato un comando vocale.
In futuro potrebbero essere aggiunti altri tipi. Le azioni dell'utente con tipi non riconosciuti devono essere ignorate.
notification.userToken string Il token utente fornito dal servizio quando ha sottoscritto l'abbonamento per le notifiche.
notification.verifyToken string Il token di verifica del secret fornito dal servizio al momento dell'iscrizione per le notifiche.
operation[] list Un elenco di operazioni a cui è necessario sottoscrivere un abbonamento. Un elenco vuoto indica che tutte le operazioni sulla raccolta devono essere sottoscritte. I valori consentiti sono:
  • UPDATE: l'elemento è stato aggiornato.
  • INSERT. È stato inserito un nuovo elemento.
  • DELETE: l'elemento è stato eliminato.
 accessibile in scrittura
updated datetime La data e l'ora dell'ultima modifica di questa sottoscrizione, formattata secondo RFC 3339.
userToken string Un token opaco inviato all'abbonato nelle notifiche in modo da poter determinare l'ID dell'utente. accessibile in scrittura
verifyToken string Un token segreto inviato all'abbonato nelle notifiche, in modo che possa verificare che la notifica sia stata generata da Google. accessibile in scrittura

Metodi

elimina
Elimina un abbonamento.
inserisci
Crea un nuovo abbonamento.
list
Recupera un elenco di abbonamenti per l'utente e il servizio autenticati.
aggiorna
Aggiorna un abbonamento esistente.