Method: users.watch

Skonfiguruj lub zaktualizuj zegarek z powiadomieniami push na skrzynce odbiorczej danego użytkownika.

Żądanie HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/watch

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Adres e-mail użytkownika. Do wskazywania uwierzytelnionego użytkownika można użyć wartości specjalnej me.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

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

string

Lista identyfikatorów labelId, o których chcesz ograniczyć powiadomienia. Jeśli zmiany nie zostaną określone, domyślnie wypchnięto wszystkie zmiany. Jeśli go podasz, określa, które etykiety są wymagane do wygenerowania powiadomienia push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Określono sposób filtrowania: labelIds list. To pole zostało wycofane, ponieważ w niektórych przypadkach powodowało nieprawidłowe działanie. użyj interfejsu labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Określono sposób filtrowania: labelIds list. To pole zastępuje wartość labelFilterAction; Jeśli jest ustawiony, zasada labelFilterAction jest ignorowana.
topicName

string

Pełna i jednoznaczna nazwa tematu interfejsu Google Cloud Pub/Sub API, w którym mają być publikowane zdarzenia. Ta nazwa tematu musi już istnieć w Cloud Pub/Sub i trzeba już wcześniej przyznać Gmailowi „publish” jego uprawnienia. Na przykład „projekty/identyfikator-mojego-projektu/tematy/nazwa-tematu” (z użyciem formatu nazw tematów „v1” w Cloud Pub/Sub).

Pamiętaj, że parametr „my-project-identifier” musi być dokładnie taki sam jak identyfikator projektu dewelopera w Google (z którego pochodzi to żądanie dotyczące zegarka).

Treść odpowiedzi

Odpowiedź zegarka dotycząca powiadomienia push.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "historyId": string,
  "expiration": string
}
Pola
historyId

string

Identyfikator bieżącego rekordu historii skrzynki pocztowej.
expiration

string (int64 format)

Kiedy Gmail przestanie wysyłać powiadomienia o aktualizacjach skrzynki pocztowej (w milisekundach). Aby odnowić zegarek, zadzwoń pod numer watch przed tym terminem.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

LabelFilterAction

Określono zachowanie filtrowania listy identyfikatorów etykiet.

Wartości w polu enum
include Będziesz otrzymywać powiadomienia push tylko o zmianach w wiadomościach związanych z określonymi identyfikatorami etykiet.
exclude Możesz otrzymywać powiadomienia push o wszystkich zmianach w wiadomościach oprócz tych związanych z identyfikatorami labelId.