Method: users.watch

Konfigurowanie lub aktualizowanie powiadomień push w skrzynce pocztowej 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. Wartość specjalna me może służyć do wskazywania uwierzytelnionego użytkownika.

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 etykiet, dla których mają być ograniczane powiadomienia. Domyślnie, jeśli nie określisz inaczej, wszystkie zmiany są przesyłane. Jeśli jest określony, określa, które etykiety są wymagane do wygenerowania powiadomienia push.
labelFilterAction
(deprecated)

enum (LabelFilterAction)

Określ działanie filtra labelIds list. To pole zostało wycofane, ponieważ w niektórych przypadkach powodowało nieprawidłowe działanie. Zamiast niego używaj pola labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Określ działanie filtra labelIds list. To pole zastępuje pole labelFilterAction. Jeśli to pole jest ustawione, pole labelFilterAction jest ignorowane.
topicName

string

W pełni kwalifikowana 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, a Ty musisz mieć już przyznane uprawnienia „publikowania” dla usługi Gmail. Na przykład „projekty/identyfikator_projektu/tematy/nazwa_tematu” (w formacie nazewnictwa tematów w Cloud Pub/Sub w wersji „1”).

Pamiętaj, że część „my-project-identifier” musi dokładnie odpowiadać identyfikatorowi Twojego projektu dewelopera Google (identyfikatorowi, który wykonuje to żądanie monitorowania).

Treść odpowiedzi

Odpowiedź na powiadomienie push na zegarku.

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 zmianach w skrzynce pocztowej (w milisekundach ery) Aby odnowić subskrypcję zegarka, zadzwoń ponownie na numer watch przed upływem tego czasu.

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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 dotyczącym autoryzacji.

LabelFilterAction

Sposób filtrowania listy etykiet (labelIds)

Wartości w polu enum
include otrzymywać powiadomienia push tylko w przypadku zmian wiadomości związanych z określonymi identyfikatorami etykiet.
exclude Otrzymywać powiadomienia push o wszystkich zmianach wiadomości z wyjątkiem tych dotyczących określonych identyfikatorów etykiet.