Events: watch

Szukaj zmian w zasobach zdarzeń.

Prośba

Żą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 aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary”.
Opcjonalne parametry zapytania
eventTypes string Typy wydarzeń, które warto obserwować. Opcjonalnie. Ten parametr można powtarzać wiele razy, aby obserwować zasoby różnych typów. Jeśli zasada jest nieskonfigurowana, zwraca wszystkie typy zdarzeń.

Akceptowane wartości:
  • default”: zwykłe wydarzenia.
  • focusTime”: wydarzenia typu czas skupienia.
  • outOfOffice”: wydarzenia poza biurem.
  • workingLocation”: zdarzenia dotyczące lokalizacji miejsca pracy.

Upoważnienie

To żądanie umożliwia 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 Uwierzytelnianie i autoryzacja.

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 UUID lub podobny unikalny ciąg znaków, który identyfikuje ten kanał.
token string Dowolny ciąg znaków dostarczany na adres docelowy w każdym powiadomieniu wysyłanym na ten kanał. Opcjonalnie.
type string Typ mechanizmu przesyłania używany w tym kanale. 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 dotyczące tego kanału.
params object Dodatkowe parametry kontrolujące działanie kanału wyświetlania. Opcjonalnie.
params.ttl string Wyrażony w sekundach czas życia danych dla kanału powiadomień. Wartość domyślna to 60 4800 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 to jako kanał powiadomień służący do monitorowania zmian w zasobie „api#channel”.
id string UUID lub podobny unikalny ciąg znaków, który identyfikuje ten kanał.
resourceId string Nieprzezroczysty identyfikator identyfikujący zasób, który jest oglądany na tym kanale. Stabilność w różnych wersjach interfejsu API.
resourceUri string Identyfikator wersji obserwowanego zasobu.
token string Dowolny ciąg znaków dostarczany na adres docelowy w każdym powiadomieniu wysyłanym na ten kanał. Opcjonalnie.
expiration long Data i godzina wygaśnięcia kanału powiadomień, wyrażone w postaci sygnatury czasowej uniksowej (w milisekundach). Opcjonalnie.