Events: import

Nhập một sự kiện. Thao tác này dùng để thêm một bản sao riêng tư của một sự kiện hiện có vào lịch. Bạn chỉ có thể nhập những sự kiện có eventTypedefault.

Hành vi không được dùng nữa: Nếu một sự kiện không phải là default được nhập, loại của sự kiện đó sẽ được thay đổi thành default và mọi thuộc tính dành riêng cho loại sự kiện mà sự kiện đó có thể có sẽ bị loại bỏ.

Thử ngay.

Yêu cầu

Yêu cầu HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/import

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".
Tham số truy vấn không bắt buộc
conferenceDataVersion integer Số phiên bản của dữ liệu hội nghị mà ứ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.
eventLabelVersion integer Số phiên bản của tính năng nhãn sự kiện mà ứng dụng API hỗ trợ. Phiên bản 0 giả định không có sự hỗ trợ nhãn sự kiện và xử lý trường colorId để quản lý màu sắc. Phiên bản 1 hỗ trợ nhãn sự kiện và xử lý eventLabelId trong nội dung của sự kiện. Trong trường hợp này, trường colorId sẽ bị bỏ qua. Giá trị mặc định là 0. Giá trị có thể chấp nhận là từ 0 đến 1.
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 sự kiện định kỳ, đây là thời gian kết thúc của phiên bản đầu tiên.
iCalUID string Giá trị nhận dạng duy nhất của sự kiện như được xác định trong RFC5545. Tham số này được 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.

Xin lưu ý rằng iCalUIDid không giống nhau và bạn chỉ nên cung cấp một trong hai giá trị này tại thời điểm tạo sự kiện. Một điểm khác biệt về ngữ nghĩa là trong các sự kiện định kỳ, tất cả các lần diễn ra của một sự kiện đều có id riêng, trong khi tất cả đều dùng chung một iCalUID. Để truy xuất một sự kiện bằng iCalUID, hãy gọi phương thức events.list bằng cách sử dụng tham số iCalUID. Để truy xuất một sự kiện bằng id, hãy gọi phương thức events.get.

start nested object Thời gian bắt đầu (bao gồm cả thời gian này) 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 từ Google Drive, hãy sử dụng cùng định dạng như trong thuộc tính alternateLink của tài nguyên Files trong API Drive.

Bắt buộc khi thêm tệp đính kèm.

có thể ghi
attendees[] list 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 quyền uỷ quyền trên toàn miền để điền sẵn danh sách người tham dự. có thể ghi
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à:
  • "needsAction" – Người tham dự chưa phản hồi lời mời (nên dùng cho các sự kiện mới).
  • declined – Người tham dự đã từ chối lời mời.
  • "tentative" – Khách mời đã chấp nhận lời mời ở trạng thái dự kiến.
  • accepted" – Người tham dự đã chấp nhận lời mời.
có thể ghi
attendeesOmitted boolean Liệu người tham dự có thể đã bị bỏ qua trong thông tin về 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. có thể ghi
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. 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ị 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. có thể ghi
description string Mô tả về sự kiện. Có thể chứa HTML. Không bắt buộc. có thể ghi
end.date date Ngày ở định dạng "yyyy-mm-dd", nếu đây là sự kiện cả ngày. có thể ghi
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õ múi giờ trong timeZone. có thể ghi
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 của sự kiện. có thể ghi
eventLabelId string Mã nhận dạng của nhãn sự kiện được chỉ định cho sự kiện. Không bắt buộc. Đây là mã nhận dạng của một mục trong thuộc tính labelProperties.eventLabels của lịch (xem điểm cuối Calendars.get).

Thuộc tính này thay thế thuộc tính colorId dựa trên chỉ mục. Để đặt hoặc thay đổi thuộc tính này, bạn cần chỉ định eventLabelVersion=1 trong các tham số của phương thức insert, import, updatepatch.

