CalendarList: insert

Wstawia istniejący kalendarz do listy kalendarzy użytkownika. Wypróbuj lub zobacz przykład.

Żądanie

Żą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 do zapisywania kolorów kalendarza (RGB) używać pól 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 Fałsz.

Autoryzacja

To żądanie wymaga autoryzacji w tym zakresie:

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

Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.

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 opartą na indeksie właściwość colorId. 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. 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 i foregroundColor i można ją zignorować podczas korzystania z tych właściwości. Opcjonalnie: z możliwością zapisu
defaultReminders[] list Domyślne przypomnienia dla uwierzytelnionego użytkownika dotyczące tego kalendarza. z możliwością zapisu
defaultReminders[].method string Metoda użyta w tym przypomnieniu. Możliwe wartości:
  • „email” - Przypomnienia są wysyłane e-mailem.
  • „popup” – Przypomnienia są wysyłane przez wyskakujące okienko interfejsu.

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
defaultReminders[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, kiedy powinno wyświetlić się przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40 320 (4 tygodnie w minutach).

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
foregroundColor string Kolor pierwszego planu kalendarza w formacie szesnastkowym „#ffffff”. Ta właściwość zastępuje opartą na indeksie właściwość colorId. 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
notificationSettings object Powiadomienia o tym kalendarzu odbierane przez uwierzytelnionego użytkownika. z możliwością zapisu
notificationSettings.notifications[].method string Metoda użyta do przesłania powiadomienia. Możliwa wartość to:
  • „email” – Powiadomienia są wysyłane pocztą e-mail.

Wymagane przy dodawaniu powiadomienia.

 z możliwością zapisu
notificationSettings.notifications[].type string Typ powiadomienia. Możliwe wartości:
  • „eventCreation” – Powiadomienie wysyłane po dodaniu nowego wydarzenia do kalendarza.
  • „eventChange” – Powiadomienie wysyłane po zmianie zdarzenia.
  • „eventCancellation” – Powiadomienie wysyłane po anulowaniu wydarzenia.
  • „eventResponse” – Powiadomienie wysyłane, gdy uczestnik odpowie na zaproszenie na wydarzenie.
  • „agenda” – Plan spotkania z wydarzeniami w danym dniu (wysłany rano).

Wymagane przy dodawaniu powiadomienia.

 z możliwością zapisu
selected boolean Określa, czy zawartość kalendarza wyświetla się w interfejsie kalendarza. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
summaryOverride string Podsumowanie ustawione przez uwierzytelnionego użytkownika dla tego kalendarza. Opcjonalnie: z możliwością zapisu

Odpowiedź

Jeśli operacja się uda, metoda zwróci 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

Używa 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 w Pythonie.

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

Użyj poniższego eksploratora interfejsów API, aby wywołać tę metodę na bieżących danych i wyświetlić odpowiedź.