CalendarList

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Zbiór kalendarzy na liście kalendarzy użytkownika. Zobacz też Kalendarze a Kalendarz.

Listę metod dostępnych 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 Rola efektywnego dostępu uwierzytelnionego użytkownika do kalendarza. Tylko do odczytu. Możliwe wartości:
  • freeBusyReader” – zapewnia dostęp do informacji o stanie Wolny/Zajęty.
  • reader” – zapewnia dostęp do kalendarza w trybie do odczytu. Prywatne wydarzenia będą widoczne dla użytkowników z dostępem do odczytu, ale szczegóły wydarzeń będą ukryte.
  • writer” – daje dostęp do kalendarza z możliwością zapisu i odczytu. Wydarzenia prywatne będą widoczne dla użytkowników z uprawnieniami zapisującego, a ich szczegóły będą widoczne.
  • owner” – określa własność kalendarza. Ta rola ma wszystkie uprawnienia roli zapisującego, a dodatkowo umożliwia wyświetlanie i modyfikowanie list kontroli dostępu.
backgroundColor string Główny kolor kalendarza w formacie szesnastkowym „#0088aa”. Ta właściwość zastępuje usługę colorId opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. zapisywalny
colorId string Kolor kalendarza. Jest 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. Jeśli korzystasz z tych właściwości, możesz je zignorować. Opcjonalnie. zapisywalny
conferenceProperties nested object Konferencyjne właściwości tego kalendarza, na przykład dozwolone typy rozmów wideo.
conferenceProperties.allowedConferenceSolutionTypes[] list Typy rozwiązań do obsługi rozmów wideo, które są obsługiwane w tym kalendarzu.

Możliwe wartości:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcjonalnie.

defaultReminders[] list Domyślne przypomnienia, które użytkownik uwierzytelniony znajdzie w tym kalendarzu. zapisywalny
defaultReminders[].method string Metoda używana przez to przypomnienie. Możliwe wartości:
  • email” – przypomnienia są wysyłane e-mailem.
  • popup” – przypomnienia są wysyłane w wyskakującym okienku interfejsu.

Wymagane podczas dodawania przypomnienia.

zapisywalny
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, w którym powinno się włączyć przypomnienie. Prawidłowe wartości to 0 – 40320 (4 tygodnie w minutach).

Wymagane podczas dodawania przypomnienia.

zapisywalny
deleted boolean Wskazuje, czy ten wpis z listy 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 ETag zasobu.
foregroundColor string Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff”. Ta właściwość zastępuje usługę colorId opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. zapisywalny
hidden boolean Określa, czy kalendarz został ukryty na liście. Opcjonalnie. Wartość jest zwracana tylko wtedy, gdy kalendarz jest ukryty. W takim przypadku wartość to true. zapisywalny
id string Identyfikator kalendarza.
kind string Typ zasobu („calendar#calendarListEntry”).
location string Geograficzna lokalizacja kalendarza jako dowolny tekst. Opcjonalnie. Tylko do odczytu.
notificationSettings object Powiadomienia, które użytkownik uwierzytelniony otrzymuje w przypadku tego kalendarza. zapisywalny
notificationSettings.notifications[] list Lista powiadomień ustawionych dla tego kalendarza.
notificationSettings.notifications[].method string Metoda przesłania powiadomienia. Możliwe wartości:
  • email” – powiadomienia będą wysyłane e-mailem.

Wymagane przy dodawaniu powiadomienia.

zapisywalny
notificationSettings.notifications[].type string Typ powiadomienia. Możliwe wartości:
  • eventCreation” – powiadomienie wysłane, gdy w kalendarzu zostanie dodane nowe wydarzenie
  • eventChange” – powiadomienie o zmianie wydarzenia.
  • eventCancellation” – powiadomienie o anulowaniu wydarzenia.
  • eventResponse” – powiadomienie wysłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • agenda” – plan dnia z wydarzeniami dnia (wysłany rano);

Wymagane przy dodawaniu powiadomienia.

zapisywalny
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 treść kalendarza jest widoczna w interfejsie kalendarza. Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
summary string Tytuł kalendarza. Tylko do odczytu.
summaryOverride string Podsumowanie skonfigurowane przez uwierzytelnionego użytkownika w tym kalendarzu. Opcjonalnie. zapisywalny
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 z listy kalendarzy użytkownika.
poprawka
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Ta metoda obsługuje semantykę poprawki. Zwróć uwagę na to, że każde żądanie poprawki zużywa trzy jednostki limitu. Zalecamy użycie get, a następnie update. Podane wartości pól zastępują istniejące wartości. Pola, których nie określisz w żądaniu, pozostaną bez zmian. Pola tablicowe (jeśli zostały określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
zaktualizuj
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
zegarek
Poszukaj zmian w zasobach CalendarList.