API ของปฏิทินมีทรัพยากรของกิจกรรมที่แตกต่างกัน คุณสามารถดูข้อมูลเพิ่มเติมได้ในเกี่ยวกับกิจกรรม
ดูรายการเมธอดสำหรับแหล่งข้อมูลนี้ได้ที่ส่วนท้ายของหน้านี้
การนำเสนอทรัพยากร
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | Notes |
---|---|---|---|
anyoneCanAddSelf |
boolean |
ทุกคนสามารถเชิญตนเองเข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งาน) ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" | เขียนได้ |
attachments[] |
list |
ไฟล์แนบของกิจกรรม หากต้องการแก้ไขไฟล์แนบ ควรตั้งค่าพารามิเตอร์คำขอ แต่ละกิจกรรมจะมีไฟล์แนบได้สูงสุด 25 ไฟล์ |
|
attachments[].fileId |
string |
รหัสของไฟล์แนบ อ่านอย่างเดียว สำหรับไฟล์ Google ไดรฟ์ นี่คือรหัสของรายการทรัพยากร |
|
attachments[].fileUrl |
string |
URL ของไฟล์แนบ หากต้องการเพิ่มไฟล์แนบใน Google ไดรฟ์ ให้ใช้รูปแบบเดียวกับในพร็อพเพอร์ตี้ ต้องระบุเมื่อเพิ่มไฟล์แนบ |
เขียนได้ |
attachments[].iconLink |
string |
URL ไปยังไอคอนของไฟล์แนบ ช่องนี้แก้ไขได้เฉพาะไฟล์แนบของบุคคลที่สามที่กำหนดเองเท่านั้น | |
attachments[].mimeType |
string |
ประเภทสื่อทางอินเทอร์เน็ต (ประเภท MIME) ของไฟล์แนบ | |
attachments[].title |
string |
ชื่อไฟล์แนบ | |
attendeesOmitted |
boolean |
กำหนดว่าผู้เข้าร่วมจะถูกละเว้นจากตัวแทนของกิจกรรมหรือไม่ เมื่อดึงข้อมูลเหตุการณ์ อาจเป็นเพราะข้อจํากัดที่พารามิเตอร์การค้นหา maxAttendee ระบุไว้ เมื่ออัปเดตกิจกรรม จะใช้การตั้งค่านี้เพื่ออัปเดตคำตอบของผู้เข้าร่วมเท่านั้น ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" |
เขียนได้ |
attendees[] |
list |
ผู้เข้าร่วมกิจกรรม โปรดดูคู่มือกิจกรรมที่มีผู้เข้าร่วมเพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดเวลากิจกรรมกับผู้ใช้ปฏิทินคนอื่นๆ บัญชีบริการต้องใช้การมอบสิทธิ์ทั่วทั้งโดเมนในการสร้างรายชื่อผู้เข้าร่วม | เขียนได้ |
attendees[].additionalGuests |
integer |
จำนวนแขกเพิ่มเติม ไม่บังคับ ค่าเริ่มต้นคือ 0 | เขียนได้ |
attendees[].comment |
string |
ความคิดเห็นตอบกลับของผู้เข้าร่วม ไม่บังคับ | เขียนได้ |
attendees[].displayName |
string |
ชื่อผู้เข้าร่วม (หากมี) ไม่บังคับ | เขียนได้ |
attendees[].email |
string |
อีเมลของผู้เข้าร่วม (หากมี) ช่องนี้ต้องแสดงเมื่อเพิ่มผู้เข้าร่วม ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 ต้องระบุเมื่อเพิ่มผู้เข้าร่วม |
เขียนได้ |
attendees[].id |
string |
รหัสโปรไฟล์ของผู้เข้าร่วม ถ้ามี | |
attendees[].optional |
boolean |
ดูว่าผู้เข้าร่วมรายนี้เป็นผู้เข้าร่วมที่ไม่บังคับหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" | เขียนได้ |
attendees[].organizer |
boolean |
ผู้เข้าร่วมเป็นผู้จัดกิจกรรมหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ "เท็จ" | |
attendees[].resource |
boolean |
ผู้เข้าร่วมเป็นทรัพยากรหรือไม่ ตั้งค่าได้ก็ต่อเมื่อเพิ่มผู้เข้าร่วมในกิจกรรมเป็นครั้งแรกเท่านั้น ระบบจะไม่สนใจการแก้ไขที่ตามมา ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" | เขียนได้ |
attendees[].responseStatus |
string |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้:
|
เขียนได้ |
attendees[].self |
boolean |
รายการนี้แสดงปฏิทินที่สำเนาของกิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ "เท็จ" | |
colorId |
string |
สีของกิจกรรม นี่คือรหัสที่อ้างถึงรายการในส่วน event ของคำจำกัดความสี (ดู ปลายทางสี) ไม่บังคับ |
เขียนได้ |
conferenceData |
nested object |
ข้อมูลที่เกี่ยวข้องกับการประชุม เช่น รายละเอียดการประชุม Google Meet หากต้องการสร้างรายละเอียดการประชุมใหม่ ให้ใช้ช่อง createRequest หากต้องการคงการเปลี่ยนแปลงไว้ อย่าลืมตั้งค่าพารามิเตอร์คำขอ conferenceDataVersion เป็น 1 สำหรับคำขอแก้ไขเหตุการณ์ทั้งหมด |
เขียนได้ |
conferenceData.conferenceId |
string |
รหัสการประชุม นักพัฒนาซอฟต์แวร์สามารถใช้เพื่อติดตามการประชุมได้ แต่ไม่ควรแสดงต่อผู้ใช้ ค่ารหัสจะอยู่ในรูปแบบที่แตกต่างกันสำหรับโซลูชันการประชุมแต่ละประเภท ดังนี้
|
|
conferenceData.conferenceSolution |
nested object |
โซลูชันการประชุม เช่น Google Meet ยกเลิกการตั้งค่าการประชุมที่มีคำขอสร้างไม่สำเร็จ ต้องระบุ |
|
conferenceData.conferenceSolution.iconUri |
string |
ไอคอนที่ผู้ใช้มองเห็นได้สำหรับโซลูชันนี้ | |
conferenceData.conferenceSolution.key |
nested object |
คีย์ที่ระบุโซลูชันการประชุมสําหรับกิจกรรมนี้ได้โดยไม่ซ้ำกัน | |
conferenceData.conferenceSolution.key.type |
string |
ประเภทโซลูชันการประชุม หากลูกค้าพบสิ่งที่ไม่รู้จักหรือว่างเปล่า ลูกค้าควรสามารถแสดงจุดแรกเข้าได้ แต่ไม่ควรอนุญาตให้ทำการแก้ไขใดๆ ค่าที่เป็นไปได้มีดังนี้
|
|
conferenceData.conferenceSolution.name |
string |
ชื่อที่ผู้ใช้มองเห็นของโซลูชันนี้ ไม่ได้แปล | |
conferenceData.createRequest |
nested object |
คำขอสร้างการประชุมใหม่และแนบไปกับกิจกรรม ข้อมูลจะสร้างขึ้นแบบไม่พร้อมกัน หากต้องการดูว่ามีข้อมูลอยู่หรือไม่ ให้ตรวจสอบช่อง status ต้องระบุ |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
โซลูชันการประชุม เช่น Hangouts หรือ Google Meet | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
ประเภทโซลูชันการประชุม หากลูกค้าพบสิ่งที่ไม่รู้จักหรือว่างเปล่า ลูกค้าควรสามารถแสดงจุดแรกเข้าได้ แต่ไม่ควรอนุญาตให้ทำการแก้ไขใดๆ ค่าที่เป็นไปได้มีดังนี้
|
|
conferenceData.createRequest.requestId |
string |
รหัสที่ไม่ซ้ำกันที่ลูกค้าสร้างขึ้นสำหรับคำขอนี้ ลูกค้าควรสร้างรหัสนี้ใหม่สำหรับคำขอใหม่ทุกรายการ หากรหัสที่ระบุตรงกับคําขอก่อนหน้า ระบบจะไม่สนใจคําขอ |
|
conferenceData.createRequest.status |
nested object |
สถานะของคำขอสร้างการประชุม | |
conferenceData.createRequest.status.statusCode |
string |
สถานะปัจจุบันของคำขอสร้างการประชุม อ่านอย่างเดียว ค่าที่เป็นไปได้มีดังนี้
|
|
conferenceData.entryPoints[] |
list |
ข้อมูลเกี่ยวกับจุดแรกเข้าแต่ละรายการของการประชุม เช่น URL หรือหมายเลขโทรศัพท์ ทุกรายการต้องอยู่ในการประชุมเดียวกัน ต้องระบุ |
|
conferenceData.entryPoints[].accessCode |
string |
รหัสการเข้าถึงสำหรับเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ เมื่อสร้างข้อมูลการประชุมใหม่ ให้เติมข้อมูลเฉพาะบางส่วนของช่อง { ไม่บังคับ |
|
conferenceData.entryPoints[].entryPointType |
string |
ประเภทของจุดแรกเข้าของการประชุม ค่าที่เป็นไปได้มีดังนี้
|
|
conferenceData.entryPoints[].label |
string |
ป้ายกำกับสำหรับ URI ปรากฏแก่ผู้ใช้ปลายทาง ไม่ได้แปล ความยาวสูงสุดคือ 512 อักขระ ตัวอย่าง
ไม่บังคับ |
|
conferenceData.entryPoints[].meetingCode |
string |
รหัสการประชุมสำหรับเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ เมื่อสร้างข้อมูลการประชุมใหม่ ให้เติมข้อมูลเฉพาะบางส่วนของช่อง { ไม่บังคับ |
|
conferenceData.entryPoints[].passcode |
string |
รหัสผ่านในการเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ เมื่อสร้างข้อมูลการประชุมใหม่ ให้เติมข้อมูลเฉพาะบางส่วนของช่อง { |
|
conferenceData.entryPoints[].password |
string |
รหัสผ่านในการเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ เมื่อสร้างข้อมูลการประชุมใหม่ ให้เติมข้อมูลเฉพาะบางส่วนของช่อง { ไม่บังคับ |
|
conferenceData.entryPoints[].pin |
string |
PIN เพื่อเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ เมื่อสร้างข้อมูลการประชุมใหม่ ให้เติมข้อมูลเฉพาะบางส่วนของช่อง { ไม่บังคับ |
|
conferenceData.entryPoints[].uri |
string |
URI ของจุดแรกเข้า ความยาวสูงสุดคือ 1,300 อักขระ รูปแบบ:
|
|
conferenceData.notes |
string |
หมายเหตุเพิ่มเติม (เช่น วิธีการจากผู้ดูแลระบบโดเมน ประกาศทางกฎหมาย) ที่จะแสดงให้ผู้ใช้เห็น มี HTML ได้ ความยาวสูงสุดคือ 2048 อักขระ ไม่บังคับ | |
conferenceData.signature |
string |
ลายเซ็นของข้อมูลการประชุม สร้างในฝั่งเซิร์ฟเวอร์ ยกเลิกการตั้งค่าการประชุมที่มีคำขอสร้างไม่สำเร็จ ไม่บังคับสำหรับการประชุมที่มีคำขอสร้างที่รออนุมัติ |
|
created |
datetime |
เวลาที่สร้างเหตุการณ์ (เป็นการประทับเวลา RFC3339) อ่านอย่างเดียว | |
creator |
object |
ผู้สร้างกิจกรรม อ่านอย่างเดียว | |
creator.displayName |
string |
ชื่อของครีเอเตอร์ (หากมี) | |
creator.email |
string |
อีเมลของครีเอเตอร์ (หากมี) | |
creator.id |
string |
รหัสโปรไฟล์ของครีเอเตอร์ (หากมี) | |
creator.self |
boolean |
ผู้สร้างสอดคล้องกับปฏิทินที่สำเนาของกิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ "เท็จ" | |
description |
string |
คำอธิบายกิจกรรม มี HTML ได้ ไม่บังคับ | เขียนได้ |
end |
nested object |
เวลาสิ้นสุด (เฉพาะตัว) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาสิ้นสุดของอินสแตนซ์แรก | |
end.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากกิจกรรมนี้เป็นแบบตลอดวัน | เขียนได้ |
end.dateTime |
datetime |
เวลาเป็นค่าวันที่-เวลาแบบรวม (จัดรูปแบบตาม RFC3339) จำเป็นต้องมีการชดเชยเขตเวลา เว้นแต่จะระบุเขตเวลาใน timeZone อย่างชัดเจน |
เขียนได้ |
end.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "ยุโรป/ซูริค") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกช่องนี้และระบุเขตเวลาที่มีการขยายการเกิดซ้ำ สำหรับเหตุการณ์เดียว ช่องนี้จะมีหรือไม่มีก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับการเริ่มต้น/สิ้นสุดกิจกรรม | เขียนได้ |
endTimeUnspecified |
boolean |
มีการระบุเวลาสิ้นสุดจริงๆ หรือไม่ ระบบยังระบุเวลาสิ้นสุดด้วยเหตุผลด้านความเข้ากันได้ แม้ว่าแอตทริบิวต์นี้จะมีการตั้งค่าเป็น "จริง" ก็ตาม ค่าเริ่มต้นคือ "เท็จ" | |
etag |
etag |
ETag ของทรัพยากร | |
eventType |
string |
ประเภทเหตุการณ์ที่เฉพาะเจาะจง ซึ่งแก้ไขไม่ได้หลังจากที่สร้างกิจกรรมแล้ว ค่าที่เป็นไปได้มีดังนี้:
default " และ "workingLocation " เท่านั้นที่สร้างโดยใช้ API ได้ การสนับสนุนเพิ่มเติมสำหรับกิจกรรมประเภทอื่นๆ จะพร้อมใช้งานในรุ่นหลังจากนี้ |
เขียนได้ |
extendedProperties |
object |
พร็อพเพอร์ตี้ขยายของเหตุการณ์ | |
extendedProperties.private |
object |
พร็อพเพอร์ตี้ที่เป็นส่วนบุคคลสำหรับสำเนาของกิจกรรมที่ปรากฏในปฏิทินนี้ | เขียนได้ |
extendedProperties.private.(key) |
string |
ชื่อของทรัพย์สินส่วนตัวและค่าที่เกี่ยวข้อง | |
extendedProperties.shared |
object |
พร็อพเพอร์ตี้ที่แชร์ระหว่างสำเนาของกิจกรรมในปฏิทินของผู้เข้าร่วมคนอื่น | เขียนได้ |
extendedProperties.shared.(key) |
string |
ชื่อของพร็อพเพอร์ตี้ที่แชร์และค่าที่เกี่ยวข้อง | |
focusTimeProperties |
nested object |
ข้อมูลเหตุการณ์ที่ต้องการสมาธิ ต้องระบุหาก eventType คือ focusTime |
เขียนได้ |
focusTimeProperties.autoDeclineMode |
string |
เลือกว่าจะปฏิเสธคำเชิญเข้าร่วมการประชุมที่ทับซ้อนกิจกรรมเวลาที่ต้องการสมาธิหรือไม่ ค่าที่ใช้ได้คือ declineNone ซึ่งหมายความว่าจะไม่มีการปฏิเสธคำเชิญเข้าร่วมประชุม declineAllConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธคำเชิญเข้าร่วมการประชุมที่มีความขัดแย้งกันกับกิจกรรมทั้งหมด และ declineOnlyNewConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธเฉพาะคำเชิญการประชุมใหม่ที่ขัดแย้งกันซึ่งมาถึงขณะมีกิจกรรมที่ต้องการสมาธิเท่านั้น |
|
focusTimeProperties.chatStatus |
string |
สถานะที่ทำเครื่องหมายผู้ใช้ใน Chat และผลิตภัณฑ์ที่เกี่ยวข้อง ซึ่งอาจเป็น available หรือ doNotDisturb ก็ได้ |
|
focusTimeProperties.declineMessage |
string |
ข้อความตอบกลับที่จะกำหนดให้ปฏิทินปฏิเสธกิจกรรมที่มีอยู่หรือคำเชิญใหม่โดยอัตโนมัติ | |
gadget |
object |
แกดเจ็ตที่ขยายกิจกรรมนี้ เลิกใช้งานแกดเจ็ตแล้ว โครงสร้างนี้จะใช้สำหรับการแสดงข้อมูลเมตาปฏิทินวันเกิดเท่านั้น | |
gadget.display |
string |
โหมดการแสดงผลของแกดเจ็ต เลิกใช้งานแล้ว ค่าที่เป็นไปได้มีดังนี้:
|
เขียนได้ |
gadget.height |
integer |
ความสูงของแกดเจ็ตเป็นพิกเซล ความสูงต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
gadget.iconLink |
string |
URL ไอคอนของแกดเจ็ต Scheme ของ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.link |
string |
URL ของแกดเจ็ต Scheme ของ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.preferences |
object |
ค่ากำหนด | เขียนได้ |
gadget.preferences.(key) |
string |
ชื่อค่ากำหนดและค่าที่เกี่ยวข้อง | |
gadget.title |
string |
ชื่อแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.type |
string |
ประเภทของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.width |
integer |
ความกว้างของแกดเจ็ตเป็นพิกเซล ความกว้างต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
guestsCanInviteOthers |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเชิญผู้อื่นเข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
guestsCanModify |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" | เขียนได้ |
guestsCanSeeOtherGuests |
boolean |
ผู้เข้าร่วมที่ไม่ใช่ผู้จัดสามารถดูว่าใครเป็นผู้เข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
hangoutLink |
string |
ลิงก์แบบสัมบูรณ์ไปยัง Google Hangouts ที่เชื่อมโยงกับกิจกรรมนี้ อ่านอย่างเดียว | |
htmlLink |
string |
ลิงก์แบบสัมบูรณ์ไปยังกิจกรรมนี้ใน UI ทางเว็บของ Google ปฏิทิน อ่านอย่างเดียว | |
iCalUID |
string |
ตัวระบุที่ไม่ซ้ำกันของเหตุการณ์ตามที่กําหนดไว้ใน RFC5545 ซึ่งใช้เพื่อระบุกิจกรรมข้ามระบบปฏิทินโดยไม่ซ้ำกัน และต้องระบุเมื่อนำเข้ากิจกรรมผ่านวิธี import โปรดทราบว่า |
|
id |
string |
ตัวระบุเหตุการณ์แบบทึบ เมื่อคุณสร้างกิจกรรมที่เกิดซ้ำหรือที่เกิดซ้ำ คุณสามารถระบุรหัสกิจกรรมนั้นได้ รหัสที่ระบุต้องเป็นไปตามกฎต่อไปนี้
หากคุณไม่ระบุ ID เซิร์ฟเวอร์จะสร้างให้โดยอัตโนมัติ โปรดทราบว่า |
เขียนได้ |
kind |
string |
ประเภทของทรัพยากร ("calendar#event ") |
|
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมในรูปแบบข้อความรูปแบบอิสระ ไม่บังคับ | เขียนได้ |
locked |
boolean |
ไม่ว่าจะเป็นสำเนาของกิจกรรมที่ล็อก ซึ่งไม่สามารถทำการเปลี่ยนแปลงในช่องเหตุการณ์หลัก "summary", "description", "location", "start", "end" หรือ "recurrence" ค่าเริ่มต้นคือ "เท็จ" อ่านอย่างเดียว | |
organizer |
object |
ผู้จัดกิจกรรม หากผู้จัดเป็นผู้เข้าร่วมด้วย จะมีรายการแยกใน attendees พร้อมตั้งค่าช่อง organizer เป็น "จริง" หากต้องการเปลี่ยนผู้จัด ให้ใช้การดำเนินการย้าย อ่านอย่างเดียว ยกเว้นเมื่อนำเข้ากิจกรรม |
เขียนได้ |
organizer.displayName |
string |
ชื่อผู้จัด (หากมี) | เขียนได้ |
organizer.email |
string |
อีเมลของผู้จัด (หากมี) ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 | เขียนได้ |
organizer.id |
string |
รหัสโปรไฟล์ของผู้จัด (หากมี) | |
organizer.self |
boolean |
ผู้จัดสอดคล้องกับปฏิทินที่สำเนาของกิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ "เท็จ" | |
originalStartTime |
nested object |
สำหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ นี่คือเวลาที่เหตุการณ์นี้จะเริ่มต้นตามข้อมูลการเกิดซ้ำในกิจกรรมที่เกิดซ้ำที่ระบุโดย ISRCEventId ซึ่งจะระบุอินสแตนซ์ภายในชุดกิจกรรมที่เกิดซ้ำได้ไม่ซ้ำกัน แม้ว่าจะย้ายอินสแตนซ์ไปในเวลาอื่นก็ตาม เปลี่ยนแปลงไม่ได้ | |
originalStartTime.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากกิจกรรมนี้เป็นแบบตลอดวัน | เขียนได้ |
originalStartTime.dateTime |
datetime |
เวลาเป็นค่าวันที่-เวลาแบบรวม (จัดรูปแบบตาม RFC3339) จำเป็นต้องมีการชดเชยเขตเวลา เว้นแต่จะระบุเขตเวลาใน timeZone อย่างชัดเจน |
เขียนได้ |
originalStartTime.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "ยุโรป/ซูริค") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกช่องนี้และระบุเขตเวลาที่มีการขยายการเกิดซ้ำ สำหรับเหตุการณ์เดียว ช่องนี้จะมีหรือไม่มีก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับการเริ่มต้น/สิ้นสุดกิจกรรม | เขียนได้ |
outOfOfficeProperties |
nested object |
ข้อมูลกิจกรรมลางาน ต้องระบุหาก eventType คือ outOfOffice |
เขียนได้ |
outOfOfficeProperties.autoDeclineMode |
string |
เลือกว่าจะปฏิเสธคำเชิญเข้าร่วมการประชุมที่ทับซ้อนกิจกรรมลางานหรือไม่ ค่าที่ใช้ได้คือ declineNone หมายความว่าจะไม่มีการปฏิเสธคำเชิญเข้าร่วมประชุม declineAllConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธคำเชิญเข้าร่วมการประชุมที่ขัดแย้งกันและขัดแย้งกับกิจกรรมทั้งหมด และ declineOnlyNewConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธเฉพาะคำเชิญเข้าร่วมประชุมใหม่ที่ขัดแย้งกันซึ่งมาถึงขณะกิจกรรมลางานเท่านั้น |
|
outOfOfficeProperties.declineMessage |
string |
ข้อความตอบกลับที่จะกำหนดให้ปฏิทินปฏิเสธกิจกรรมที่มีอยู่หรือคำเชิญใหม่โดยอัตโนมัติ | |
privateCopy |
boolean |
หากตั้งค่าเป็น "จริง" ระบบจะปิดใช้การเผยแพร่เหตุการณ์ โปรดทราบว่าข้อมูลนี้ไม่เหมือนกับพร็อพเพอร์ตี้เหตุการณ์ส่วนตัว ไม่บังคับ เปลี่ยนแปลงไม่ได้ ค่าเริ่มต้นคือ "เท็จ" | |
recurrence[] |
list |
รายการบรรทัด RRULE, EXRULE, RDATE และ EXDATE สำหรับกิจกรรมที่เกิดซ้ำ ตามที่ระบุไว้ใน RFC5545 โปรดทราบว่าไม่อนุญาตให้ใช้บรรทัด DTSTART และ DTEND ในช่องนี้ เนื่องจากมีการระบุเวลาเริ่มต้นและสิ้นสุดของกิจกรรมไว้ในช่อง start และ end ช่องนี้จะถูกยกเว้นไว้สำหรับกิจกรรมเดียวหรือหลายกิจกรรมที่เกิดซ้ำ |
เขียนได้ |
recurringEventId |
string |
สำหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ นี่คือ id ของกิจกรรมที่เกิดซ้ำซึ่งเป็นของอินสแตนซ์นี้ เปลี่ยนแปลงไม่ได้ |
|
reminders |
object |
ข้อมูลเกี่ยวกับการช่วยเตือนของกิจกรรมสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว | |
reminders.overrides[] |
list |
หากกิจกรรมไม่ได้ใช้การแจ้งเตือนเริ่มต้น ระบบจะแสดงการแจ้งเตือนสำหรับกิจกรรมดังกล่าวเท่านั้น หรือหากไม่ได้ตั้งค่า ก็แสดงว่าไม่มีการตั้งค่าการแจ้งเตือนสำหรับกิจกรรมนี้ จำนวนสูงสุดของการแจ้งเตือนให้ลบล้างคือ 5 | เขียนได้ |
reminders.overrides[].method |
string |
วิธีการที่การช่วยเตือนนี้ใช้ ค่าที่เป็นไปได้มีดังนี้:
ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
reminders.overrides[].minutes |
integer |
จำนวนนาทีก่อนเริ่มกิจกรรมเมื่อการแจ้งเตือนจะเริ่มขึ้น ค่าที่ถูกต้องจะอยู่ระหว่าง 0 ถึง 40320 (4 สัปดาห์ในหน่วยนาที) ต้องระบุเมื่อเพิ่มการช่วยเตือน |
เขียนได้ |
reminders.useDefault |
boolean |
กำหนดว่าการช่วยเตือนเริ่มต้นของปฏิทินจะใช้กับกิจกรรมหรือไม่ | เขียนได้ |
sequence |
integer |
หมายเลขลำดับตาม iCalendar | เขียนได้ |
source |
object |
แหล่งที่มาที่สร้างกิจกรรม ตัวอย่างเช่น หน้าเว็บ ข้อความอีเมล หรือเอกสารใดๆ ที่สามารถระบุได้ด้วย URL ที่มีรูปแบบ HTTP หรือ HTTPS เฉพาะผู้สร้างกิจกรรมเท่านั้นที่สามารถดูหรือแก้ไขได้ | |
source.title |
string |
ชื่อของแหล่งที่มา เช่น ชื่อของหน้าเว็บหรือเรื่องอีเมล | เขียนได้ |
source.url |
string |
URL ของแหล่งที่มาที่ชี้ไปยังทรัพยากร Scheme ของ URL ต้องเป็น HTTP หรือ HTTPS | เขียนได้ |
start |
nested object |
เวลาเริ่มต้นของกิจกรรม (รวม) สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาเริ่มต้นของอินสแตนซ์แรก | |
start.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากกิจกรรมนี้เป็นแบบตลอดวัน | เขียนได้ |
start.dateTime |
datetime |
เวลาเป็นค่าวันที่-เวลาแบบรวม (จัดรูปแบบตาม RFC3339) จำเป็นต้องมีการชดเชยเขตเวลา เว้นแต่จะระบุเขตเวลาใน timeZone อย่างชัดเจน |
เขียนได้ |
start.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "ยุโรป/ซูริค") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกช่องนี้และระบุเขตเวลาที่มีการขยายการเกิดซ้ำ สำหรับเหตุการณ์เดียว ช่องนี้จะมีหรือไม่มีก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับการเริ่มต้น/สิ้นสุดกิจกรรม | เขียนได้ |
status |
string |
สถานะของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้:
|
เขียนได้ |
summary |
string |
ชื่อกิจกรรม | เขียนได้ |
transparency |
string |
กิจกรรมบล็อกเวลาในปฏิทินหรือไม่ ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้:
|
เขียนได้ |
updated |
datetime |
เวลาที่แก้ไขเหตุการณ์ล่าสุด (เป็นการประทับเวลา RFC3339) อ่านอย่างเดียว | |
visibility |
string |
ระดับการเข้าถึงกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้:
|
เขียนได้ |
workingLocationProperties |
nested object |
ข้อมูลเหตุการณ์สถานที่ทำงาน | เขียนได้ |
workingLocationProperties.customLocation |
object |
หากมี ให้ระบุว่าผู้ใช้กำลังทำงานจากสถานที่ที่กำหนดเอง | เขียนได้ |
workingLocationProperties.customLocation.label |
string |
ป้ายกำกับเพิ่มเติมที่ไม่บังคับสำหรับข้อมูลเพิ่มเติม | เขียนได้ |
workingLocationProperties.homeOffice |
any value |
หากมี ให้ระบุว่าผู้ใช้ทำงานอยู่ที่บ้าน | เขียนได้ |
workingLocationProperties.officeLocation |
object |
หากมี ให้ระบุว่าผู้ใช้ทำงานจากสำนักงาน | เขียนได้ |
workingLocationProperties.officeLocation.buildingId |
string |
ตัวระบุอาคารที่ไม่บังคับ รหัสนี้ควรอ้างอิงรหัสอาคารในฐานข้อมูลทรัพยากรขององค์กร | เขียนได้ |
workingLocationProperties.officeLocation.deskId |
string |
ตัวระบุเดสก์ (ไม่บังคับ) | เขียนได้ |
workingLocationProperties.officeLocation.floorId |
string |
ตัวระบุชั้นที่ไม่บังคับ | เขียนได้ |
workingLocationProperties.officeLocation.floorSectionId |
string |
ตัวระบุส่วนชั้น (ไม่บังคับ) | เขียนได้ |
workingLocationProperties.officeLocation.label |
string |
ชื่อสำนักงานที่แสดงในไคลเอ็นต์ของปฏิทินบนเว็บและอุปกรณ์เคลื่อนที่ เราขอแนะนำให้คุณอ้างอิงชื่ออาคารในฐานข้อมูลทรัพยากรขององค์กร | เขียนได้ |
workingLocationProperties.type |
string |
ประเภทสถานที่ทำงาน ค่าที่เป็นไปได้มีดังนี้:
ต้องระบุเมื่อเพิ่มพร็อพเพอร์ตี้สถานที่ทำงาน |
เขียนได้ |
วิธีการ
- ลบ
- ลบกิจกรรม
- ได้
- ส่งคืนกิจกรรมตามรหัส Google ปฏิทิน หากต้องการเรียกข้อมูลกิจกรรมโดยใช้รหัส iCalendar ให้เรียกเมธอด events.list โดยใช้พารามิเตอร์
iCalUID
- import
- นำเข้ากิจกรรม การทำงานนี้ใช้เพื่อเพิ่มสำเนาส่วนตัวของกิจกรรมที่มีอยู่ลงในปฏิทิน
- แทรก
- สร้างกิจกรรม
- อินสแตนซ์
- แสดงผลกิจกรรมที่เกิดซ้ำที่ระบุ
- list
- แสดงกิจกรรมในปฏิทินที่ระบุ
- ย้าย
- ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม โปรดทราบว่าสามารถย้ายได้เพียง
default
กิจกรรมเท่านั้น ไม่สามารถย้ายoutOfOffice
,focusTime
และworkingLocation
ได้ - แพตช์
- อัปเดตกิจกรรม เมธอดนี้รองรับความหมายของแพตช์ โปรดทราบว่าคำขอแพตช์แต่ละรายการจะใช้หน่วยโควต้า 3 หน่วย แนะนำให้ใช้
get
ตามด้วยupdate
ค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ส่วนช่องที่คุณไม่ได้ระบุไว้ในคำขอจะยังคงเดิมไม่เปลี่ยนแปลง ช่องอาร์เรย์ (หากระบุ) จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะยกเลิกองค์ประกอบอาร์เรย์ก่อนหน้า - quickAdd
- สร้างเหตุการณ์ตามสตริงข้อความธรรมดา
- อัปเดต
- อัปเดตกิจกรรม เมธอดนี้ไม่รองรับความหมายของแพตช์และอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ทําตาม
get
ตามด้วยupdate
โดยใช้ etag เพื่อให้มั่นใจถึงความสม่ำเสมอ - นาฬิกาข้อมือ
- คอยดูการเปลี่ยนแปลงในแหล่งข้อมูลกิจกรรม