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 ID etichetta per limitare le notifiche. Per impostazione predefinita, se non specificato, vengono inviate tutte le modifiche. Se specificato, determina quali etichette sono necessarie per generare una notifica push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Comportamento di filtraggio di labelIds list specificato. Questo campo è deprecato perché in alcuni casi causava un comportamento errato. Utilizza labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Comportamento di filtraggio di labelIds list specificato. Questo campo sostituisce labelFilterAction; se impostato, labelFilterAction viene ignorato.
topicName

string

Un nome argomento API Google Cloud Pub/Sub completo in cui pubblicare gli eventi. Il nome di questo 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 monitoraggio).

Corpo della risposta

Risposta dello smartwatch 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 corrente della casella postale.
expiration

string (int64 format)

Quando Gmail smetterà di inviare notifiche per gli aggiornamenti della casella postale (millisecondi dell'epoca). 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 saperne di più, consulta la OAuth 2.0 Overview.

LabelFilterAction

Comportamento di filtraggio dell'elenco labelIds specificato.

Enum
include Ricevi 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.