แทรกปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ ลองใช้เลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/calendar/v3/users/me/calendarList
พารามิเตอร์
ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
---|---|---|
พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
colorRgbFormat |
boolean |
ต้องการใช้ช่อง foregroundColor และ backgroundColor เพื่อเขียนสีของปฏิทิน (RGB) หรือไม่ หากใช้ฟีเจอร์นี้ ระบบจะตั้งค่าช่อง colorId ที่อิงตามดัชนีเป็นตัวเลือกการจับคู่ที่ดีที่สุดโดยอัตโนมัติ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ"
|
การให้สิทธิ์
คำขอนี้ต้องได้รับสิทธิ์ด้วยขอบเขตต่อไปนี้
ขอบเขต |
---|
https://www.googleapis.com/auth/calendar |
โปรดดูข้อมูลเพิ่มเติมที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในส่วนเนื้อหาของคำขอ ให้ระบุทรัพยากร CalendarList พร้อมพร็อพเพอร์ตี้ต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
พร็อพเพอร์ตี้ที่จำเป็น | |||
id |
string |
ตัวระบุของปฏิทิน | |
พร็อพเพอร์ตี้ที่ไม่บังคับ | |||
backgroundColor |
string |
สีหลักของปฏิทินในรูปแบบเลขฐานสิบหก "#0088aa " พร็อพเพอร์ตี้นี้จะมีผลแทนพร็อพเพอร์ตี้ colorId ที่อิงตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนแปลงพร็อพเพอร์ตี้นี้ คุณจะต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ |
เขียนได้ |
colorId |
string |
สีของปฏิทิน นี่คือรหัสที่อ้างถึงรายการในส่วนcalendar ของคำจำกัดความของสี (ดูปลายทางของสี) พร็อพเพอร์ตี้นี้แทนพร็อพเพอร์ตี้ backgroundColor และ foregroundColor และละเว้นได้เมื่อใช้พร็อพเพอร์ตี้เหล่านี้ ไม่บังคับ |
เขียนได้ |
defaultReminders[] |
list |
การช่วยเตือนเริ่มต้นที่ผู้ใช้ซึ่งตรวจสอบสิทธิ์แล้วสำหรับปฏิทินนี้ | เขียนได้ |
defaultReminders[].method |
string |
วิธีการที่การช่วยเตือนนี้ใช้ ค่าที่เป็นไปได้มีดังนี้
ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
defaultReminders[].minutes |
integer |
จำนวนนาทีก่อนเริ่มกิจกรรมซึ่งระบบจะเริ่มการช่วยเตือน ค่าที่ถูกต้องอยู่ระหว่าง 0 ถึง 40320 (4 สัปดาห์ในหน่วยนาที) ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
foregroundColor |
string |
สีพื้นหน้าของปฏิทินในรูปแบบเลขฐานสิบหก "#ffffff " พร็อพเพอร์ตี้นี้จะมีผลแทนพร็อพเพอร์ตี้ colorId ที่อิงตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนแปลงพร็อพเพอร์ตี้นี้ คุณจะต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ |
เขียนได้ |
notificationSettings |
object |
การแจ้งเตือนที่ผู้ใช้ซึ่งผ่านการตรวจสอบสิทธิ์ได้รับสำหรับปฏิทินนี้ | เขียนได้ |
notificationSettings.notifications[].method |
string |
วิธีส่งการแจ้งเตือน ค่าที่เป็นไปได้คือ:
ต้องระบุเมื่อเพิ่มการแจ้งเตือน |
เขียนได้ |
notificationSettings.notifications[].type |
string |
ประเภทการแจ้งเตือน ค่าที่เป็นไปได้มีดังนี้
ต้องระบุเมื่อเพิ่มการแจ้งเตือน |
เขียนได้ |
selected |
boolean |
เนื้อหาปฏิทินปรากฏใน UI ปฏิทินหรือไม่ ไม่บังคับ ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้เป็น "เท็จ" | เขียนได้ |
summaryOverride |
string |
ข้อมูลสรุปที่ผู้ใช้ซึ่งตรวจสอบสิทธิ์แล้วกำหนดไว้สำหรับปฏิทินนี้ ไม่บังคับ | เขียนได้ |
คำตอบ
หากสำเร็จ เมธอดนี้จะแสดงผลทรัพยากร CalendarList ในเนื้อหาการตอบกลับ
ตัวอย่าง
หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)
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
calendar_list_entry = { 'id': 'calendarId' } created_calendar_list_entry = service.calendarList().insert(body=calendar_list_entry).execute() print created_calendar_list_entry['summary']
PHP
$calendarListEntry = new Google_Service_Calendar_CalendarListEntry(); $calendarListEntry->setId("calendarId"); $createdCalendarListEntry = $service->calendarList->insert($calendarListEntry); echo $createdCalendarListEntry->getSummary();
Ruby
entry = Google::Apis::CalendarV3::CalendarListEntry.new( id: 'calendarId' ) result = client.insert_calendar_list(entry) print result.summary
ลองใช้เลย
ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบเรียลไทม์และดูการตอบสนอง