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
    ]
  }
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
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