Calendar 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
}
],
"birthdayProperties": {
"contact": string,
"type": string,
"customTypeName": string
},
"eventType": string
}| ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
|---|---|---|---|
anyoneCanAddSelf |
boolean |
ไม่ว่าใครจะเชิญตัวเองเข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งานแล้ว) ไม่บังคับ ค่าเริ่มต้นคือ False | เขียนได้ |
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 เมื่ออัปเดตกิจกรรม คุณสามารถใช้พารามิเตอร์นี้เพื่ออัปเดตเฉพาะคำตอบของผู้เข้าร่วมได้ ไม่บังคับ ค่าเริ่มต้นคือ False |
เขียนได้ |
attendees[] |
list |
ผู้เข้าร่วมกิจกรรม ดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดเวลากิจกรรมร่วมกับผู้ใช้ปฏิทินรายอื่นได้ในคู่มือกิจกรรมที่มีผู้เข้าร่วม บัญชีบริการต้องใช้การมอบสิทธิ์ทั้งโดเมนเพื่อสร้างรายการผู้เข้าร่วม | เขียนได้ |
attendees[].additionalGuests |
integer |
จำนวนแขกเพิ่มเติม ไม่บังคับ ค่าเริ่มต้นคือ 0 | เขียนได้ |
attendees[].comment |
string |
ความคิดเห็นตอบกลับของผู้เข้าร่วม ไม่บังคับ | เขียนได้ |
attendees[].displayName |
string |
ชื่อผู้เข้าร่วม (หากมี) ไม่บังคับ | เขียนได้ |
attendees[].email |
string |
อีเมลของผู้เข้าร่วม (หากมี) ต้องระบุช่องนี้เมื่อเพิ่มผู้เข้าร่วม ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 ต้องระบุเมื่อเพิ่มผู้เข้าร่วม |
เขียนได้ |
attendees[].id |
string |
รหัสโปรไฟล์ของผู้เข้าร่วม (หากมี) | |
attendees[].optional |
boolean |
ระบุว่าผู้เข้าร่วมเป็นผู้เข้าร่วมที่ไม่บังคับหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False | เขียนได้ |
attendees[].organizer |
boolean |
ระบุว่าผู้เข้าร่วมเป็นผู้จัดกิจกรรมหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False | |
attendees[].resource |
boolean |
ผู้เข้าร่วมเป็นทรัพยากรหรือไม่ ตั้งค่าได้เมื่อเพิ่มผู้เข้าร่วมลงในกิจกรรมเป็นครั้งแรกเท่านั้น ระบบจะไม่สนใจการแก้ไขในภายหลัง ไม่บังคับ ค่าเริ่มต้นคือ False | เขียนได้ |
attendees[].responseStatus |
string |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
attendees[].self |
boolean |
ไม่ว่ารายการนี้จะแสดงปฏิทินที่สำเนากิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False | |
birthdayProperties |
nested object |
ข้อมูลวันเกิดหรือกิจกรรมพิเศษ ใช้ในกรณีที่ eventType เป็น "birthday" เปลี่ยนแปลงไม่ได้ |
เขียนได้ |
birthdayProperties.contact |
string |
ชื่อทรัพยากรของรายชื่อติดต่อที่เชื่อมโยงกับกิจกรรมวันเกิดนี้ ซึ่งใช้เพื่อดึงรายละเอียดรายชื่อติดต่อจาก People API ได้ รูปแบบ: "people/c12345" อ่านอย่างเดียว |
|
birthdayProperties.customTypeName |
string |
ป้ายกำกับประเภทที่กำหนดเองที่ระบุสำหรับเหตุการณ์นี้ ระบบจะป้อนข้อมูลนี้หากตั้งค่า birthdayProperties.type เป็น "custom" อ่านอย่างเดียว |
|
birthdayProperties.type |
string |
ประเภทวันเกิดหรือกิจกรรมพิเศษ ค่าที่เป็นไปได้มีดังนี้
"birthday" คุณจะเปลี่ยนประเภทหลังจากสร้างกิจกรรมแล้วไม่ได้ |
เขียนได้ |
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 ได้ ความยาวต้องไม่เกิน 2,048 อักขระ ไม่บังคับ | |
conferenceData.signature |
string |
ลายเซ็นของข้อมูลการประชุม สร้างขึ้นในฝั่งเซิร์ฟเวอร์ ไม่ได้ตั้งค่าสำหรับการประชุมที่มีคำขอสร้างไม่สำเร็จ ไม่บังคับสำหรับการประชุมที่มีคำขอสร้างที่รอดำเนินการ |
|
created |
datetime |
เวลาสร้างของเหตุการณ์ (เป็นการประทับเวลา RFC3339) อ่านอย่างเดียว | |
creator |
object |
ผู้สร้างกิจกรรม อ่านอย่างเดียว | |
creator.displayName |
string |
ชื่อของครีเอเตอร์ (หากมี) | |
creator.email |
string |
อีเมลของครีเอเตอร์ (หากมี) | |
creator.id |
string |
รหัสโปรไฟล์ของครีเอเตอร์ (หากมี) | |
creator.self |
boolean |
ไม่ว่าผู้สร้างจะตรงกับปฏิทินที่สำเนากิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False | |
description |
string |
คำอธิบายกิจกรรม มี HTML ได้ ไม่บังคับ | เขียนได้ |
end |
nested object |
เวลาสิ้นสุด (ไม่รวม) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาสิ้นสุดของอินสแตนซ์แรก | |
end.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
end.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุออฟเซ็ตเขตเวลา เว้นแต่จะระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
end.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ ฟิลด์นี้จำเป็นและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
endTimeUnspecified |
boolean |
เวลาสิ้นสุดไม่ได้ระบุไว้จริงหรือไม่ ระบบจะยังคงระบุเวลาสิ้นสุดด้วยเหตุผลด้านความเข้ากันได้ แม้ว่าจะตั้งค่าแอตทริบิวต์นี้เป็น "จริง" แล้วก็ตาม ค่าเริ่มต้นคือ False | |
etag |
etag |
ETag ของทรัพยากร | |
eventType |
string |
ประเภทเฉพาะของเหตุการณ์ คุณจะแก้ไขส่วนนี้หลังจากที่สร้างกิจกรรมแล้วไม่ได้ ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
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 แล้ว โครงสร้างนี้จึงใช้เพื่อแสดงผลข้อมูลเมตาของปฏิทินวันเกิดเท่านั้น | |
gadget.display |
string |
โหมดการแสดงผลของแกดเจ็ต เลิกใช้งานแล้ว ค่าที่เป็นไปได้มีดังนี้
|
เขียนได้ |
gadget.height |
integer |
ความสูงของแกดเจ็ตในหน่วยพิกเซล ความสูงต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
gadget.iconLink |
string |
URL ของไอคอนแกดเจ็ต รูปแบบ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.link |
string |
URL ของแกดเจ็ต รูปแบบ URL ต้องเป็น HTTPS เลิกใช้งานแล้ว | เขียนได้ |
gadget.preferences |
object |
ค่ากำหนด | เขียนได้ |
gadget.preferences.(key) |
string |
ชื่อค่ากําหนดและค่าที่เกี่ยวข้อง | |
gadget.title |
string |
ชื่อของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.type |
string |
ประเภทของแกดเจ็ต เลิกใช้งานแล้ว | เขียนได้ |
gadget.width |
integer |
ความกว้างของแกดเจ็ตในหน่วยพิกเซล ความกว้างต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว | เขียนได้ |
guestsCanInviteOthers |
boolean |
ผู้เข้าร่วมคนอื่นๆ นอกเหนือจากผู้จัดจะเชิญผู้อื่นมาเข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
guestsCanModify |
boolean |
ผู้เข้าร่วมคนอื่นๆ นอกเหนือจากผู้จัดจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False | เขียนได้ |
guestsCanSeeOtherGuests |
boolean |
ผู้เข้าร่วมคนอื่นๆ นอกเหนือจากผู้จัดจะดูได้ไหมว่าใครเป็นผู้เข้าร่วมกิจกรรม ไม่บังคับ ค่าเริ่มต้นคือ True | เขียนได้ |
hangoutLink |
string |
ลิงก์ที่แน่นอนไปยัง Google Hangout ที่เชื่อมโยงกับกิจกรรมนี้ อ่านอย่างเดียว | |
htmlLink |
string |
ลิงก์ที่แน่นอนไปยังกิจกรรมนี้ใน UI เว็บของ Google ปฏิทิน อ่านอย่างเดียว | |
iCalUID |
string |
ตัวระบุที่ไม่ซ้ำของเหตุการณ์ตามที่กำหนดไว้ใน RFC5545 ใช้เพื่อระบุเหตุการณ์ในระบบการจัดตารางเวลาต่างๆ โดยไม่ซ้ำกัน และต้องระบุเมื่อนำเข้าเหตุการณ์ผ่านเมธอด import โปรดทราบว่า |
|
id |
string |
ตัวระบุเหตุการณ์แบบทึบ เมื่อสร้างกิจกรรมใหม่แบบครั้งเดียวหรือแบบเกิดซ้ำ คุณจะระบุรหัสของกิจกรรมได้ บัตรประจำตัวที่ส่งมาต้องเป็นไปตามกฎต่อไปนี้
หากคุณไม่ได้ระบุรหัส เซิร์ฟเวอร์จะสร้างรหัสให้โดยอัตโนมัติ โปรดทราบว่า |
เขียนได้ |
kind |
string |
ประเภทของทรัพยากร ("calendar#event") |
|
location |
string |
สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบอิสระ ไม่บังคับ | เขียนได้ |
locked |
boolean |
ไม่ว่าจะเป็นสำเนากิจกรรมที่ล็อกซึ่งไม่สามารถเปลี่ยนแปลงฟิลด์กิจกรรมหลัก "สรุป" "คำอธิบาย" "สถานที่" "เริ่ม" "สิ้นสุด" หรือ "การเกิดซ้ำ" ค่าเริ่มต้นคือ False อ่านอย่างเดียว | |
organizer |
object |
ผู้จัดกิจกรรม หากผู้จัดเป็นผู้เข้าร่วมด้วย ระบบจะระบุด้วยรายการแยกต่างหากใน attendees โดยตั้งค่าฟิลด์ organizer เป็น True หากต้องการเปลี่ยนผู้จัด ให้ใช้การดำเนินการย้าย อ่านอย่างเดียว ยกเว้นเมื่อนําเข้ากิจกรรม |
เขียนได้ |
organizer.displayName |
string |
ชื่อของผู้จัด (หากมี) | เขียนได้ |
organizer.email |
string |
อีเมลของผู้จัด (หากมี) ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 | เขียนได้ |
organizer.id |
string |
รหัสโปรไฟล์ของผู้จัดการประชุม (หากมี) | |
organizer.self |
boolean |
ไม่ว่าผู้จัดจะตรงกับปฏิทินที่สำเนากิจกรรมนี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False | |
originalStartTime |
nested object |
สำหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ นี่คือเวลาที่กิจกรรมนี้จะเริ่มตามข้อมูลการเกิดซ้ำในกิจกรรมที่เกิดซ้ำซึ่งระบุโดย recurringEventId ซึ่งจะระบุอินสแตนซ์ภายในชุดกิจกรรมที่เกิดซ้ำได้อย่างไม่ซ้ำกัน แม้ว่าจะย้ายอินสแตนซ์ไปยังเวลาอื่นแล้วก็ตาม เปลี่ยนแปลงไม่ได้ | |
originalStartTime.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
originalStartTime.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุออฟเซ็ตเขตเวลา เว้นแต่จะระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
originalStartTime.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ ฟิลด์นี้จำเป็นและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
outOfOfficeProperties |
nested object |
ข้อมูลกิจกรรมลางาน ใช้ในกรณีที่ eventType เป็น outOfOffice |
เขียนได้ |
outOfOfficeProperties.autoDeclineMode |
string |
จะปฏิเสธคำเชิญเข้าร่วมประชุมที่ทับซ้อนกับกิจกรรมลางานหรือไม่ ค่าที่ใช้ได้คือ declineNone ซึ่งหมายความว่าจะไม่มีการปฏิเสธคำเชิญเข้าร่วมการประชุม declineAllConflictingInvitations ซึ่งหมายความว่าจะมีการปฏิเสธคำเชิญเข้าร่วมการประชุมที่ขัดแย้งทั้งหมดซึ่งขัดแย้งกับกิจกรรม และ declineOnlyNewConflictingInvitations ซึ่งหมายความว่าจะมีการปฏิเสธเฉพาะคำเชิญเข้าร่วมการประชุมใหม่ที่ขัดแย้งกันซึ่งเข้ามาในขณะที่กิจกรรมลางานกำลังดำเนินอยู่ |
|
outOfOfficeProperties.declineMessage |
string |
ข้อความตอบกลับที่จะตั้งค่าหากปฏิทินปฏิเสธกิจกรรมที่มีอยู่หรือคำเชิญใหม่โดยอัตโนมัติ | |
privateCopy |
boolean |
หากตั้งค่าเป็น "จริง" ระบบจะปิดใช้การส่งต่อเหตุการณ์ โปรดทราบว่าพร็อพเพอร์ตี้เหตุการณ์ส่วนตัวไม่ใช่สิ่งเดียวกันกับพร็อพเพอร์ตี้เหตุการณ์ส่วนตัว ไม่บังคับ เปลี่ยนแปลงไม่ได้ ค่าเริ่มต้นคือ False | |
recurrence[] |
list |
รายการบรรทัด RRULE, EXRULE, RDATE และ EXDATE สำหรับกิจกรรมที่เกิดซ้ำตามที่ระบุไว้ใน RFC5545 โปรดทราบว่าไม่อนุญาตให้ใช้บรรทัด DTSTART และ DTEND ในช่องนี้ โดยจะระบุเวลาเริ่มต้นและเวลาสิ้นสุดของกิจกรรมในช่อง start และ end ระบบจะละเว้นฟิลด์นี้สำหรับกิจกรรมเดียวหรืออินสแตนซ์ของกิจกรรมที่เกิดซ้ำ |
เขียนได้ |
recurringEventId |
string |
สำหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ นี่คือ id ของกิจกรรมที่เกิดซ้ำซึ่งอินสแตนซ์นี้เป็นของ เปลี่ยนแปลงไม่ได้ |
|
reminders |
object |
ข้อมูลเกี่ยวกับการช่วยเตือนของกิจกรรมสำหรับผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ โปรดทราบว่าการเปลี่ยนการช่วยเตือนไม่ได้เปลี่ยนupdatedของกิจกรรมที่ครอบคลุมด้วย |
|
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 ของแหล่งที่มาชี้ไปยังทรัพยากร รูปแบบ URL ต้องเป็น HTTP หรือ HTTPS | เขียนได้ |
start |
nested object |
เวลาเริ่มต้นของกิจกรรม (รวมวันที่เริ่มต้น) สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาเริ่มต้นของอินสแตนซ์แรก | |
start.date |
date |
วันที่ในรูปแบบ "ปปปป-ดด-วว" หากเป็นกิจกรรมตลอดวัน | เขียนได้ |
start.dateTime |
datetime |
เวลาเป็นค่าวันที่และเวลารวม (จัดรูปแบบตาม RFC3339) ต้องระบุออฟเซ็ตเขตเวลา เว้นแต่จะระบุเขตเวลาอย่างชัดเจนใน timeZone |
เขียนได้ |
start.timeZone |
string |
เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ ฟิลด์นี้จำเป็นและระบุเขตเวลาที่จะขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้ไม่บังคับและระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม | เขียนได้ |
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 - นำเข้า
- นำเข้ากิจกรรม การดำเนินการนี้ใช้เพื่อเพิ่มสำเนาส่วนตัวของกิจกรรมที่มีอยู่ลงในปฏิทิน นําเข้าได้เฉพาะเหตุการณ์ที่มี
eventTypeเป็นdefaultลักษณะการทำงานที่เลิกใช้งานแล้ว: หากนำเข้ากิจกรรมที่ไม่ใช่
defaultระบบจะเปลี่ยนประเภทกิจกรรมเป็นdefaultและจะทิ้งพร็อพเพอร์ตี้เฉพาะประเภทกิจกรรมที่อาจมี - แทรก
- สร้างกิจกรรม
- อินสแตนซ์
- แสดงอินสแตนซ์ของกิจกรรมที่เกิดซ้ำที่ระบุ
- list
- แสดงกิจกรรมในปฏิทินที่ระบุ
- ย้าย
- ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม โปรดทราบว่าย้ายได้เฉพาะกิจกรรม
defaultเท่านั้น ส่วนกิจกรรมbirthday,focusTime,fromGmail,outOfOfficeและworkingLocationจะย้ายไม่ได้ - patch
- อัปเดตกิจกรรม วิธีนี้รองรับความหมายของการแก้ไข โปรดทราบว่าคำขอแก้ไขแต่ละรายการจะใช้โควต้า 3 หน่วย ดังนั้นจึงควรใช้
getตามด้วยupdateค่าในช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ฟิลด์ที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง ฟิลด์อาร์เรย์ หากระบุไว้ จะเขียนทับอาร์เรย์ที่มีอยู่ ซึ่งจะทิ้งองค์ประกอบอาร์เรย์ก่อนหน้า - quickAdd
- สร้างเหตุการณ์โดยอิงตามสตริงข้อความธรรมดา
- อัปเดต
- อัปเดตกิจกรรม วิธีนี้ไม่รองรับความหมายของแพตช์และจะอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ทำ
getตามด้วยupdateโดยใช้ ETag เพื่อให้มั่นใจว่าการดำเนินการเป็นแบบอะตอม - ดู
- ติดตามการเปลี่ยนแปลงในทรัพยากรเหตุการณ์