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
    ]
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
accessRole string บทบาทการเข้าถึงที่มีผลซึ่งผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีในปฏิทิน อ่านอย่างเดียว ค่าที่เป็นไปได้มีดังนี้
  • "freeBusyReader" - ให้สิทธิ์การอ่านข้อมูลว่าง/ไม่ว่าง
  • "reader" - ให้สิทธิ์การอ่านปฏิทิน กิจกรรมส่วนตัวจะปรากฏต่อผู้ใช้ที่มีสิทธิ์เข้าถึงระดับผู้อ่าน แต่ระบบจะซ่อนรายละเอียดกิจกรรม
  • "writer" - ให้สิทธิ์อ่านและเขียนในปฏิทิน กิจกรรมส่วนตัวจะปรากฏต่อผู้ใช้ที่มีสิทธิ์เข้าถึงระดับผู้เขียน และรายละเอียดกิจกรรมจะปรากฏให้เห็น
  • "owner" - ให้สิทธิ์เข้าถึงปฏิทินแก่ผู้จัดการ บทบาทนี้มีสิทธิ์ทั้งหมดของบทบาทผู้เขียน รวมถึงความสามารถเพิ่มเติมในการดูและแก้ไขระดับการเข้าถึงของผู้ใช้รายอื่น

    ได้หลายคน
backgroundColor string สีหลักของปฏิทินในรูปแบบเลขฐานสิบหก "#0088aa" พร็อพเพอร์ตี้นี้จะแทนที่พร็อพเพอร์ตี้ colorId ที่อิงตามดัชนี หากต้องการตั้งค่าหรือเปลี่ยนพร็อพเพอร์ตี้นี้ คุณต้องระบุ colorRgbFormat=true ในพารามิเตอร์ของเมธอด insert, update และ patch ไม่บังคับ เขียนได้
colorId string สีของปฏิทิน นี่คือรหัสที่อ้างอิงถึงรายการในส่วน calendar ของคำจำกัดความสี (ดูปลายทางสี) พร็อพเพอร์ตี้นี้ถูกแทนที่ด้วยพร็อพเพอร์ตี้ 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 สีพื้นหน้าของปฏิทินในรูปแบบเลขฐานสิบหก "#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 เขตเวลาของปฏิทิน ไม่บังคับ อ่านอย่างเดียว

เมธอด

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