Method: users.watch

Skonfiguruj lub zaktualizuj powiadomienia push na zegarku 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, w przypadku których powiadomienia mają być ograniczone. Domyślnie, jeśli nie określono inaczej, wszystkie zmiany są wypychane. Jeśli jest określony, decyduje o tym, 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. Zamiast niego używaj pola labelFilterBehavior.
labelFilterBehavior

enum (LabelFilterAction)

Określono sposób filtrowania labelIds list. To pole zastępuje pole labelFilterAction. Jeśli 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. Ten temat musi już istnieć w Cloud Pub/Sub, a Ty musisz mieć już przyznane uprawnienia do publikowania w nim. Na przykład „projects/my-project-identifier/topics/my-topic-name” (przy użyciu formatu nazewnictwa tematu Cloud Pub/Sub „v1”).

Pamiętaj, że część „my-project-identifier” musi być dokładnie taka sama jak identyfikator Twojego projektu Google dla deweloperów (tego, który wykonuje to żądanie obserwowania).

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)

Moment, w którym Gmail przestanie wysyłać powiadomienia o aktualizacjach skrzynki pocztowej (w milisekundach od początku epoki). Zadzwoń pod numer watch przed upływem tego czasu, aby odnowić zegarek.

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 sekcji OAuth 2.0 Overview.

LabelFilterAction

Określono sposób filtrowania listy labelIds.

Wartości w polu enum
include Otrzymuj powiadomienia push tylko o zmianach w wiadomościach powiązanych z określonymi identyfikatorami etykiet.
exclude Otrzymuj powiadomienia push o wszystkich zmianach w wiadomościach z wyjątkiem tych, które dotyczą określonych identyfikatorów etykiet.