Cập nhật một sự kiện. Phương thức này không hỗ trợ ngữ nghĩa vá và luôn cập nhật toàn bộ tài nguyên sự kiện. Để thực hiện một bản cập nhật một phần, hãy thực hiện thao tác get, sau đó thực hiện thao tác update bằng cách sử dụng etag để đảm bảo tính nguyên tử.
Thử ngay.
Yêu cầu
Yêu cầu HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
Thông số
| Tên thông số | Giá trị | Mô tả |
|---|---|---|
| Tham số đường dẫn | ||
calendarId |
string |
Mã nhận dạng lịch. Để truy xuất mã lịch, hãy gọi phương thức calendarList.list. Nếu bạn muốn truy cập vào lịch chính của người dùng hiện đang đăng nhập, hãy sử dụng từ khoá "primary".
|
eventId |
string |
Giá trị nhận dạng sự kiện. |
| Tham số truy vấn không bắt buộc | ||
alwaysIncludeEmail |
boolean |
Không dùng nữa và bị bỏ qua. Giá trị sẽ luôn được trả về trong trường email cho người tổ chức, người tạo và người tham dự, ngay cả khi không có địa chỉ email thực (tức là một giá trị được tạo, không hoạt động sẽ được cung cấp).
|
conferenceDataVersion |
integer |
Số phiên bản của dữ liệu hội nghị do ứng dụng API hỗ trợ. Phiên bản 0 giả định không hỗ trợ dữ liệu hội nghị và bỏ qua dữ liệu hội nghị trong nội dung của sự kiện. Phiên bản 1 hỗ trợ việc sao chép ConferenceData cũng như việc tạo hội nghị mới bằng cách sử dụng trường createRequest của conferenceData. Giá trị mặc định là 0.
Giá trị có thể chấp nhận là từ 0 đến 1.
|
maxAttendees |
integer |
Số người tham dự tối đa cần đưa vào phản hồi. Nếu có nhiều người tham dự hơn số lượng được chỉ định, thì chỉ người tham gia mới được trả về. Không bắt buộc. |
sendNotifications |
boolean |
Không dùng nữa. Vui lòng sử dụng sendUpdates. Có gửi thông báo về nội dung cập nhật sự kiện hay không (ví dụ: thay đổi nội dung mô tả, v.v.). Xin lưu ý rằng một số email vẫn có thể được gửi ngay cả khi bạn đặt giá trị thành false. Giá trị mặc định là false.
|
sendUpdates |
string |
Khách sẽ nhận được thông báo về nội dung cập nhật của sự kiện (ví dụ: thay đổi tiêu đề, v.v.).
Các giá trị được chấp nhận là:
|
supportsAttachments |
boolean |
Cho biết liệu ứng dụng API thực hiện thao tác có hỗ trợ tệp đính kèm sự kiện hay không. Không bắt buộc. Giá trị mặc định là False. |
Ủy quyền
Yêu cầu này cần có uỷ quyền với ít nhất một trong các phạm vi sau:
| Phạm vi |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.
Nội dung yêu cầu
Trong nội dung yêu cầu, hãy cung cấp một Tài nguyên Sự kiện có các thuộc tính sau:
| Tên tài sản | Giá trị | Mô tả | Ghi chú |
|---|---|---|---|
| Thuộc tính bắt buộc | |||
end |
nested object |
Thời gian kết thúc (không bao gồm) của sự kiện. Đối với một sự kiện định kỳ, đây là thời gian kết thúc của lần xuất hiện đầu tiên. | |
start |
nested object |
Thời gian bắt đầu (bao gồm cả) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian bắt đầu của phiên bản đầu tiên. | |
| Thuộc tính không bắt buộc | |||
anyoneCanAddSelf |
boolean |
Liệu có ai có thể tự mời mình tham dự 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[].fileUrl |
string |
Đường liên kết URL đến tệp đính kèm. Để thêm tệp đính kèm của Google Drive, hãy sử dụng cùng định dạng như trong thuộc tính Bắt buộc khi thêm tệp đính kèm. |
writable |
attendees[] |
list |
Người tham dự sự kiện. Hãy xem hướng dẫn 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 quyền uỷ quyền trên toàn miền để điền sẵ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. | có thể ghi |
attendees[].comment |
string |
Bình luận phản hồi của người tham dự. Không bắt buộc. | có thể ghi |
attendees[].displayName |
string |
Tên của người tham dự (nếu có). Không bắt buộc. | có thể ghi |
attendees[].email |
string |
Địa chỉ email của người tham dự (nếu có). Bạn phải điền trường này 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[].optional |
boolean |
Đây có phải là người tham dự 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[].resource |
boolean |
Người tham dự có phải là tài nguyên hay không. Chỉ có thể đặt khi người tham dự được thêm 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ể là:
|
có thể ghi |
attendeesOmitted |
boolean |
Liệu người tham dự có thể đã bị bỏ qua trong biểu diễn sự kiện hay không. Khi truy xuất một sự kiện, điều này có thể là do một quy tắc hạn chế được chỉ định bằng tham số truy vấn maxAttendee. Khi cập nhật một sự kiện, bạn có thể dùng tham số này để chỉ cập nhật phản hồi của người tham dự. Không bắt buộc. Giá trị mặc định là False. |
writable |
colorId |
string |
Màu của sự kiện. Đây là một mã nhận dạng đề cập đế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. |
writable |
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ị truyền hình trên Google Meet. Để tạo thông tin hội nghị mới, 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. |
writable |
description |
string |
Mô tả về sự kiện. Có thể chứa HTML. Không bắt buộc. | writable |
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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. |
writable |
end.timeZone |
string |
Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại đượ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 gian bắt đầu/kết thúc sự kiện. | có thể ghi |
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. | có thể ghi |
extendedProperties.shared |
object |
Các thuộc tính được dùng chung 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. | có thể ghi |
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 |
gadget.display |
string |
Chế độ hiển thị của tiện ích. Không dùng nữa. Các giá trị có thể là:
|
có thể ghi |
gadget.height |
integer |
Chiều cao của tiện ích tính bằng pixel. Chiều cao 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. | có thể ghi |
gadget.iconLink |
string |
URL biểu tượng của 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. | writable |
gadget.preferences |
object |
Tùy chọn. | writable |
gadget.title |
string |
Tiêu đề của tiện ích. Không dùng nữa. | có thể ghi |
gadget.type |
string |
Loại của tiện ích. Không dùng nữa. | có thể ghi |
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 những người tham dự không phải là 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. | có thể ghi |
guestsCanModify |
boolean |
Liệu những người tham dự không phải là 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 |
Liệu những người tham dự không phải là người tổ chức có thể xem danh sách người tham dự sự kiện hay không. Không bắt buộc. Giá trị mặc định là True. | có thể ghi |
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 |
originalStartTime.date |
date |
Ngày ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra cả ngày. | có thể ghi |
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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. |
writable |
originalStartTime.timeZone |
string |
Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại đượ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 gian bắt đầu/kết thúc sự kiện. | có thể ghi |
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. |
có thể ghi |
recurrence[] |
list |
Danh sách các dòng RRULE, EXRULE, 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 các 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 các trường start và end. Trường này sẽ bị bỏ qua đối với các sự kiện diễn ra một lần hoặc các lần diễn ra của sự kiện định kỳ. |
có thể ghi |
reminders.overrides[] |
list |
Nếu sự kiện không sử dụng lời nhắc mặc định, thì danh sách này sẽ liệt kê những lời nhắc dành riêng cho sự kiện đó. Nếu bạn không đặt lời nhắc, thì danh sách 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ượng 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ể 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 sự kiện bắt đầu 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. |
có thể ghi |
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. | có thể ghi |
sequence |
integer |
Số thứ tự theo iCalendar. | có thể ghi |
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. | có thể ghi |
start.date |
date |
Ngày ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra cả ngày. | có thể ghi |
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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. |
writable |
start.timeZone |
string |
Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại đượ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 gian 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ể là:
|
có thể ghi |
summary |
string |
Tiêu đề sự kiện. | writable |
transparency |
string |
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ể là:
|
writable |
visibility |
string |
Chế độ hiển thị của sự kiện. Không bắt buộc. Các giá trị có thể 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 |
Nhãn bổ sung không bắt buộc để biết 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à. | writable |
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 không bắt buộc của toà nhà. Mã này phải tham chiếu đến mã nhận dạng toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. | writable |
workingLocationProperties.officeLocation.deskId |
string |
Giá trị nhận dạng bàn (không bắt buộc). | writable |
workingLocationProperties.officeLocation.floorId |
string |
Giá trị nhận dạng sàn (không bắt buộc). | writable |
workingLocationProperties.officeLocation.floorSectionId |
string |
Mã nhận dạng phần sàn (không bắt buộc). | writable |
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 khảo 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ể là:
Bắt buộc khi thêm thuộc tính địa điểm làm việc. |
có thể ghi |
Phản hồi
Nếu thành công, phương thức này sẽ trả về một Tài nguyên sự kiện trong nội dung phản hồi.
Hãy dùng thử!
Hãy sử dụng Trình khám phá API bên dưới để gọi phương thức này trên dữ liệu thực và xem phản hồi.