Method: users.watch

Configura o aggiorna uno smartwatch per le notifiche push nella casella di posta dell'utente specificata.

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. È possibile utilizzare il valore speciale me 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 etichetteId per cui limitare le notifiche. Per impostazione predefinita, se non specificate, tutte le modifiche vengono inviate tramite push. Se specificato, determina quali etichette sono necessarie per la generazione di una notifica push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

È stato specificato il comportamento del filtro per labelIds list. Questo campo è deprecato perché in alcuni casi ha causato comportamenti non corretti. Utilizza il campo labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

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

string

Un nome completo dell'argomento dell'API Google Cloud Pub/Sub in cui pubblicare gli eventi. Il nome di questo argomento deve esistere già 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" (con il formato di denominazione degli argomenti "v1" di Cloud Pub/Sub).

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

Corpo della risposta

Risposta dell'orologio alla 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

string

L'ID del record della cronologia attuale della casella di posta.
expiration

string (int64 format)

Quando Gmail interromperà l'invio di notifiche per gli aggiornamenti delle caselle di posta (epoca in millisecondi). Chiama di nuovo watch prima di questo orario 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 alle autorizzazioni.

LabelFilterAction

Comportamento di filtro dell'elenco labelIds specificato.

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