- Richiesta HTTP
- Parametri percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- LabelFilterAction
Configura o aggiorna uno smartwatch con notifiche push sulla casella di posta dell'utente.
Richiesta HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
userId |
L'indirizzo email dell'utente. Il valore speciale |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
Campi | |
---|---|
labelIds[] |
Elenco di labelId per i quali limitare le notifiche. Per impostazione predefinita, se questo non è specificato, viene eseguito il push di tutte le modifiche. Se specificato, indica quali etichette sono necessarie per generare una notifica push. |
labelFilterAction |
Comportamento del filtro di |
labelFilterBehavior |
Comportamento del filtro di |
topicName |
Un nome completo qualificato di argomento dell'API Google Cloud Pub/Sub in cui pubblicare gli eventi. Questo nome dell'argomento deve esistere già in Cloud Pub/Sub e devi aver già concesso a Gmail la pubblicazione l'autorizzazione. Ad esempio, "projects/my-project-identifier/topics/my-topic-name". (utilizzando il formato di denominazione degli argomenti "v1" di Cloud Pub/Sub). Tieni presente che il parametro "my-project-identifier" deve corrispondere esattamente all'ID progetto sviluppatore Google (quello che esegue questa richiesta di smartwatch). |
Corpo della risposta
Risposta dello smartwatch per notifica push.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "historyId": string, "expiration": string } |
Campi | |
---|---|
historyId |
L'ID del record della cronologia attuale della casella di posta. |
expiration |
Quando Gmail smetterà di inviare notifiche per gli aggiornamenti della casella di posta (epoca in millisecondi). Richiama |
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
LabelFilterAction
Comportamento del filtro dell'elenco labelId specificato.
Enum | |
---|---|
include |
Ricevi notifiche push solo per le modifiche ai messaggi relative a labelId specificati. |
exclude |
Ricevi notifiche push per tutte le modifiche ai messaggi tranne quelle relative a labelId specificati. |