CalendarList: update

อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ ลองใช้เลยหรือดูตัวอย่าง

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการเรียกข้อมูลรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน ให้ใช้คีย์เวิร์ด "primary"
พารามิเตอร์การค้นหาที่ไม่บังคับ
colorRgbFormat boolean ระบุว่าจะใช้ช่อง foregroundColor และ backgroundColor เพื่อเขียนสีปฏิทิน (RGB) หรือไม่ หากใช้ฟีเจอร์นี้ ระบบจะตั้งค่าช่อง colorId ตามดัชนีเป็นตัวเลือกที่ตรงกันที่สุดโดยอัตโนมัติ ไม่บังคับ ค่าเริ่มต้นคือ False

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

ขอบเขต
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.calendarlist

ดูข้อมูลเพิ่มเติมได้ที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อหาของคำขอ

ในเนื้อหาคำขอ ให้ระบุทรัพยากร CalendarList ที่มีพร็อพเพอร์ตี้ต่อไปนี้

ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
พร็อพเพอร์ตี้ที่ไม่บังคับ
backgroundColor string สีหลักของปฏิทินในรูปแบบฐานสิบหก "#0088aa" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ เขียนได้
colorId string สีของปฏิทิน รหัสนี้หมายถึงรายการในส่วน calendar ของคำจำกัดความสี (ดูปลายทางสี) พร็อพเพอร์ตี้นี้ถูกแทนที่ด้วยพร็อพเพอร์ตี้ backgroundColor และ foregroundColor และสามารถละเว้นได้เมื่อใช้พร็อพเพอร์ตี้เหล่านี้ ไม่บังคับ เขียนได้
defaultReminders[] list การช่วยเตือนเริ่มต้นที่ผู้ใช้ที่ตรวจสอบสิทธิ์มีสำหรับปฏิทินนี้ เขียนได้
defaultReminders[].method string วิธีการที่ใช้โดยการช่วยเตือนนี้ ค่าที่เป็นไปได้มีดังนี้
  • "email" - ระบบจะส่งการช่วยเตือนทางอีเมล
  • "popup" - ระบบจะส่งการช่วยเตือนผ่านป๊อปอัป UI

ต้องระบุเมื่อเพิ่มการช่วยเตือน

 เขียนได้
defaultReminders[].minutes integer จำนวนนาทีก่อนเริ่มกิจกรรมที่การช่วยเตือนควรทริกเกอร์ ค่าที่ใช้ได้คือระหว่าง 0 ถึง 40320 (4 สัปดาห์เป็นนาที)

ต้องระบุเมื่อเพิ่มการช่วยเตือน

 เขียนได้
foregroundColor string สีพื้นหน้าของปฏิทินในรูปแบบฐานสิบหก "#ffffff" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ เขียนได้
hidden boolean ปฏิทินถูกซ่อนจากรายการหรือไม่ ไม่บังคับ ระบบจะแสดงผลแอตทริบิวต์ก็ต่อเมื่อปฏิทินซ่อนอยู่ ซึ่งในกรณีนี้ค่าจะเป็น true เขียนได้
notificationSettings object การแจ้งเตือนที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วได้รับสำหรับปฏิทินนี้ เขียนได้
notificationSettings.notifications[].method string วิธีที่ใช้ในการส่งการแจ้งเตือน ค่าที่เป็นไปได้คือ
  • "email" - ระบบจะส่งการแจ้งเตือนทางอีเมล

ต้องระบุเมื่อเพิ่มการแจ้งเตือน

 เขียนได้
notificationSettings.notifications[].type string ประเภทการแจ้งเตือน ค่าที่เป็นไปได้มีดังนี้
  • "eventCreation" - การแจ้งเตือนที่ส่งเมื่อมีการใส่กิจกรรมใหม่ในปฏิทิน
  • "eventChange" - ส่งการแจ้งเตือนเมื่อมีการเปลี่ยนแปลงกิจกรรม
  • "eventCancellation" - ส่งการแจ้งเตือนเมื่อมีการยกเลิกกิจกรรม
  • "eventResponse" - ระบบจะส่งการแจ้งเตือนเมื่อผู้เข้าร่วมตอบกลับคำเชิญเข้าร่วมกิจกรรม
  • "agenda" - กำหนดการพร้อมกิจกรรมของวัน (ส่งในตอนเช้า)

ต้องระบุเมื่อเพิ่มการแจ้งเตือน

 เขียนได้
selected boolean เนื้อหาปฏิทินจะปรากฏใน UI ของปฏิทินหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
summaryOverride string ข้อมูลสรุปที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วตั้งค่าไว้สำหรับปฏิทินนี้ ไม่บังคับ เขียนได้

คำตอบ

หากดำเนินการสำเร็จ วิธีการนี้จะแสดงผลทรัพยากร CalendarList ในเนื้อหาการตอบกลับ

ตัวอย่าง

หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)

Java

ใช้ไลบรารีของไคลเอ็นต์ 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

ใช้ไลบรารีของไคลเอ็นต์ 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

ใช้ไลบรารีของไคลเอ็นต์ 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

ใช้ไลบรารีของไคลเอ็นต์ 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

ลองใช้งาน

ใช้โปรแกรมสำรวจ API ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลจริงและดูการตอบกลับ