Calendars

Kolekcja wszystkich istniejących kalendarzy. Zobacz też Kalendarze a CalendarList.

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

Prezentacja 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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
Nazwa usługi Wartość Opis Uwagi
autoAcceptInvitations boolean Określa, czy ten kalendarz automatycznie akceptuje zaproszenia. Dotyczy tylko kalendarzy zasobów.
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 rozmów wideo 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 Tag elementu 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 etykiet zdefiniowane w tym kalendarzu. Jeśli jest określona, zastępuje istniejące właściwości etykiety. Jeśli nie określisz tej wartości, właściwości etykiety pozostaną niezmienione. z możliwością zapisu
labelProperties.eventLabels[] list Etykiety wydarzeń zdefiniowane w tym kalendarzu. Jeśli ta opcja jest obecna podczas aktualizowania kalendarza, zastąpi ona istniejące etykiety wydarzeń.

Rozwiń listę, aby dodać nową etykietę wydarzenia, i usuń elementy z listy, 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 wygenerowany unikalny identyfikator. 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 mieć maksymalnie 50 znaków.

 z możliwością zapisu
location string Położenie geograficzne kalendarza w postaci tekstu w dowolnym formacie. Opcjonalnie. z możliwością zapisu
summary string Nazwa kalendarza. z możliwością zapisu
timeZone string Strefa czasowa kalendarza. (Sformatowana jako nazwa bazy danych stref czasowych IANA, np. „Europe/Zurich”). Opcjonalnie. z możliwością zapisu
workingHours object Reprezentuje informacje o godzinach pracy użytkownika. Ta funkcja jest dostępna tylko w przypadku kalendarzy głównych użytkowników Google Workspace. Aby zaktualizować godziny pracy, należy przekazać cały obiekt godzin pracy. Jeśli nie zostanie określona (lub zostanie przekazana jako wartość null lub pusty obiekt), dotychczasowe godziny pracy pozostaną bez zmian. Aby wyłączyć godziny pracy lub wyczyścić harmonogram, ustaw właściwość workingHoursEnabled na wartość false (i pomiń właściwość availableTimes lub przekaż pustą listę). z możliwością zapisu
workingHours.availableTimes[] list Godziny pracy. Każdy okres dostępności reprezentuje blok godzin pracy użytkownika w ciągu jednego dnia. z możliwością zapisu
workingHours.availableTimes[].dayOfWeek string Dzień tygodnia. Wymagane. Możliwe wartości:
  • „monday”
  • „tuesday”
  • „wednesday”
  • „thursday”
  • „friday”
  • „saturday”
  • „sunday”
z możliwością zapisu
workingHours.availableTimes[].periodEnd integer Koniec okresu, w minutach od początku dnia, bez uwzględniania tej wartości. Wymagane. z możliwością zapisu
workingHours.availableTimes[].periodStart integer Początek okresu, w minutach od początku dnia, włącznie. Wymagane. z możliwością zapisu
workingHours.workingHoursEnabled boolean Określa, czy godziny pracy są włączone w tym kalendarzu. Nie można ustawić wartości „true”, gdy pole availableTimes jest puste. z możliwością zapisu

Metody

clear
Czyści kalendarz główny. Ta operacja powoduje usunięcie wszystkich wydarzeń powiązanych z kalendarzem głównym konta.
usuń
Usuwanie kalendarza pomocniczego. Użyj metody calendars.clear, aby usunąć wszystkie wydarzenia z kalendarzy głównych.
get
Zwraca metadane kalendarza.
insert
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ę poprawek. Pamiętaj, że każde żądanie patch zużywa 3 jednostki limitu. Lepiej użyć metody get, a następnie update. Podane przez Ciebie 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. Powoduje to 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 parametr 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.
update
Aktualizuje metadane kalendarza.