CalendarList: insert

Wstawia istniejący kalendarz na listę kalendarzy użytkownika. Wypróbuj teraz lub zobacz przykład.

Żądanie

Żądanie HTTP

POST https://www.googleapis.com/calendar/v3/users/me/calendarList

Parametry

Nazwa parametru Wartość Opis
Parametry opcjonalne zapytania
colorRgbFormat boolean Określa, czy do zapisywania kolorów kalendarza (RGB) mają być używane pola foregroundColor i backgroundColor. Jeśli ta funkcja jest używana, pole colorId oparte na indeksie zostanie automatycznie ustawione na najlepszą opcję dopasowania. Opcjonalnie: Wartość domyślna to False (fałsz).

Autoryzacja

Ta prośba wymaga autoryzacji z co najmniej jednym z tych zakresów:

Zakres
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist

Więcej informacji znajdziesz na stronie Uwierzytelnianie i autoryzacja.

Treść żądania

W treści żądania podaj zasób CalendarList z tymi właściwościami:

Nazwa usługi Wartość Opis Uwagi
Właściwości wymagane
id string Identyfikator kalendarza.
Właściwości opcjonalne
backgroundColor string Główny kolor kalendarza w formacie szesnastkowym „#0088aa”. Ta właściwość zastępuje właściwość colorId o wartości indeksu. Aby ustawić lub zmienić tę właściwość, musisz podać wartość 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 colors). Ta właściwość została zastąpiona przez właściwości backgroundColor i foregroundColor, więc można ją zignorować. Opcjonalnie: zapisywalny
defaultReminders[] list Domyślne przypomnienia, które uwierzytelniony użytkownik ma w tym kalendarzu. zapisywalny
defaultReminders[].method string Metoda używana przez ten przypomnienie. Możliwe wartości:
  • „email” – przypomnienia są wysyłane pocztą e-mail.
  • „popup” – przypomnienia są wysyłane przez wyskakujące okienko w interfejsie.

Wymagany podczas dodawania przypomnienia.

 zapisywalny
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, w których przypomnienie powinno się aktywować. Dozwolone wartości to 0–40 320 (4 tygodnie w minutach).

Wymagany podczas dodawania przypomnienia.

 zapisywalny
foregroundColor string Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff”. Ta właściwość zastępuje właściwość colorId o wartości indeksu. Aby ustawić lub zmienić tę właściwość, musisz podać wartość colorRgbFormat=true w parametrach metod insert, update i patch. Opcjonalnie: zapisywalny
hidden boolean Określa, czy kalendarz jest ukryty na liście. Opcjonalnie: Atrybut jest zwracany tylko wtedy, gdy kalendarz jest ukryty, a jego wartość to true. zapisywalny
notificationSettings object Powiadomienia, które uwierzytelniony użytkownik otrzymuje z tego kalendarza. zapisywalny
notificationSettings.notifications[].method string Metoda dostarczania powiadomienia. Możliwa wartość:
  • „email” – powiadomienia są wysyłane pocztą e-mail.

Wymagany podczas dodawania powiadomienia.

 zapisywalny
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 po zmianie zdarzenia.
  • „eventCancellation” – powiadomienie wysyłane po anulowaniu wydarzenia.
  • „eventResponse” – powiadomienie wysłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • „agenda” – agenda z wydarzeniami na dany dzień (wysyłana rano).

Wymagany podczas dodawania powiadomienia.

 zapisywalny
selected boolean czy zawartość kalendarza jest widoczna w interfejsie kalendarza. Opcjonalnie: Wartość domyślna to False (fałsz). zapisywalny
summaryOverride string Podsumowanie ustawione przez uwierzytelnionego użytkownika w tym kalendarzu. Opcjonalnie: zapisywalny

Odpowiedź

Jeśli operacja się powiedzie, zwróci ona zasób CalendarList w treści odpowiedzi.

Przykłady

Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.

Java

Korzysta z biblioteki klienta Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create a new calendar list entry
CalendarListEntry calendarListEntry = new CalendarListEntry();
calendarListEntry.setId("calendarId");

// Insert the new calendar list entry
CalendarListEntry createdCalendarListEntry = service.calendarList().insert(calendarListEntry).execute();

System.out.println(createdCalendarListEntry.getSummary());

Python

Korzysta z biblioteki klienta Pythona.

calendar_list_entry = {
    'id': 'calendarId'
}

created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute()

print created_calendar_list_entry['summary']

PHP

Używa biblioteki klienta PHP.

$calendarListEntry = new Google_Service_Calendar_CalendarListEntry();
$calendarListEntry->setId("calendarId");

$createdCalendarListEntry = $service->calendarList->insert($calendarListEntry);

echo $createdCalendarListEntry->getSummary();

Ruby

Używa biblioteki klienta Ruby.

entry = Google::Apis::CalendarV3::CalendarListEntry.new(
 id: 'calendarId'
)

result = client.insert_calendar_list(entry)
print result.summary

Wypróbuj

Aby wywołać tę metodę na podstawie danych na żywo i zobaczyć odpowiedź, użyj narzędzia APIs Explorer.