Obserwuj zmiany w zasobach wydarzeń.
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
Parametry
Nazwa parametru | Wartość | Opis |
---|---|---|
Parametry ścieżki | ||
calendarId |
string |
Identyfikator kalendarza. Aby pobrać identyfikatory kalendarzy, wywołaj metodę calendarList.list. Jeśli chcesz uzyskać dostęp do kalendarza głównego obecnie zalogowanego użytkownika, użyj narzędzia „primary ” słowa kluczowego.
|
Opcjonalne parametry zapytania | ||
eventTypes |
string |
Typy zdarzeń dotyczące zasobów do obserwowania. Opcjonalnie: Ten parametr można powtarzać wiele razy, aby obserwować zasoby różnego typu. Jeśli zasada jest nieskonfigurowana, zwraca wszystkie typy zdarzeń.
Akceptowane wartości to:
|
Autoryzacja
To żądanie zezwala na autoryzację z co najmniej jednym z tych zakresów:
Zakres |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events.readonly |
https://www.googleapis.com/auth/calendar.events |
Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.
Treść żądania
Dane w treści żądania podaj w następującej strukturze:
{ "id": string, "token": string, "type": string, "address": string, "params": { "ttl": string } }
Nazwa usługi | Wartość | Opis | Uwagi |
---|---|---|---|
id |
string |
identyfikator UUID lub podobny, unikalny ciąg znaków identyfikujący ten kanał; | |
token |
string |
Dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem przesłanym przez ten kanał. Opcjonalnie: | |
type |
string |
Typ mechanizmu wyświetlania stosowanego w przypadku tego kanału. Prawidłowe wartości to „web_hook ” (lub „webhook ”). Obie wartości odnoszą się do kanału, w którym żądania HTTP są używane do dostarczania wiadomości. |
|
address |
string |
Adres, na który są dostarczane powiadomienia z tego kanału. | |
params |
object |
Dodatkowe parametry kontrolujące zachowanie kanału wyświetlania. Opcjonalnie: | |
params.ttl |
string |
Czas życia w sekundach dla kanału powiadomień. Wartość domyślna to 60 4 800 sekund. |
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
Nazwa usługi | Wartość | Opis | Uwagi |
---|---|---|---|
kind |
string |
Identyfikuje go jako kanał powiadomień używany do obserwowania zmian w zasobie, czyli „api#channel ”. |
|
id |
string |
identyfikator UUID lub podobny, unikalny ciąg znaków identyfikujący ten kanał; | |
resourceId |
string |
Nieprzejrzysty identyfikator określający zasób oglądany na tym kanale. Stabilny w różnych wersjach interfejsu API. | |
resourceUri |
string |
Identyfikator wersji monitorowanego zasobu. | |
token |
string |
Dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem przesłanym przez ten kanał. Opcjonalnie: | |
expiration |
long |
Data i godzina wygaśnięcia kanału powiadomień wyrażona jako sygnatura czasowa systemu Unix w milisekundach. Opcjonalnie: |