Nếu bạn đặt một chuỗi trống hoặc không đặt trường này, thì nhãn hiện có sẽ bị xoá khỏi 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 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. 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 eventTypefocusTime. 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à:
  • "icon" – Tiện ích này xuất hiện bên cạnh tiêu đề của sự kiện trong chế độ xem lịch.
  • "chip" – Tiện ích này sẽ xuất hiện khi người dùng nhấp vào sự kiện.
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.preferences object Tùy chọn. có thể ghi
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. có thể ghi
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. có thể ghi
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, trừ trường hợp nhập một 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. có thể ghi
originalStartTime.date date Ngày ở định dạng "yyyy-mm-dd", nếu đây là sự kiện 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õ múi giờ trong timeZone. có thể ghi
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 của 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 eventTypeoutOfOffice. 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 startend. 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 chưa đặt lời nhắc, thì danh sách này sẽ cho biết rằng bạn chưa đặt lời nhắc nào 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à:
  • "email" – Lời nhắc được gửi qua email.
  • "popup" – Lời nhắc được gửi qua cửa sổ bật lên trên giao diện người dùng.

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. Lượ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 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õ múi giờ trong timeZone. có thể ghi
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 của sự kiện. có thể ghi
status string Trạng thái của sự kiện. Không bắt buộc. Các giá trị có thể là:
  • "confirmed" – Sự kiện đã được xác nhận. Đây là trạng thái mặc định.
  • "tentative" – Sự kiện đã được xác nhận tạm thời.
  • "cancelled" – Sự kiện bị huỷ (bị xoá). Phương thức list chỉ trả về các sự kiện đã huỷ khi đồng bộ hoá gia tăng (khi bạn chỉ định syncToken hoặc updatedMin) hoặc nếu bạn đặt cờ showDeleted thành true. Phương thức get luôn trả về các giá trị này.

    Trạng thái đã huỷ thể hiện 2 trạng thái khác nhau, tuỳ thuộc vào loại sự kiện:

    1. Các trường hợp ngoại lệ đã huỷ của một sự kiện định kỳ chưa bị huỷ cho biết rằng người dùng sẽ không còn thấy phiên bản này nữa. Ứng dụng nên lưu trữ các sự kiện này trong suốt thời gian diễn ra sự kiện định kỳ mẹ.

      Các ngoại lệ bị huỷ chỉ được đảm bảo có giá trị cho các trường id, recurringEventIdoriginalStartTime. Các trường khác có thể bị trống.

    2. Tất cả các sự kiện bị huỷ khác đều là sự kiện đã bị xoá. Khách hàng nên xoá các bản sao được đồng bộ hoá cục bộ. Những sự kiện bị huỷ như vậy sẽ biến mất theo thời gian, vì vậy, bạn không nên dựa vào việc chúng sẽ luôn có sẵn.

      Các sự kiện đã xoá chỉ đảm bảo được điền sẵn trường id.

    Trên lịch của người tổ chức, các sự kiện bị huỷ vẫn hiển thị thông tin chi tiết về sự kiện (nội dung tóm tắt, vị trí, v.v.) để có thể khôi phục (xoá) các sự kiện đó. Tương tự, những sự kiện mà người dùng được mời và đã xoá theo cách thủ công vẫn sẽ cung cấp thông tin chi tiết. Tuy nhiên, các yêu cầu đồng bộ hoá gia tăng có showDeleted được đặt thành false sẽ không trả về những thông tin chi tiết này.

    Nếu một sự kiện thay đổi người tổ chức (ví dụ: thông qua thao tác di chuyển) và người tổ chức ban đầu không có trong danh sách người tham dự, thì sự kiện đó sẽ bị huỷ và chỉ có trường id được đảm bảo sẽ được điền sẵn.

có thể ghi
summary string Tiêu đề sự kiện. có thể ghi
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à:
  • "opaque" – Giá trị mặc định. Sự kiện này sẽ chặn thời gian trên lịch. Điều này tương đương với việc đặt chế độ Hiển thị trạng thái của tôi là thành Bận trong giao diện người dùng Lịch.
  • "transparent" – Sự kiện này không chiếm thời gian trên lịch. Điều này tương đương với việc đặt chế độ Hiển thị trạng thái của tôi là thành Rảnh trong giao diện người dùng Lịch.
có thể ghi
visibility string Chế độ hiển thị của sự kiện. Không bắt buộc. Các giá trị có thể là:
  • "default" – Sử dụng chế độ hiển thị mặc định cho các sự kiện trên lịch. Đây là giá trị mặc định.
  • "public" – Sự kiện ở chế độ công khai và tất cả người đọc lịch đều có thể xem thông tin chi tiết về sự kiện.
  • "private" – Sự kiện là riêng tư và chỉ người tham dự sự kiện mới có thể xem thông tin chi tiết về sự kiện.
  • "confidential" – Sự kiện này là riêng tư. Giá trị này được cung cấp vì lý do tương thích.
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 APIs Explorer 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.