CalendarList

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

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

Prezentacje zasobów

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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 dostępu, którą uwierzytelniony użytkownik ma w kalendarzu. Tylko do odczytu. Możliwe wartości:
  • „freeBusyReader” – zapewnia dostęp do informacji o dostępności (tylko do odczytu).
  • „reader” – zapewnia dostęp do kalendarza w trybie odczytu. Wydarzenia prywatne będą widoczne dla użytkowników z dostępem do odczytu, ale szczegóły wydarzeń będą ukryte.
  • „writer” – zapewnia uprawnienia do odczytu i zapisu w kalendarzu. Wydarzenia prywatne będą widoczne dla użytkowników z uprawnieniami do edycji, a szczegóły wydarzeń będą widoczne.
  • „owner” – zapewnia menedżerowi dostęp do kalendarza. Ta rola ma wszystkie uprawnienia roli autora, a dodatkowo umożliwia wyświetlanie i modyfikowanie poziomów dostępu innych użytkowników.

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 określić 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 colors). Ta właściwość została zastąpiona przez właściwości backgroundColor i foregroundColor i może być ignorowana, gdy używasz tych właściwości. Opcjonalnie: z możliwością zapisu,
conferenceProperties nested object Ustawienia konferencji dla tego kalendarza, np. rodzaje dozwolonych konferencji.
conferenceProperties.allowedConferenceSolutionTypes[] list Typy rozwiązań konferencyjnych obsługiwane w tym kalendarzu.

Możliwe wartości to:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Opcjonalnie.
dataOwner string Adres e-mail właściciela kalendarza. Ustawiane tylko w przypadku kalendarzy pomocniczych. Tylko do odczytu.
defaultReminders[] list Domyślne przypomnienia, które uwierzytelniony użytkownik ma w tym kalendarzu. z możliwością zapisu,
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.

 z możliwością zapisu,
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, po upływie których ma się pojawić przypomnienie. Prawidłowe wartości to od 0 do 40 320 (4 tygodnie w minutach).

Wymagane podczas dodawania 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 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 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 w formacie dowolnego tekstu. Opcjonalnie: Tylko do odczytu.
notificationSettings object Powiadomienia, które uwierzytelniony użytkownik otrzymuje z tego kalendarza. 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:
  • „email” – powiadomienia są wysyłane e-mailem.

Wymagane podczas dodawania powiadomienia.

 z możliwością zapisu,
notificationSettings.notifications[].type string Typ powiadomienia. Możliwe wartości:
  • „eventCreation” – powiadomienie wysyłane, gdy w kalendarzu pojawi się nowe wydarzenie.
  • „eventChange” – powiadomienie wysyłane, gdy wydarzenie ulegnie zmianie.
  • „eventCancellation” – powiadomienie wysyłane, gdy wydarzenie zostanie anulowane.
  • „eventResponse” – powiadomienie wysyłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • „agenda” – harmonogram z wydarzeniami dnia (wysyłany rano).

Wymagane podczas dodawania powiadomienia.

 z możliwością zapisu,
primary boolean czy kalendarz jest głównym kalendarzem uwierzytelnionego użytkownika; Tylko do odczytu. Opcjonalnie: Wartość domyślna to False (fałsz).
selected boolean czy treści kalendarza są widoczne w interfejsie Kalendarza. Opcjonalnie: Wartość domyślna to False (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.
get
Zwraca kalendarz z listy kalendarzy użytkownika.
wstaw
Wstawia istniejący kalendarz na listę kalendarzy użytkownika.
list
Zwraca kalendarze z listy kalendarzy użytkownika.
patch
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
aktualizować
Aktualizuje istniejący kalendarz na liście kalendarzy użytkownika.
zegarek
Obserwuj zmiany w zasobach CalendarList.