CalendarList: insert

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

Prośba

Żądanie HTTP

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

Parametry

Nazwa parametru Wartość Opis
Opcjonalne parametry zapytania
colorRgbFormat boolean Określa, czy pola foregroundColor i backgroundColor mają być używane do wpisywania kolorów kalendarza (RGB). Jeśli używasz tej funkcji, oparte na indeksie pole colorId zostanie automatycznie ustawione na najlepszą opcję dopasowania. Opcjonalnie. Wartością domyślną jest False (Fałsz).

Upoważnienie

To żądanie wymaga autoryzacji w tym zakresie:

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

Więcej informacji znajdziesz na stronie uwierzytelniania i autoryzacji.

Treść żądania

W treści żądania podaj zasób Kalendarza 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 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
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:
  • email” – przypomnienia są wysyłane e-mailem.
  • popup” – przypomnienia są wysyłane w wyskakującym okienku w interfejsie.

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
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
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
notificationSettings object Powiadomienia o tym kalendarzu wysyłane przez uwierzytelnionego użytkownika. z możliwością zapisu
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 po zmianie wydarzenia.
  • eventCancellation” – powiadomienie wysłane po anulowaniu wydarzenia.
  • eventResponse” – powiadomienie wysyłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • agenda” – plan dnia z wydarzeniami w danym dniu (wysyłany rano).

Wymagane podczas dodawania powiadomienia.

z możliwością zapisu
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
summaryOverride string Podsumowanie ustawione przez uwierzytelniony użytkownik dla tego kalendarza. Opcjonalnie. z możliwością zapisu

Odpowiedź

Jeśli operacja się uda, metoda zwróci w treści odpowiedzi zasób Kalendarza.

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

Używa biblioteki klienta dla języka Python.

calendar_list_entry = {
    'id': 'calendarId'
}

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

print created_calendar_list_entry['summary']

PHP

Korzysta z 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

Użyj Eksploratora interfejsów API poniżej, aby wywołać tę metodę na aktywnych danych i zobaczyć odpowiedź.