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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}

ชื่อพร็อพเพอร์ตี้	ค่า	คำอธิบาย	หมายเหตุ
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	สีพื้นหลังของป้ายกำกับในรูปแบบเลขฐาน 16 เช่น "#039be5" กิจกรรมที่มีป้ายกำกับนี้จะแสดงเป็นสีนี้ ต้องระบุ	เขียนได้
labelProperties.eventLabels[].id	string	รหัสของป้ายกำกับ ไม่บังคับเมื่อแทรกป้ายกำกับใหม่ หากไม่ได้ระบุ ระบบจะสร้างรหัสที่ไม่ซ้ำกัน ต้องระบุเมื่ออัปเดตป้ายกำกับ หากระบุ รหัสต้องไม่ซ้ำกันภายในปฏิทินและเป็นไปตามรูปแบบ UUID	เขียนได้
labelProperties.eventLabels[].name	string	ชื่อของป้ายกำกับ ไม่บังคับ หากระบุไว้ ต้องมีอักขระไม่เกิน 50 ตัว	เขียนได้
location	string	สถานที่ตั้งทางภูมิศาสตร์ของปฏิทินในรูปแบบข้อความอิสระ ไม่บังคับ	เขียนได้
summary	string	ชื่อของปฏิทิน	เขียนได้
timeZone	string	เขตเวลาของปฏิทิน (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลา IANA เช่น "Europe/Zurich") ไม่บังคับ	เขียนได้
workingHours	object	แสดงข้อมูลเกี่ยวกับเวลาทำงานของผู้ใช้ ใช้ได้กับปฏิทินหลักของผู้ใช้ Google Workspace เท่านั้น หากต้องการอัปเดตเวลาทำงาน คุณต้องส่งออบเจ็กต์เวลาทำงานทั้งหมด หากไม่ได้ระบุ (หรือส่งเป็นค่าว่างหรือออบเจ็กต์ว่าง) เวลาทำการที่มีอยู่จะยังคงไม่เปลี่ยนแปลง หากต้องการปิดใช้เวลาทำงานหรือล้างกำหนดเวลา ให้ตั้งค่า workingHoursEnabled เป็นเท็จ (และละเว้น availableTimes หรือส่งรายการที่ว่างเปล่า)	เขียนได้
workingHours.availableTimes[]	list	เวลาทำงาน ระยะเวลาที่พร้อมใช้งานแต่ละช่วงจะแสดงบล็อกเวลาทำงานของผู้ใช้ใน 1 วัน	เขียนได้
workingHours.availableTimes[].dayOfWeek	string	วันของสัปดาห์ ต้องระบุ ค่าที่เป็นไปได้มีดังนี้ "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"	เขียนได้
workingHours.availableTimes[].periodEnd	integer	จุดสิ้นสุดของระยะเวลา โดยนับเป็นนาทีจากจุดเริ่มต้นของวัน (ไม่รวมจุดสิ้นสุด) ต้องระบุ	เขียนได้
workingHours.availableTimes[].periodStart	integer	จุดเริ่มต้นของระยะเวลา โดยนับเป็นนาทีจากจุดเริ่มต้นของวัน (รวมเวลาเริ่มต้น) ต้องระบุ	เขียนได้
workingHours.workingHoursEnabled	boolean	ระบุว่ามีการเปิดใช้เวลาทำงานสำหรับปฏิทินนี้หรือไม่ ตั้งค่าเป็น "จริง" ไม่ได้เมื่อ availableTimes ว่างเปล่า	เขียนได้

เมธอด

clear

ล้างปฏิทินหลัก การดำเนินการนี้จะลบกิจกรรมทั้งหมดที่เชื่อมโยงกับปฏิทินหลักของบัญชี

ลบ

ลบปฏิทินรอง ใช้ calendars.clear เพื่อล้างกิจกรรมทั้งหมดในปฏิทินหลัก

get

แสดงผลข้อมูลเมตาสำหรับปฏิทิน

insert

สร้างปฏิทินรอง

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

หมายเหตุ: เราขอแนะนำให้ตรวจสอบสิทธิ์ในฐานะเจ้าของข้อมูลที่ต้องการของปฏิทิน คุณสามารถใช้การมอบสิทธิ์ทั่วทั้งโดเมนเพื่ออนุญาตให้แอปพลิเคชันดำเนินการในนามของผู้ใช้ที่เฉพาะเจาะจงได้ อย่าใช้บัญชีบริการสำหรับการตรวจสอบสิทธิ์ หากคุณใช้บัญชีบริการเพื่อตรวจสอบสิทธิ์ บัญชีบริการจะเป็นเจ้าของข้อมูล ซึ่งอาจทำให้เกิดลักษณะการทำงานที่ไม่คาดคิด เช่น หากบัญชีบริการเป็นเจ้าของข้อมูล คุณจะโอนความเป็นเจ้าของข้อมูลไม่ได้

patch

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

transferOwnership

โอนปฏิทินรองระหว่างผู้ใช้ภายในองค์กร Google Workspace ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบในการจัดการปฏิทิน และขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.calendars

ในคำขอ ให้ตั้งค่า useAdminAccess เป็น true ปฏิทินรองต้องใช้งานอยู่จึงจะโอนได้ ระบบไม่รองรับการโอนปฏิทินที่ปิดใช้หรือลบไปแล้ว

update

อัปเดตข้อมูลเมตาสำหรับปฏิทิน