CalendarList

คอลเล็กชันของปฏิทินในรายการปฏิทินของผู้ใช้ ดูข้อมูลเพิ่มเติมได้ที่ ปฏิทินเทียบกับ CalendarList

ดูรายการเมธอดสำหรับทรัพยากรนี้ได้ที่ส่วนท้ายของหน้านี้

การนำเสนอแหล่งข้อมูล

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
accessRole string บทบาทการเข้าถึงที่มีผลซึ่งผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีในปฏิทิน อ่านอย่างเดียว ค่าที่เป็นไปได้คือ
  • "freeBusyReader" - มอบสิทธิ์การเข้าถึงในการอ่านข้อมูลว่าง/ไม่ว่าง
  • "reader" - มอบสิทธิ์การเข้าถึงในการอ่านปฏิทิน กิจกรรมส่วนตัวจะปรากฏแก่ผู้ใช้ที่มีสิทธิ์เข้าถึงผู้อ่าน แต่จะซ่อนรายละเอียดของกิจกรรม
  • "writer" - ให้สิทธิ์อ่านและเขียนปฏิทิน กิจกรรมส่วนตัวจะแสดงต่อผู้ใช้ที่มีสิทธิ์เข้าถึงระดับผู้เขียน และจะเห็นรายละเอียดของกิจกรรม
  • "owner" - ระบุความเป็นเจ้าของปฏิทิน บทบาทนี้มีสิทธิ์ทั้งหมดของบทบาทผู้เขียนพร้อมความสามารถในการดูและจัดการ ACL เพิ่มเติม
backgroundColor string สีหลักของปฏิทินในรูปแบบเลขฐานสิบหก "#0088aa" พร็อพเพอร์ตี้นี้จะมีผลแทนพร็อพเพอร์ตี้ colorId ที่อิงตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนแปลงพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ เขียนได้
colorId string สีของปฏิทิน นี่คือรหัสที่อ้างอิงถึงรายการในส่วน calendar ของคำจำกัดความสี (ดูจุดสิ้นสุดของสี) พร็อพเพอร์ตี้นี้มีผลแทนด้วยพร็อพเพอร์ตี้ backgroundColor และ foregroundColor และละเว้นได้เมื่อใช้พร็อพเพอร์ตี้เหล่านี้ ไม่บังคับ เขียนได้
conferenceProperties nested object พร็อพเพอร์ตี้การประชุมสำหรับปฏิทินนี้ เช่น ประเภทการประชุมที่อนุญาต
conferenceProperties.allowedConferenceSolutionTypes[] list ประเภทของโซลูชันการประชุมที่รองรับสำหรับปฏิทินนี้

ค่าที่เป็นไปได้มีดังนี้

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
(ไม่บังคับ)
defaultReminders[] list การช่วยเตือนเริ่มต้นที่ผู้ใช้ซึ่งผ่านการตรวจสอบสิทธิ์แล้วมีสำหรับปฏิทินนี้ เขียนได้
defaultReminders[].method string วิธีที่การช่วยเตือนนี้ใช้ ค่าที่เป็นไปได้คือ
  • "email" - การแจ้งเตือนจะส่งทางอีเมล
  • "popup" - การแจ้งเตือนจะส่งผ่านทางป๊อปอัป UI

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

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

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

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

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

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

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

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

เมธอด

ลบ
นำปฏิทินออกจากรายการปฏิทินของผู้ใช้
รับ
ส่งคืนปฏิทินจากรายการปฏิทินของผู้ใช้
แทรก
แทรกปฏิทินที่มีอยู่แล้วในรายการปฏิทินของผู้ใช้
list
แสดงผลปฏิทินในรายการปฏิทินของผู้ใช้
แพตช์
อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้ วิธีนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย ต้องการใช้ get ตามด้วย update ค่าของช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุไว้ในคำขอจะยังคงไม่มีการเปลี่ยนแปลง ช่องอาร์เรย์ (หากระบุไว้) จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะทิ้งอีลิเมนต์ของอาร์เรย์ก่อนหน้า
อัปเดต
อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้
นาฬิกาข้อมือ
เฝ้าดูการเปลี่ยนแปลงในทรัพยากร CalendarList