CalendarList: update

Memperbarui kalender yang ada di daftar kalender pengguna. Coba sekarang atau lihat contohnya.

Permintaan

Permintaan HTTP

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

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
calendarId string ID kalender. Untuk mengambil ID kalender, panggil metode calendarList.list. Jika Anda ingin mengakses kalender utama pengguna yang saat ini login, gunakan kata kunci "primary".
Parameter kueri opsional
colorRgbFormat boolean Apakah akan menggunakan kolom foregroundColor dan backgroundColor untuk menulis warna kalender (RGB). Jika fitur ini digunakan, kolom colorId berbasis indeks akan otomatis ditetapkan ke opsi pencocokan terbaik. Opsional. Default-nya adalah Salah.

Otorisasi

Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut:

Cakupan
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendarlist

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Dalam isi permintaan, berikan resource CalendarList dengan properti berikut:

Nama properti Nilai Deskripsi Catatan
Properti Opsional
backgroundColor string Warna utama kalender dalam format heksadesimal "#0088aa". Properti ini menggantikan properti colorId berbasis indeks. Untuk menetapkan atau mengubah properti ini, Anda harus menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. dapat ditulis
colorId string Warna kalender. Ini adalah ID yang merujuk ke entri di bagian calendar definisi warna (lihat endpoint warna). Properti ini diganti oleh properti backgroundColor dan foregroundColor dan dapat diabaikan saat menggunakan properti ini. Opsional. dapat ditulis
defaultReminders[] list Pengingat default yang dimiliki pengguna terautentikasi untuk kalender ini. dapat ditulis
defaultReminders[].method string Metode yang digunakan oleh pengingat ini. Kemungkinan nilainya adalah:
  • "email" - Pengingat dikirim melalui email.
  • "popup" - Pengingat dikirim melalui pop-up UI.

Wajib diisi saat menambahkan pengingat.

 dapat ditulis
defaultReminders[].minutes integer Jumlah menit sebelum awal acara saat pengingat harus dipicu. Nilai yang valid antara 0 dan 40320 (4 minggu dalam menit).

Wajib diisi saat menambahkan pengingat.

 dapat ditulis
foregroundColor string Warna latar depan kalender dalam format heksadesimal "#ffffff". Properti ini menggantikan properti colorId berbasis indeks. Untuk menetapkan atau mengubah properti ini, Anda harus menentukan colorRgbFormat=true dalam parameter metode insert, update, dan patch. Opsional. dapat ditulis
hidden boolean Apakah kalender telah disembunyikan dari daftar. Opsional. Atribut hanya ditampilkan saat kalender disembunyikan, dengan nilai true. dapat ditulis
notificationSettings object Notifikasi yang diterima pengguna terautentikasi untuk kalender ini. dapat ditulis
notificationSettings.notifications[].method string Metode yang digunakan untuk mengirimkan notifikasi. Nilai yang memungkinkan adalah:
  • "email" - Notifikasi dikirim melalui email.

Wajib diisi saat menambahkan notifikasi.

 dapat ditulis
notificationSettings.notifications[].type string Jenis notifikasi. Kemungkinan nilainya adalah:
  • "eventCreation" - Notifikasi dikirim saat acara baru dimasukkan ke kalender.
  • "eventChange" - Notifikasi dikirim saat peristiwa diubah.
  • "eventCancellation" - Notifikasi dikirim saat peristiwa dibatalkan.
  • "eventResponse" - Notifikasi yang dikirim saat tamu merespons undangan acara.
  • "agenda" - Agenda dengan peristiwa hari ini (dikirim pada pagi hari).

Wajib diisi saat menambahkan notifikasi.

 dapat ditulis
selected boolean Apakah konten kalender muncul di UI kalender. Opsional. Default-nya adalah Salah. dapat ditulis
summaryOverride string Ringkasan yang telah ditetapkan pengguna terautentikasi untuk kalender ini. Opsional. dapat ditulis

Respons

Jika berhasil, metode ini akan menampilkan resource CalendarList dalam isi respons.

Contoh

Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).

Java

Menggunakan library klien 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();

// Retrieve the calendar list entry
CalendarListEntry calendarListEntry = service.calendarList().get("calendarId").execute();

// Make a change
calendarListEntry.setColorId("newColorId");

// Update the altered entry
CalendarListEntry updatedCalendarListEntry =
    service.calendarList().update(calendarListEntry.getId(), calendarListEntry).execute();

System.out.println(updatedCalendarListEntry.getEtag());

Python

Menggunakan library klien Python.

# First retrieve the calendarListEntry from the API.
calendar_list_entry = service.calendarList().get(calendarId='calendarId').execute()
calendar_list_entry['colorId'] = 'newColorId'

updated_calendar_list_entry = service.calendarList().update(
    calendarId=calendar_list_entry['id'], body=calendar_list_entry).execute()

print created_calendar_list_entry['etag']

PHP

Menggunakan library klien PHP.

// First retrieve the calendarListEntry from the API.
$calendarListEntry = $service->calendarList->get('calendarId');
$calendarListEntry->setColorId('newColorId');

$updatedCalendarListEntry = service->calendarList->update($calendarListEntry->getId(), $calendarListEntry);

echo $updatedCalendarListEntry->getEtag();

Ruby

Menggunakan library klien Ruby.

calendar_list_entry = client.get_calendar_list('calendarId')
calendar_list_entry.colorId = 'newColorId'
result = client.update_calendar_list(calendar_list_entry.id, calendar_list_entry)
print result.etag

Cobalah!

Gunakan API Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya.