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 ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุไว้ในคําขอจะไม่มีการเปลี่ยนแปลง ช่องอาร์เรย์ (หากระบุ) จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งทิ้งองค์ประกอบอาร์เรย์ก่อนหน้า
อัปเดต
อัปเดตปฏิทินที่มีอยู่ในรายการปฏิทินของผู้ใช้
ดู
ดูการเปลี่ยนแปลงเกี่ยวกับทรัพยากรในปฏิทิน