Skonfiguruj lub zaktualizuj zegarek z powiadomieniami push w danej skrzynce pocztowej 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 |
Adres e-mail użytkownika. Specjalna wartość |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "labelIds": [ string ], "labelFilterAction": enum ( |
Pola | |
---|---|
labelIds[] |
Lista identyfikatorów etykiet, w przypadku których należy ograniczyć powiadomienia. Domyślnie, jeśli nie określono inaczej, wszystkie zmiany są przekazywane. Jeśli jest określony, określa, które etykiety są wymagane do wygenerowania powiadomienia push. |
labelFilterAction |
Określono sposób filtrowania |
labelFilterBehavior |
Określono sposób filtrowania |
topicName |
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, a musisz mieć już przyznane uprawnienia do publikowania w Gmailu. Przykład: „projekty/identyfikator-mojego-projektu/tematy/nazwa-tematu” (przy użyciu formatu nazw tematów Cloud Pub/Sub „v1”). Pamiętaj, że część „my-project-identifier” musi być dokładnie taka sama jak identyfikator projektu dewelopera Google (identyfikator, który wykonuje to żądanie zegarka). |
Treść odpowiedzi
Odpowiedź na zegarek w powiadomieniach push.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "historyId": string, "expiration": string } |
Pola | |
---|---|
historyId |
Identyfikator bieżącego rekordu historii skrzynki pocztowej. |
expiration |
Kiedy Gmail przestanie wysyłać powiadomienia o aktualizacjach skrzynki pocztowej (epoch millis). Aby odnowić zegarek, zadzwoń do: |
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 po autoryzacji.
LabelFilterAction
Działanie filtrowania w przypadku określonej listy identyfikatorów etykiet.
Wartości w polu enum | |
---|---|
include |
Otrzymuj tylko powiadomienia push o zmianach w wiadomościach dotyczących określonych identyfikatorów etykiet. |
exclude |
Otrzymuj powiadomienia push o wszystkich zmianach w wiadomościach oprócz tych związanych z określonymi identyfikatorami etykiet. |