API Lịch cung cấp nhiều loại tài nguyên sự kiện, bạn có thể xem thêm thông tin trong phần Giới thiệu về sự kiện.
Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.
Biểu thị tài nguyên
{ "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 }
Tên tài sản | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
anyoneCanAddSelf |
boolean |
Liệu bất kỳ ai cũng có thể tự mời mình tham gia sự kiện hay không (không dùng nữa). Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
attachments[] |
list |
Tệp đính kèm cho sự kiện. Để sửa đổi tệp đính kèm, bạn phải đặt tham số yêu cầu Mỗi sự kiện có thể có tối đa 25 tệp đính kèm, |
|
attachments[].fileId |
string |
Mã của tệp đính kèm. Chỉ có thể đọc. Đối với các tệp trên Google Drive, đây là mã nhận dạng của mục nhập tài nguyên |
|
attachments[].fileUrl |
string |
Đường liên kết URL đến tệp đính kèm. Để thêm tệp đính kèm trên Google Drive, hãy sử dụng định dạng giống như trong thuộc tính Bắt buộc khi thêm tệp đính kèm. |
writable |
attachments[].iconLink |
string |
Đường liên kết URL đến biểu tượng tệp đính kèm. Bạn chỉ có thể sửa đổi trường này cho các tệp đính kèm tuỳ chỉnh của bên thứ ba. | |
attachments[].mimeType |
string |
Loại phương tiện Internet (loại MIME) của tệp đính kèm. | |
attachments[].title |
string |
Tên tệp đính kèm. | |
attendeesOmitted |
boolean |
Liệu người tham dự có bị bỏ qua khỏi nội dung trình bày sự kiện hay không. Khi truy xuất một sự kiện, điều này có thể là do hạn chế do tham số truy vấn maxAttendee chỉ định. Khi cập nhật một sự kiện, bạn có thể sử dụng thuộc tính này để chỉ cập nhật câu trả lời của người tham gia. Không bắt buộc. Giá trị mặc định là False. |
có thể ghi |
attendees[] |
list |
Những người tham dự sự kiện. Hãy xem hướng dẫn về Sự kiện có người tham dự để biết thêm thông tin về cách lên lịch sự kiện với những người dùng lịch khác. Tài khoản dịch vụ cần sử dụng tính năng uỷ quyền trên toàn miền để điền danh sách người tham dự. | writable |
attendees[].additionalGuests |
integer |
Số lượng khách bổ sung. Không bắt buộc. Giá trị mặc định là 0. | writable |
attendees[].comment |
string |
Bình luận phản hồi của người tham dự. Không bắt buộc. | writable |
attendees[].displayName |
string |
Tên của người tham dự, nếu có. Không bắt buộc. | writable |
attendees[].email |
string |
Địa chỉ email của người tham dự, nếu có. Trường này phải xuất hiện khi thêm người tham dự. Đây phải là địa chỉ email hợp lệ theo RFC5322. Bắt buộc khi thêm người tham dự. |
có thể ghi |
attendees[].id |
string |
Mã hồ sơ của người tham dự, nếu có. | |
attendees[].optional |
boolean |
Liệu đây có phải là khách mời không bắt buộc hay không. Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
attendees[].organizer |
boolean |
Người tham dự có phải là người tổ chức sự kiện hay không. Chỉ có thể đọc. Giá trị mặc định là False. | |
attendees[].resource |
boolean |
Người tham dự có phải là tài nguyên hay không. Bạn chỉ có thể đặt khi thêm người tham dự vào sự kiện lần đầu tiên. Các nội dung sửa đổi tiếp theo sẽ bị bỏ qua. Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
attendees[].responseStatus |
string |
Trạng thái phản hồi của người tham dự. Các giá trị có thể sử dụng là:
|
writable |
attendees[].self |
boolean |
Liệu mục này có đại diện cho lịch xuất hiện bản sao sự kiện này hay không. Chỉ có thể đọc. Giá trị mặc định là False. | |
birthdayProperties |
nested object |
Dữ liệu về ngày sinh nhật hoặc sự kiện đặc biệt. Được dùng nếu eventType là "birthday" . Không thể thay đổi. |
writable |
birthdayProperties.contact |
string |
Tên tài nguyên của người liên hệ được liên kết với sự kiện sinh nhật này. Bạn có thể dùng mã này để tìm nạp thông tin liên hệ từ API People. Định dạng: "people/c12345" . Chỉ có thể đọc. |
|
birthdayProperties.customTypeName |
string |
Nhãn loại tuỳ chỉnh được chỉ định cho sự kiện này. Giá trị này được điền nếu bạn đặt birthdayProperties.type thành "custom" . Chỉ có thể đọc. |
|
birthdayProperties.type |
string |
Loại sinh nhật hoặc sự kiện đặc biệt. Các giá trị có thể sử dụng là:
"birthday" . Bạn không thể thay đổi loại sự kiện sau khi tạo. |
writable |
colorId |
string |
Màu của sự kiện. Đây là mã nhận dạng tham chiếu đến một mục trong phần event của định nghĩa màu (xem điểm cuối màu). Không bắt buộc. |
có thể ghi |
conferenceData |
nested object |
Thông tin liên quan đến hội nghị, chẳng hạn như thông tin chi tiết về một hội nghị trên Google Meet. Để tạo thông tin chi tiết mới về hội nghị, hãy sử dụng trường createRequest . Để duy trì các thay đổi, hãy nhớ đặt tham số yêu cầu conferenceDataVersion thành 1 cho tất cả các yêu cầu sửa đổi sự kiện. |
có thể ghi |
conferenceData.conferenceId |
string |
Mã của hội nghị. Nhà phát triển có thể sử dụng để theo dõi các hội nghị, không được hiển thị cho người dùng. Giá trị mã nhận dạng được tạo theo cách khác nhau cho từng loại giải pháp hội nghị:
|
|
conferenceData.conferenceSolution |
nested object |
Giải pháp hội nghị, chẳng hạn như Google Meet. Không đặt được cho một hội nghị có yêu cầu tạo không thành công. Bạn phải cung cấp |
|
conferenceData.conferenceSolution.iconUri |
string |
Biểu tượng hiển thị cho người dùng của giải pháp này. | |
conferenceData.conferenceSolution.key |
nested object |
Khoá có thể xác định chính xác giải pháp hội nghị cho sự kiện này. | |
conferenceData.conferenceSolution.key.type |
string |
Loại giải pháp hội nghị. Nếu gặp phải một loại không quen thuộc hoặc trống, ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, bạn không được phép sửa đổi. Các giá trị có thể có là:
|
|
conferenceData.conferenceSolution.name |
string |
Tên hiển thị cho người dùng của giải pháp này. Chưa được bản địa hoá. | |
conferenceData.createRequest |
nested object |
Yêu cầu tạo một hội nghị mới và đính kèm hội nghị đó vào sự kiện. Dữ liệu được tạo không đồng bộ. Để xem dữ liệu có xuất hiện hay không, hãy kiểm tra trường status . Bạn phải cung cấp |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
Giải pháp hội nghị, chẳng hạn như Hangouts hoặc Google Meet. | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
Loại giải pháp hội nghị. Nếu gặp phải một loại không quen thuộc hoặc trống, ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, bạn không được phép sửa đổi. Các giá trị có thể có là:
|
|
conferenceData.createRequest.requestId |
string |
Mã nhận dạng duy nhất do ứng dụng tạo cho yêu cầu này. Ứng dụng khách phải tạo lại mã nhận dạng này cho mỗi yêu cầu mới. Nếu mã nhận dạng được cung cấp giống với mã của yêu cầu trước đó, thì yêu cầu đó sẽ bị bỏ qua. |
|
conferenceData.createRequest.status |
nested object |
Trạng thái của yêu cầu tạo hội nghị truyền hình. | |
conferenceData.createRequest.status.statusCode |
string |
Trạng thái hiện tại của yêu cầu tạo cuộc gọi nhiều bên. Chỉ có thể đọc. Các giá trị có thể có là:
|
|
conferenceData.entryPoints[] |
list |
Thông tin về từng điểm truy cập vào hội nghị, chẳng hạn như URL hoặc số điện thoại. Tất cả các hội nghị đó phải thuộc cùng một hội nghị. Bạn phải cung cấp |
|
conferenceData.entryPoints[].accessCode |
string |
Mã truy cập để truy cập vào hội nghị truyền hình. Độ dài tối đa là 128 ký tự. Khi tạo dữ liệu hội nghị mới, chỉ điền các trường con { Không bắt buộc. |
|
conferenceData.entryPoints[].entryPointType |
string |
Loại điểm truy cập hội nghị. Các giá trị có thể là:
|
|
conferenceData.entryPoints[].label |
string |
Nhãn cho URI. Người dùng cuối có thể nhìn thấy tên này. Chưa bản địa hoá. Độ dài tối đa là 512 ký tự. Ví dụ:
Không bắt buộc. |
|
conferenceData.entryPoints[].meetingCode |
string |
Mã cuộc họp để truy cập vào hội nghị truyền hình này. Độ dài tối đa là 128 ký tự. Khi tạo dữ liệu hội nghị mới, chỉ điền các trường con { Không bắt buộc. |
|
conferenceData.entryPoints[].passcode |
string |
Mã truy cập để tham gia cuộc họp. Độ dài tối đa là 128 ký tự. Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường { |
|
conferenceData.entryPoints[].password |
string |
Mật khẩu để truy cập vào cuộc họp. Độ dài tối đa là 128 ký tự. Khi tạo dữ liệu hội nghị mới, chỉ điền các trường con { Không bắt buộc. |
|
conferenceData.entryPoints[].pin |
string |
Mã PIN để truy cập vào cuộc họp. Độ dài tối đa là 128 ký tự. Khi tạo dữ liệu hội nghị mới, chỉ điền các trường con { Không bắt buộc. |
|
conferenceData.entryPoints[].uri |
string |
URI của điểm truy cập. Độ dài tối đa là 1.300 ký tự. Định dạng:
|
|
conferenceData.notes |
string |
Ghi chú bổ sung (chẳng hạn như hướng dẫn của quản trị viên miền, thông báo pháp lý) để hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2048 ký tự. Không bắt buộc. | |
conferenceData.signature |
string |
Chữ ký của dữ liệu hội nghị. Được tạo phía máy chủ. Không đặt cho một hội nghị có yêu cầu tạo không thành công. Không bắt buộc đối với hội nghị có yêu cầu tạo đang chờ xử lý. |
|
created |
datetime |
Thời gian tạo sự kiện (dưới dạng dấu thời gian RFC3339). Chỉ có thể đọc. | |
creator |
object |
Người tạo sự kiện. Chỉ có thể đọc. | |
creator.displayName |
string |
Tên của nhà sáng tạo (nếu có). | |
creator.email |
string |
Địa chỉ email của nhà sáng tạo, nếu có. | |
creator.id |
string |
Mã hồ sơ của nhà sáng tạo, nếu có. | |
creator.self |
boolean |
Liệu người tạo có tương ứng với lịch mà bản sao của sự kiện này xuất hiện hay không. Chỉ có thể đọc. Giá trị mặc định là False. | |
description |
string |
Mô tả về sự kiện. Có thể chứa HTML. Không bắt buộc. | writable |
end |
nested object |
Thời gian kết thúc (loại trừ) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian kết thúc của phiên bản đầu tiên. | |
end.date |
date |
Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra cả ngày. | writable |
end.dateTime |
datetime |
Thời gian, dưới dạng giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chỉ định độ lệch múi giờ trừ phi bạn chỉ định rõ múi giờ trong timeZone . |
có thể ghi |
end.timeZone |
string |
Múi giờ mà giờ được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. | writable |
endTimeUnspecified |
boolean |
Liệu thời gian kết thúc có thực sự không được chỉ định hay không. Thời gian kết thúc vẫn được cung cấp vì lý do tương thích, ngay cả khi thuộc tính này được đặt thành True. Giá trị mặc định là False. | |
etag |
etag |
ETag của tài nguyên. | |
eventType |
string |
Loại sự kiện cụ thể. Bạn không thể sửa đổi chế độ này sau khi tạo sự kiện. Các giá trị có thể sử dụng là:
|
writable |
extendedProperties |
object |
Các thuộc tính mở rộng của sự kiện. | |
extendedProperties.private |
object |
Các thuộc tính riêng tư đối với bản sao của sự kiện xuất hiện trên lịch này. | writable |
extendedProperties.private.(key) |
string |
Tên của khu vực tư nhân và giá trị tương ứng. | |
extendedProperties.shared |
object |
Các thuộc tính được chia sẻ giữa các bản sao của sự kiện trên lịch của những người tham dự khác. | writable |
extendedProperties.shared.(key) |
string |
Tên của thuộc tính dùng chung và giá trị tương ứng. | |
focusTimeProperties |
nested object |
Dữ liệu sự kiện Thời gian cần tập trung. Được dùng nếu eventType là focusTime . |
có thể ghi |
focusTimeProperties.autoDeclineMode |
string |
Liệu có từ chối lời mời họp chồng chéo với sự kiện Thời gian cần tập trung hay không. Giá trị hợp lệ là declineNone , nghĩa là không có lời mời họp nào bị từ chối; declineAllConflictingInvitations , nghĩa là tất cả lời mời họp xung đột có xung đột với sự kiện đều bị từ chối; và declineOnlyNewConflictingInvitations , nghĩa là chỉ những lời mời họp xung đột mới đến khi có sự kiện Thời gian cần tập trung mới bị từ chối. |
|
focusTimeProperties.chatStatus |
string |
Trạng thái để đánh dấu người dùng trong Chat và các sản phẩm có liên quan. Giá trị này có thể là available hoặc doNotDisturb . |
|
focusTimeProperties.declineMessage |
string |
Thư trả lời cần thiết lập nếu Lịch tự động từ chối một sự kiện hiện có hoặc lời mời mới. | |
gadget |
object |
Một tiện ích mở rộng sự kiện này. Tiện ích không còn được dùng nữa; thay vào đó, cấu trúc này chỉ được dùng để trả về siêu dữ liệu về lịch sinh nhật. | |
gadget.display |
string |
Chế độ hiển thị của tiện ích. Không dùng nữa. Các giá trị có thể sử dụng là:
|
writable |
gadget.height |
integer |
Chiều cao của tiện ích tính bằng pixel. Chiều cao phải là số nguyên lớn hơn 0. Không bắt buộc. Không dùng nữa. | có thể ghi |
gadget.iconLink |
string |
URL của biểu tượng tiện ích. Giao thức URL phải là HTTPS. Không dùng nữa. | writable |
gadget.link |
string |
URL của tiện ích. Giao thức URL phải là HTTPS. Không dùng nữa. | có thể ghi |
gadget.preferences |
object |
Tùy chọn. | có thể ghi |
gadget.preferences.(key) |
string |
Tên lựa chọn ưu tiên và giá trị tương ứng. | |
gadget.title |
string |
Tiêu đề của tiện ích. Không dùng nữa. | writable |
gadget.type |
string |
Loại tiện ích. Không dùng nữa. | writable |
gadget.width |
integer |
Chiều rộng của tiện ích tính bằng pixel. Chiều rộng phải là một số nguyên lớn hơn 0. Không bắt buộc. Không dùng nữa. | writable |
guestsCanInviteOthers |
boolean |
Liệu người tham dự không phải người tổ chức có thể mời người khác tham gia sự kiện hay không. Không bắt buộc. Giá trị mặc định là True. | writable |
guestsCanModify |
boolean |
Liệu người tham dự khác với người tổ chức có thể sửa đổi sự kiện hay không. Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
guestsCanSeeOtherGuests |
boolean |
Những người tham dự khác ngoài người tổ chức có thể xem những người tham dự sự kiện hay không. Không bắt buộc. Giá trị mặc định là True. | writable |
hangoutLink |
string |
Đường liên kết tuyệt đối đến Google Hangout được liên kết với sự kiện này. Chỉ có thể đọc. | |
htmlLink |
string |
Đường liên kết tuyệt đối đến sự kiện này trong giao diện người dùng web của Lịch Google. Chỉ có thể đọc. | |
iCalUID |
string |
Giá trị nhận dạng sự kiện duy nhất như được xác định trong RFC5545. Mã này dùng để xác định duy nhất các sự kiện trên các hệ thống lịch và phải được cung cấp khi nhập sự kiện thông qua phương thức import (nhập). Xin lưu ý rằng |
|
id |
string |
Giá trị nhận dạng mờ của sự kiện. Khi tạo sự kiện đơn lẻ hoặc định kỳ mới, bạn có thể chỉ định mã của các sự kiện đó. Mã nhận dạng được cung cấp phải tuân theo các quy tắc sau:
Nếu bạn không chỉ định mã nhận dạng, máy chủ sẽ tự động tạo mã nhận dạng. Xin lưu ý rằng |
writable |
kind |
string |
Loại tài nguyên ("calendar#event "). |
|
location |
string |
Vị trí địa lý của sự kiện dưới dạng văn bản dạng tự do. Không bắt buộc. | writable |
locked |
boolean |
Liệu đây có phải là bản sao sự kiện bị khoá hay không. Bạn không thể thay đổi các trường sự kiện chính "tóm tắt", "mô tả", "vị trí", "bắt đầu", "kết thúc" hoặc "lặp lại". Giá trị mặc định là False. Chỉ có thể đọc. | |
organizer |
object |
Người tổ chức sự kiện. Nếu người tổ chức cũng là người tham dự, thì điều này được biểu thị bằng một mục riêng trong attendees với trường organizer được đặt thành True. Để thay đổi người tổ chức, hãy sử dụng thao tác di chuyển. Chỉ có thể đọc, ngoại trừ khi nhập sự kiện. |
có thể ghi |
organizer.displayName |
string |
Tên của người tổ chức (nếu có). | có thể ghi |
organizer.email |
string |
Địa chỉ email của người tổ chức (nếu có). Đây phải là địa chỉ email hợp lệ theo RFC5322. | writable |
organizer.id |
string |
Mã hồ sơ của người tổ chức (nếu có). | |
organizer.self |
boolean |
Người tổ chức có tương ứng với lịch xuất hiện bản sao sự kiện này hay không. Chỉ có thể đọc. Giá trị mặc định là False. | |
originalStartTime |
nested object |
Đối với một thực thể của sự kiện định kỳ, đây là thời gian sự kiện này bắt đầu theo dữ liệu định kỳ trong sự kiện định kỳ được xác định bằng recurringEventId. Mã này giúp xác định riêng một thực thể trong chuỗi sự kiện định kỳ ngay cả khi thực thể đó được chuyển sang một thời điểm khác. Không thể thay đổi. | |
originalStartTime.date |
date |
Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra cả ngày. | writable |
originalStartTime.dateTime |
datetime |
Thời gian, dưới dạng giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chỉ định độ lệch múi giờ trừ phi bạn chỉ định rõ múi giờ trong timeZone . |
có thể ghi |
originalStartTime.timeZone |
string |
Múi giờ mà giờ được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. | writable |
outOfOfficeProperties |
nested object |
Dữ liệu sự kiện không có mặt tại văn phòng. Được dùng nếu eventType là outOfOffice . |
writable |
outOfOfficeProperties.autoDeclineMode |
string |
Liệu có nên từ chối lời mời họp trùng với sự kiện Không có mặt tại văn phòng hay không. Các giá trị hợp lệ là declineNone , nghĩa là không từ chối lời mời họp nào; declineAllConflictingInvitations , nghĩa là từ chối tất cả lời mời họp xung đột với sự kiện; và declineOnlyNewConflictingInvitations , nghĩa là chỉ từ chối lời mời họp xung đột mới đến trong khi sự kiện Không có mặt tại văn phòng đang diễn ra. |
|
outOfOfficeProperties.declineMessage |
string |
Tin nhắn phản hồi để thiết lập nếu sự kiện hiện có hoặc lời mời mới bị Lịch tự động từ chối. | |
privateCopy |
boolean |
Nếu bạn đặt chính sách này thành True, thì tính năng Truyền tải sự kiện sẽ bị tắt. Xin lưu ý rằng đây không phải là Thuộc tính sự kiện riêng tư. Không bắt buộc. Bất biến. Giá trị mặc định là False. | |
recurrence[] |
list |
Danh sách các dòng RQU, EXRules, RDATE và EXDATE cho một sự kiện định kỳ, như được chỉ định trong RFC5545. Xin lưu ý rằng bạn không được phép sử dụng dòng DTSTART và DTEND trong trường này; thời gian bắt đầu và kết thúc sự kiện được chỉ định trong trường start và end . Trường này bị bỏ qua đối với các sự kiện đơn lẻ hoặc lần diễn ra sự kiện định kỳ. |
có thể ghi |
recurringEventId |
string |
Đối với một thực thể của sự kiện định kỳ, đây là id của sự kiện định kỳ mà thực thể này thuộc về. Không thể thay đổi. |
|
reminders |
object |
Thông tin về lời nhắc của sự kiện cho người dùng đã xác thực. Xin lưu ý rằng việc thay đổi lời nhắc cũng không thay đổi thuộc tính updated của sự kiện bao gồm. |
|
reminders.overrides[] |
list |
Nếu sự kiện không sử dụng lời nhắc mặc định, thì trường này sẽ liệt kê các lời nhắc dành riêng cho sự kiện đó hoặc nếu không được đặt, thì trường này sẽ cho biết rằng không có lời nhắc nào được đặt cho sự kiện này. Số lời nhắc ghi đè tối đa là 5. | có thể ghi |
reminders.overrides[].method |
string |
Phương thức mà lời nhắc này sử dụng. Các giá trị có thể sử dụng là:
Bắt buộc khi thêm lời nhắc. |
có thể ghi |
reminders.overrides[].minutes |
integer |
Số phút trước khi bắt đầu sự kiện mà lời nhắc sẽ kích hoạt. Giá trị hợp lệ nằm trong khoảng từ 0 đến 40320 (4 tuần tính bằng phút). Bắt buộc khi thêm lời nhắc. |
writable |
reminders.useDefault |
boolean |
Liệu lời nhắc mặc định của lịch có áp dụng cho sự kiện hay không. | writable |
sequence |
integer |
Số thứ tự theo iCalendar. | writable |
source |
object |
Nguồn tạo ra sự kiện. Ví dụ: một trang web, một email hoặc bất kỳ tài liệu nào có thể xác định được bằng một URL có lược đồ HTTP hoặc HTTPS. Chỉ người tạo sự kiện mới có thể xem hoặc sửa đổi. | |
source.title |
string |
Tiêu đề của nguồn; ví dụ: tiêu đề của một trang web hoặc tiêu đề email. | có thể ghi |
source.url |
string |
URL của nguồn trỏ đến một tài nguyên. Giao thức URL phải là HTTP hoặc HTTPS. | writable |
start |
nested object |
Thời gian bắt đầu (bao gồm cả thời gian kết thúc) của sự kiện. Đối với một sự kiện định kỳ, đây là thời gian bắt đầu sự kiện đầu tiên. | |
start.date |
date |
Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra cả ngày. | writable |
start.dateTime |
datetime |
Thời gian, dưới dạng giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chỉ định độ lệch múi giờ trừ phi bạn chỉ định rõ múi giờ trong timeZone . |
có thể ghi |
start.timeZone |
string |
Múi giờ mà giờ được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. | writable |
status |
string |
Trạng thái của sự kiện. Không bắt buộc. Các giá trị có thể sử dụng là:
|
writable |
summary |
string |
Tiêu đề sự kiện. | có thể ghi |
transparency |
string |
Liệu sự kiện có chặn thời gian trên lịch hay không. Không bắt buộc. Các giá trị có thể có là:
|
writable |
updated |
datetime |
Thời gian sửa đổi gần đây nhất của dữ liệu sự kiện chính (dưới dạng dấu thời gian RFC3339). Việc cập nhật lời nhắc sự kiện sẽ không làm thay đổi điều này. Chỉ có thể đọc. | |
visibility |
string |
Mức hiển thị của sự kiện. Không bắt buộc. Các giá trị có thể sử dụng là:
|
writable |
workingLocationProperties |
nested object |
Dữ liệu sự kiện về địa điểm làm việc. | writable |
workingLocationProperties.customLocation |
object |
Nếu có, hãy chỉ định rằng người dùng đang làm việc tại một vị trí tuỳ chỉnh. | writable |
workingLocationProperties.customLocation.label |
string |
Một nhãn bổ sung không bắt buộc để cung cấp thêm thông tin. | writable |
workingLocationProperties.homeOffice |
any value |
Nếu có, hãy chỉ định rằng người dùng đang làm việc tại nhà. | có thể ghi |
workingLocationProperties.officeLocation |
object |
Nếu có, hãy chỉ định rằng người dùng đang làm việc tại văn phòng. | writable |
workingLocationProperties.officeLocation.buildingId |
string |
Giá trị nhận dạng tòa nhà (không bắt buộc). Mã này phải tham chiếu đến mã toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. | writable |
workingLocationProperties.officeLocation.deskId |
string |
Mã nhận dạng bàn làm việc (không bắt buộc). | có thể ghi |
workingLocationProperties.officeLocation.floorId |
string |
Giá trị nhận dạng tầng (không bắt buộc). | writable |
workingLocationProperties.officeLocation.floorSectionId |
string |
Giá trị nhận dạng phần sàn (không bắt buộc). | có thể ghi |
workingLocationProperties.officeLocation.label |
string |
Tên văn phòng xuất hiện trong ứng dụng Lịch trên web và thiết bị di động. Bạn nên tham chiếu tên toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. | writable |
workingLocationProperties.type |
string |
Loại địa điểm làm việc. Các giá trị có thể sử dụng là:
Bắt buộc khi thêm thuộc tính địa điểm làm việc. |
writable |
Phương thức
- xóa
- Xoá một sự kiện.
- get
- Trả về một sự kiện dựa trên mã sự kiện trên Lịch Google. Để truy xuất một sự kiện bằng mã nhận dạng iCalendar, hãy gọi phương thức events.list bằng tham số
iCalUID
. - import
- Nhập một sự kiện. Thao tác này dùng để thêm bản sao riêng tư của sự kiện hiện có vào lịch. Bạn chỉ có thể nhập những sự kiện có
eventType
làdefault
.Hành vi không dùng nữa: Nếu một sự kiện không phải
default
được nhập, loại của sự kiện đó sẽ được thay đổi thànhdefault
và mọi thuộc tính dành riêng cho từng loại sự kiện có thể đã bị loại bỏ. - chèn
- Tạo một sự kiện.
- phiên bản
- Trả về các bản sao của sự kiện định kỳ đã chỉ định.
- list
- Trả về các sự kiện trên lịch được chỉ định.
- di chuyển
- Di chuyển một sự kiện sang một lịch khác, tức là thay đổi người tổ chức sự kiện. Xin lưu ý rằng bạn chỉ có thể di chuyển các sự kiện
default
; không thể di chuyển các sự kiệnbirthday
,focusTime
,fromGmail
,outOfOffice
vàworkingLocation
. - bản vá
- Cập nhật sự kiện. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Xin lưu ý rằng mỗi yêu cầu vá sẽ tiêu thụ 3 đơn vị hạn mức; ưu tiên sử dụng
get
theo sau làupdate
. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Những trường bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó. - quickAdd
- Tạo sự kiện dựa trên một chuỗi văn bản đơn giản.
- update
- Cập nhật sự kiện. Phương thức này không hỗ trợ ngữ nghĩa bản vá và luôn cập nhật toàn bộ tài nguyên sự kiện. Để cập nhật một phần, hãy thực hiện
get
, sau đó làupdate
bằng cách sử dụng các thẻ điện tử để đảm bảo tính tỉ mỉ. - watch
- Theo dõi các thay đổi đối với tài nguyên Sự kiện.