Kolekcja kalendarzy na liście kalendarzy użytkownika. Zobacz też Porównanie Kalendarza i Kalendarza.
Listę metod dostępnych w przypadku 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 |
Obowiązująca rola dostępu przypisana do kalendarza uwierzytelnionego użytkownika. Tylko do odczytu. Możliwe wartości:
|
|
backgroundColor |
string |
Główny kolor kalendarza w formacie szesnastkowym „#0088aa ”. Ta właściwość zastępuje właściwość colorId opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. |
z możliwością zapisu |
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 oraz foregroundColor i można ją zignorować, jeśli korzystasz z tych właściwości. Opcjonalnie. |
z możliwością zapisu |
conferenceProperties |
nested object |
Właściwości konferencji w tym kalendarzu, na przykład dozwolone typy konferencji. | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
Typy rozwiązań do obsługi konferencji, które są obsługiwane w tym kalendarzu. Możliwe wartości to:
|
|
defaultReminders[] |
list |
Domyślne przypomnienia dla tego kalendarza dla uwierzytelnionego użytkownika. | z możliwością zapisu |
defaultReminders[].method |
string |
Metoda używana przez to przypomnienie. Możliwe wartości:
Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
defaultReminders[].minutes |
integer |
Liczba minut przed rozpoczęciem wydarzenia, na którą powinno zostać aktywowane przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40320 (4 tygodnie w minutach). Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu |
deleted |
boolean |
Określa, czy wpis na liście kalendarzy został usunięty z listy. Tylko do odczytu. Opcjonalnie. Wartością domyślną jest False (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 właściwość colorId opartą na indeksie. Aby ustawić lub zmienić tę właściwość, musisz podać colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie. |
z możliwością zapisu |
id |
string |
Identyfikator kalendarza. | |
kind |
string |
Typ zasobu („calendar#calendarListEntry”). | |
location |
string |
Położenie geograficzne kalendarza w postaci tekstu dowolnego. Opcjonalnie. Tylko do odczytu. | |
notificationSettings |
object |
Powiadomienia o tym kalendarzu wysyłane 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 dostarczenia powiadomienia. Możliwa wartość to:
Wymagane podczas dodawania powiadomienia. |
z możliwością zapisu |
notificationSettings.notifications[].type |
string |
Typ powiadomienia. Możliwe wartości:
Wymagane podczas dodawania powiadomienia. |
z możliwością zapisu |
primary |
boolean |
Określa, czy kalendarz jest głównym kalendarzem uwierzytelnionego użytkownika. Tylko do odczytu. Opcjonalnie. Wartością domyślną jest False (Fałsz). | |
selected |
boolean |
Czy zawartość kalendarza wyświetla się w jego interfejsie. Opcjonalnie. Wartością domyślną jest False (Fałsz). | z możliwością zapisu |
summary |
string |
Nazwa kalendarza. Tylko do odczytu. | |
summaryOverride |
string |
Podsumowanie ustawione przez uwierzytelniony użytkownik 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 na listę 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. Lepiej użyć obiektu
get
, po którym następujeupdate
. Określone przez Ciebie wartości pól zastępują obecne wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy. - aktualizacja
- Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
- zegarek
- Obserwuj zmiany w zasobach CalendarList.