Calendars

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

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

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

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
autoAcceptInvitations boolean ระบุว่าปฏิทินนี้ยอมรับคำเชิญโดยอัตโนมัติหรือไม่ ใช้ได้กับปฏิทินทรัพยากรเท่านั้น
conferenceProperties nested object พร็อพเพอร์ตี้การประชุมสำหรับปฏิทินนี้ เช่น ประเภทการประชุมที่อนุญาต
conferenceProperties.allowedConferenceSolutionTypes[] list ประเภทโซลูชันการประชุมที่รองรับสำหรับปฏิทินนี้

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

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
ไม่บังคับ

dataOwner string อีเมลของเจ้าของปฏิทิน ตั้งค่าสำหรับปฏิทินรองเท่านั้น ช่องนี้เป็นข้อมูลแบบอ่านอย่างเดียว
description string คำอธิบายของปฏิทิน ไม่บังคับ เขียนได้
etag etag ETag ของทรัพยากร
id string ตัวระบุของปฏิทิน หากต้องการดึงข้อมูลรหัส ให้เรียกใช้เมธอด calendarList.list()
kind string ประเภทของทรัพยากร ("calendar#calendar")
labelProperties nested object พร็อพเพอร์ตี้ป้ายกำกับที่กำหนดไว้ในปฏิทินนี้ หากระบุไว้ ระบบจะเขียนทับพร็อพเพอร์ตี้ป้ายกำกับที่มีอยู่ หากไม่ระบุ พร็อพเพอร์ตี้ป้ายกำกับจะยังคงเหมือนเดิม เขียนได้
labelProperties.eventLabels[] list ป้ายกำกับกิจกรรมที่กำหนดไว้ในปฏิทินนี้ หากระบุไว้เมื่ออัปเดตปฏิทิน ระบบจะแทนที่ป้ายกำกับกิจกรรมที่มีอยู่

ขยายรายการเพื่อเพิ่มป้ายกำกับกิจกรรมใหม่ และนำเอนทิตีออกจากรายการเพื่อลบป้ายกำกับออกจากปฏิทิน

ปฏิทินแต่ละรายการมีป้ายกำกับได้สูงสุด 200 รายการ

เขียนได้
labelProperties.eventLabels[].backgroundColor string สีพื้นหลังของป้ายกำกับในรูปแบบเลขฐานสิบหก เช่น "#039be5" ระบบจะแสดงกิจกรรมที่มีป้ายกำกับนี้ด้วยสีนี้ ต้องระบุ เขียนได้
labelProperties.eventLabels[].id string รหัสของป้ายกำกับ ไม่บังคับเมื่อแทรกป้ายกำกับใหม่ หากไม่ระบุ ระบบจะสร้างรหัสที่ไม่ซ้ำกัน ต้องระบุเมื่ออัปเดตป้ายกำกับ

หากระบุ รหัสต้องไม่ซ้ำกันภายในปฏิทินและเป็นไปตามรูปแบบ UUID

เขียนได้
labelProperties.eventLabels[].name string ชื่อของป้ายกำกับ ไม่บังคับ

หากระบุ ชื่อต้องมีความยาวไม่เกิน 50 ตัวอักษร

เขียนได้
location string สถานที่ตั้งทางภูมิศาสตร์ของปฏิทินในรูปแบบข้อความอิสระ ไม่บังคับ เขียนได้
summary string ชื่อของปฏิทิน เขียนได้
timeZone string เขตเวลาของปฏิทิน (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") ไม่บังคับ เขียนได้

เมธอด

clear
ล้างปฏิทินหลัก การดำเนินการนี้จะลบกิจกรรมทั้งหมดที่เชื่อมโยงกับปฏิทินหลักของบัญชี
delete
ลบปฏิทินรอง ใช้ calendars.clear เพื่อล้างกิจกรรมทั้งหมดในปฏิทินหลัก
get
แสดงผลข้อมูลเมตาของปฏิทิน
insert
สร้างปฏิทินรอง

ระบบจะกำหนดให้ผู้ใช้ที่ตรวจสอบสิทธิ์สำหรับคำขอเป็นเจ้าของข้อมูลของปฏิทินใหม่

patch
อัปเดตข้อมูลเมตาของปฏิทิน เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการใช้หน่วยโควต้า 3 หน่วย เราขอแนะนำให้ใช้ get ตามด้วย update ค่าฟิลด์ที่คุณระบุจะแทนที่ค่าที่มีอยู่ ฟิลด์ที่คุณไม่ได้ระบุในคำขอจะยังคงเหมือนเดิม ฟิลด์อาร์เรย์ หากระบุไว้ จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้า
transferOwnership
โอนปฏิทินรองระหว่างผู้ใช้ภายในองค์กร Google Workspace ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบในการจัดการปฏิทิน Manage Calendars และขอบเขตการให้สิทธิ์ต่อไปนี้ขอบเขตใดขอบเขตหนึ่ง
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
ในคำขอ ให้ตั้งค่า useAdminAccess เป็น true ปฏิทินรองต้องใช้งานอยู่จึงจะโอนได้ ระบบไม่รองรับการโอนปฏิทินที่ปิดใช้หรือลบไปแล้ว
update
อัปเดตข้อมูลเมตาของปฏิทิน