CalendarList

Zbiór kalendarzy na liście kalendarzy użytkownika. Zapoznaj się też z artykułem Kalendarze a lista Kalendarze.

Listę metod dla tego zasobu znajdziesz na końcu tej strony.

Reprezentacje zasobów

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Nazwa usługi Wartość Opis Uwagi
accessRole string Efektywna rola dostępu uwierzytelnionego użytkownika do kalendarza. Tylko do odczytu. Możliwe wartości:
  • „freeBusyReader” - Zapewnia dostęp w trybie odczytu do informacji o stanie Wolny/Zajęty.
  • „reader” – Zapewnia uprawnienia do odczytu kalendarza. Wydarzenia prywatne będą wyświetlane użytkownikom z uprawnieniami do odczytu, ale ich szczegóły będą ukryte.
  • „writer” – Zapewnia uprawnienia do odczytu i zapisu kalendarza. Wydarzenia prywatne będą się wyświetlać użytkownikom z uprawnieniami do zapisu oraz będą widoczne szczegóły wydarzeń.
  • „owner” – Udostępnia prawo własności do kalendarza. Ta rola obejmuje wszystkie uprawnienia zapisującego oraz dodatkowe możliwości wyświetlania list kontroli dostępu i manipulowania nimi.
backgroundColor string Główny kolor kalendarza w formacie szesnastkowym „#0088aa”. Ta właściwość zastępuje opartą na indeksie właściwość colorId. Aby ustawić lub zmienić tę właściwość, musisz określić colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie: z możliwością zapisu
colorId string Kolor kalendarza. To identyfikator odnoszący się do wpisu w sekcji calendar definicji kolorów (patrz punkt końcowy kolorów). Ta właściwość jest zastępowana właściwościami backgroundColor i foregroundColor i można ją zignorować podczas korzystania z tych właściwości. Opcjonalnie: z możliwością zapisu
conferenceProperties nested object Właściwości rozmów wideo w tym kalendarzu, na przykład informacje o dozwolonych typach konferencji.
conferenceProperties.allowedConferenceSolutionTypes[] list Typy rozwiązań konferencyjnych obsługiwanych przez ten kalendarz.

Możliwe wartości to:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcjonalna.
defaultReminders[] list Domyślne przypomnienia dla uwierzytelnionego użytkownika dotyczące tego kalendarza. z możliwością zapisu
defaultReminders[].method string Metoda użyta w tym przypomnieniu. Możliwe wartości:
  • „email” - Przypomnienia są wysyłane e-mailem.
  • „popup” – Przypomnienia są wysyłane przez wyskakujące okienko interfejsu.

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, kiedy powinno wyświetlić się przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40 320 (4 tygodnie w minutach).

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
deleted boolean Określa, czy ten wpis na liście kalendarzy został usunięty z listy kalendarzy. Tylko do odczytu. Opcjonalnie: Wartość domyślna to Fałsz.
description string Opis kalendarza. Opcjonalnie: Tylko do odczytu.
etag etag Tag ETag zasobu.
foregroundColor string Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff”. Ta właściwość zastępuje opartą na indeksie właściwość colorId. Aby ustawić lub zmienić tę właściwość, musisz określić colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie: z możliwością zapisu
hidden boolean Określa, czy kalendarz został ukryty na liście. Opcjonalnie: Atrybut jest zwracany tylko wtedy, gdy kalendarz jest ukryty – w takim przypadku wartość to true. z możliwością zapisu
id string Identyfikator kalendarza.
kind string Typ zasobu („calendar#calendarListEntry”).
location string Lokalizacja geograficzna kalendarza jako dowolny tekst. Opcjonalnie: Tylko do odczytu.
notificationSettings object Powiadomienia o tym kalendarzu odbierane przez uwierzytelnionego użytkownika. z możliwością zapisu
notificationSettings.notifications[] list Lista powiadomień ustawionych dla tego kalendarza.
notificationSettings.notifications[].method string Metoda użyta do przesłania powiadomienia. Możliwa wartość to:
  • „email” – Powiadomienia są wysyłane pocztą e-mail.

Wymagane przy dodawaniu powiadomienia.

 z możliwością zapisu
notificationSettings.notifications[].type string Typ powiadomienia. Możliwe wartości:
  • „eventCreation” – Powiadomienie wysyłane po dodaniu nowego wydarzenia do kalendarza.
  • „eventChange” – Powiadomienie wysyłane po zmianie zdarzenia.
  • „eventCancellation” – Powiadomienie wysyłane po anulowaniu wydarzenia.
  • „eventResponse” – Powiadomienie wysyłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • „agenda” – Plan spotkania z wydarzeniami w danym dniu (wysłany rano).

Wymagane przy dodawaniu powiadomienia.

 z możliwością zapisu
primary boolean Określa, czy kalendarz jest głównym kalendarzem uwierzytelnionego użytkownika. Tylko do odczytu. Opcjonalnie: Wartość domyślna to Fałsz.
selected boolean Określa, czy zawartość kalendarza wyświetla się w interfejsie kalendarza. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
summary string Tytuł kalendarza. Tylko do odczytu.
summaryOverride string Podsumowanie ustawione przez uwierzytelnionego użytkownika dla tego kalendarza. Opcjonalnie: z możliwością zapisu
timeZone string Strefa czasowa kalendarza. Opcjonalnie: Tylko do odczytu.

Metody

usuń
Usuwa kalendarz z listy kalendarzy użytkownika.
pobierz
Zwraca kalendarz z listy kalendarzy użytkownika.
wstaw
Wstawia istniejący kalendarz do listy kalendarzy użytkownika.
list
Zwraca kalendarze na liście kalendarzy użytkownika.
poprawka
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. preferujesz użycie ciągu get, po którym następuje update. Określone przez Ciebie wartości pól zastępują istniejące wartości. Pola, które nie zostaną określone w żądaniu, pozostaną niezmienione. Pola tablicowe (jeśli są określone) zastępują istniejące tablice; powoduje odrzucenie wszystkich poprzednich elementów tablicy.
zaktualizuj
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
zegarek
Wypatruj zmian w zasobach CalendarList.