CalendarList

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

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

การแสดงทรัพยากร

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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
    ]
  },
  "autoAcceptInvitations": boolean
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
accessRole string บทบาทการเข้าถึงที่มีผลซึ่งผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์ในปฏิทิน ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว ค่าที่เป็นไปได้มีดังนี้
  • "freeBusyReader" - ให้สิทธิ์เข้าถึงแบบอ่านข้อมูลว่าง/ไม่ว่าง
  • "reader" - ให้สิทธิ์เข้าถึงแบบอ่านปฏิทิน กิจกรรมส่วนตัวจะปรากฏแก่ผู้ใช้ที่มีสิทธิ์เข้าถึงแบบอ่าน แต่ระบบจะซ่อนรายละเอียดกิจกรรม
  • "writerWithoutPrivateAccess" - ให้สิทธิ์เข้าถึงแบบอ่านและเขียนปฏิทิน กิจกรรมส่วนตัวจะปรากฏแก่ผู้ใช้ที่มีสิทธิ์เข้าถึงแบบ writerWithoutPrivateAccess แต่ระบบจะซ่อนรายละเอียดกิจกรรม
  • "writer" - ให้สิทธิ์เข้าถึงแบบอ่านและเขียนปฏิทิน กิจกรรมส่วนตัวจะปรากฏแก่ผู้ใช้ที่มีสิทธิ์เข้าถึงแบบ writer และรายละเอียดกิจกรรมจะปรากฏให้เห็น
  • "owner" - ให้สิทธิ์เข้าถึงแบบผู้จัดการปฏิทิน บทบาทนี้มีสิทธิ์ทั้งหมดของบทบาท writer พร้อมความสามารถเพิ่มเติมในการดูและแก้ไขระดับการเข้าถึงของผู้ใช้รายอื่น

autoAcceptInvitations boolean ปฏิทินนี้ยอมรับคำเชิญโดยอัตโนมัติหรือไม่ ใช้ได้กับปฏิทินทรัพยากรเท่านั้น ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
backgroundColor string สีหลักของปฏิทินในรูปแบบเลขฐานสิบหก "#0088aa" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ที่อิงตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ เขียนได้
colorId string สีของปฏิทิน นี่คือรหัสที่อ้างอิงรายการในส่วน calendar ของคำจำกัดความสี (ดู ปลายทาง colors) พร็อพเพอร์ตี้นี้ถูกแทนที่ด้วยพร็อพเพอร์ตี้ backgroundColor และ foregroundColor และสามารถละเว้นได้เมื่อใช้พร็อพเพอร์ตี้เหล่านี้ ไม่บังคับ เขียนได้
conferenceProperties nested object พร็อพเพอร์ตี้การประชุมสำหรับปฏิทินนี้ เช่น ประเภทการประชุมที่อนุญาต
conferenceProperties.allowedConferenceSolutionTypes[] list ประเภทโซลูชันการประชุมที่รองรับสำหรับปฏิทินนี้

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

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

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

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

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

 เขียนได้
deleted boolean รายการในรายการปฏิทินนี้ถูกลบออกจากรายการปฏิทินแล้วหรือไม่ ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว ไม่บังคับ ค่าเริ่มต้นคือ False
description string คำอธิบายปฏิทิน ไม่บังคับ ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
etag etag ETag ของทรัพยากร
foregroundColor string สีเบื้องหน้าของปฏิทินในรูปแบบเลขฐาน 16 "#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 ปฏิทินเป็นปฏิทินหลักของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์หรือไม่ ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว ไม่บังคับ ค่าเริ่มต้นคือ False
selected boolean เนื้อหาปฏิทินจะแสดงใน UI ปฏิทินหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
summary string ชื่อปฏิทิน ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
summaryOverride string สรุปที่ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ตั้งค่าไว้สำหรับปฏิทินนี้ ไม่บังคับ เขียนได้
timeZone string เขตเวลาของปฏิทิน ไม่บังคับ ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว

เมธอด

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