L'API Mirror consente di iscriversi alle notifiche inviate quando l'utente intraprende azioni specifiche su un elemento della sequenza temporale o quando la posizione dell'utente è stata aggiornata.
Consulta l'elenco dei metodi per questa risorsa alla fine di questa pagina.
Rappresentazioni delle risorse
Un abbonamento agli eventi di 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:// ). |
scrivibile |
collection |
string |
La raccolta a cui iscriverti. I valori consentiti sono:
|
scrivibile |
id |
string |
L'ID dell'abbonamento. | |
kind |
string |
Il tipo di risorsa. È sempre mirror#subscription . |
|
notification |
nested object |
Oggetto container per le notifiche. Questo campo non viene completato 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:
|
|
notification.userActions[] |
list |
Un elenco delle azioni intraprese dall'utente che ha attivato la notifica. | |
notification.userActions[].payload |
string |
Un payload facoltativo per l'azione. Per le azioni di tipo CUSTOM , questo è l'ID della voce di menu personalizzata che è stata selezionata. |
|
notification.userActions[].type |
string |
Il tipo di azione. Il valore può essere:
|
|
notification.userToken |
string |
Il token utente fornito dal servizio al momento della sottoscrizione delle notifiche. | |
notification.verifyToken |
string |
Il token di verifica segreto fornito dal servizio al momento della sottoscrizione delle notifiche. | |
operation[] |
list |
Un elenco delle operazioni da sottoscrivere. Un elenco vuoto indica che dovrebbero essere associate tutte le operazioni sulla raccolta. I valori consentiti sono:
|
scrivibile |
updated |
datetime |
L'ultima modifica dell'abbonamento, formattata secondo la specifica RFC 3339. | |
userToken |
string |
Un token opaco inviato all'abbonato nelle notifiche in modo che possa determinare l'ID dell'utente. | scrivibile |
verifyToken |
string |
Un token segreto inviato all'abbonato nelle notifiche in modo che possa verificare che la notifica sia stata generata da Google. | scrivibile |