Calendars

Zbiór wszystkich istniejących kalendarzy. Zobacz też Kalendarze a CalendarList.

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

Reprezentacje zasobów

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
Nazwa usługi Wartość Opis Uwagi
autoAcceptInvitations boolean Określa, czy ten kalendarz automatycznie akceptuje zaproszenia. Dotyczy tylko kalendarzy zasobów.
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.
description string Opis kalendarza. Opcjonalnie. z możliwością zapisu,
etag etag ETag zasobu.
id string Identyfikator kalendarza. Aby pobrać identyfikatory, wywołaj metodę calendarList.list().
kind string Typ zasobu („calendar#calendar”).
labelProperties nested object Właściwości etykiety zdefiniowane w tym kalendarzu. Jeśli jest określona, zastępuje istniejące właściwości etykiety. Jeśli nie określisz tego ustawienia, właściwości etykiety pozostaną niezmienione. z możliwością zapisu,
labelProperties.eventLabels[] list Etykiety wydarzeń zdefiniowane w tym kalendarzu. Jeśli ten parametr jest obecny podczas aktualizowania kalendarza, zastąpi istniejące etykiety wydarzeń.

Rozwiń listę, aby dodać nową etykietę wydarzenia, i usuń z niej elementy, aby usunąć etykietę z kalendarza.

Każdy kalendarz może mieć maksymalnie 200 etykiet.

z możliwością zapisu,
labelProperties.eventLabels[].backgroundColor string Kolor tła etykiety w formacie szesnastkowym, np. "#039be5". Wydarzenia z tą etykietą są wyświetlane w tym kolorze. Wymagane. z możliwością zapisu,
labelProperties.eventLabels[].id string Identyfikator etykiety. Opcjonalne podczas wstawiania nowej etykiety. Jeśli nie podasz identyfikatora, zostanie on wygenerowany. Wymagane podczas aktualizowania etykiety.

Jeśli podasz identyfikator, musi on być unikalny w kalendarzu i mieć format UUID.

z możliwością zapisu,
labelProperties.eventLabels[].name string Nazwa etykiety. Opcjonalnie.

Jeśli podasz tę wartość, może ona zawierać maksymalnie 50 znaków.

z możliwością zapisu,
location string Położenie geograficzne kalendarza w formacie dowolnego tekstu. Opcjonalnie. z możliwością zapisu,
summary string Tytuł kalendarza. z możliwością zapisu,
timeZone string Strefa czasowa kalendarza. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). Opcjonalnie. z możliwością zapisu,

Metody

wyczyść
Czyści kalendarz główny. Ta operacja usuwa wszystkie wydarzenia powiązane z kalendarzem głównym konta.
usuń
Usuwa kalendarz pomocniczy. Użyj metody calendars.clear, aby usunąć wszystkie wydarzenia z kalendarzy głównych.
get
Zwraca metadane kalendarza.
wstaw
Tworzy kalendarz pomocniczy.

Uwierzytelniony użytkownik, który wysłał żądanie, staje się właścicielem danych nowego kalendarza.

patch
Aktualizuje metadane kalendarza. 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ą bez zmian. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
transferOwnership
Przenosi kalendarz pomocniczy między użytkownikami w organizacji Google Workspace. Wymaga uwierzytelnienia użytkownika z uprawnieniami administratora Zarządzanie kalendarzami i jednym z tych zakresów autoryzacji:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
 W żądaniu ustaw wartość useAdminAccess na true. Aby można było przenieść kalendarz pomocniczy, musi on być aktywny. Przenoszenie wyłączonych lub usuniętych kalendarzy nie jest obsługiwane.
aktualizować
Aktualizuje metadane kalendarza.