Method: users.watch

Configura o aggiorna un orologio con notifiche push nella casella di posta dell'utente specificato.

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

string

L'indirizzo email dell'utente. Il valore speciale me può essere utilizzato per indicare l'utente autenticato.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "labelIds": [
    string
  ],
  "labelFilterAction": enum (LabelFilterAction),
  "labelFilterBehavior": enum (LabelFilterAction),
  "topicName": string
}
Campi
labelIds[]

string

Elenco di labelId per i quali limitare le notifiche. Per impostazione predefinita, se non specificato, tutte le modifiche vengono applicate. Se specificato, indica quali etichette sono necessarie per la generazione di una notifica push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

È stato specificato il comportamento di filtro di labelIds list. Questo campo è deprecato perché in alcuni casi causava un comportamento errato. Utilizza labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

È stato specificato il comportamento di filtro di labelIds list. Questo campo sostituisce labelFilterAction; se impostato, labelFilterAction viene ignorato.
topicName

string

Un nome di argomento API Google Cloud Pub/Sub completo a cui pubblicare gli eventi. Il nome dell'argomento deve già esistere in Cloud Pub/Sub e devi aver già concesso a Gmail l'autorizzazione di "pubblicazione". Ad esempio, "projects/my-project-identifier/topics/my-topic-name" (utilizzando il formato di denominazione degli argomenti Cloud Pub/Sub "v1").

Tieni presente che la parte "my-project-identifier" deve corrispondere esattamente all'ID progetto sviluppatore Google (quello che esegue questa richiesta di visualizzazione).

Corpo della risposta

Risposta alle notifiche push sullo smartwatch.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "historyId": string,
  "expiration": string
}
Campi
historyId

string

L'ID del record della cronologia corrente della cassetta di posta.
expiration

string (int64 format)

Quando Gmail smetterà di inviare notifiche per gli aggiornamenti della cassetta di posta (epoch millis). Chiama di nuovo il numero watch prima di questa ora per rinnovare lo smartwatch.

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 di filtro dell'elenco labelIds specificato.

Enum
include Ricevere notifiche push solo per le modifiche ai messaggi relative agli ID etichetta specificati.
exclude Ricevi notifiche push per tutte le modifiche ai messaggi, ad eccezione di quelle relative agli ID etichetta specificati.