Cập nhật siêu dữ liệu cho lịch. Thử ngay.
Yêu cầu
Yêu cầu HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarIdThông số
| Tên thông số | Giá trị | Mô tả |
|---|---|---|
| Tham số đường dẫn | ||
calendarId |
string |
Giá trị 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".
|
Ủ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.app.created |
https://www.googleapis.com/auth/calendar.calendars |
Để 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 Lịch có các thuộc tính sau:
| Tên tài sản | Giá trị | Mô tả | Ghi chú |
|---|---|---|---|
| Thuộc tính không bắt buộc | |||
description |
string |
Nội dung mô tả lịch. Không bắt buộc. | có thể ghi |
labelProperties |
nested object |
Các thuộc tính nhãn được xác định trên lịch này. Nếu được chỉ định, thuộc tính này sẽ ghi đè các thuộc tính nhãn hiện có. Nếu bạn không chỉ định, thì các thuộc tính của nhãn sẽ không thay đổi. | có thể ghi |
labelProperties.eventLabels[] |
list |
Nhãn sự kiện được xác định trên lịch này. Nếu có nhãn này khi cập nhật lịch, thì nhãn này sẽ thay thế các nhãn sự kiện hiện có. Mở rộng danh sách để thêm nhãn sự kiện mới và xoá các thực thể khỏi danh sách để xoá nhãn khỏi lịch. Mỗi lịch có thể có tối đa 200 nhãn. |
có thể ghi |
labelProperties.eventLabels[].backgroundColor |
string |
Màu nền của nhãn ở định dạng thập lục phân, chẳng hạn như "#039be5". Sự kiện có nhãn này sẽ xuất hiện bằng màu này. Bắt buộc. |
có thể ghi |
labelProperties.eventLabels[].id |
string |
Mã của nhãn. Không bắt buộc khi chèn nhãn mới. Nếu bạn không cung cấp, hệ thống sẽ tạo một mã nhận dạng duy nhất. Bắt buộc khi cập nhật nhãn. Nếu được cung cấp, mã nhận dạng phải là duy nhất trong lịch và tuân theo định dạng UUID. |
có thể ghi |
labelProperties.eventLabels[].name |
string |
Tên của nhãn. Không bắt buộc. Nếu được cung cấp, trường này chỉ được chứa tối đa 50 ký tự. |
có thể ghi |
location |
string |
Vị trí địa lý của lịch dưới dạng văn bản tuỳ ý. Không bắt buộc. | có thể ghi |
summary |
string |
Tiêu đề của lịch. | có thể ghi |
timeZone |
string |
Múi giờ của lịch. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Không bắt buộc. | có thể ghi |
workingHours |
object |
Đại diện cho thông tin về giờ làm việc của người dùng. Chỉ dành cho lịch chính của người dùng Google Workspace. Để cập nhật giờ làm việc, bạn phải truyền toàn bộ đối tượng giờ làm việc. Nếu không được chỉ định (hoặc được truyền dưới dạng giá trị rỗng hoặc đối tượng trống), thì giờ làm việc hiện tại sẽ không thay đổi. Để tắt giờ làm việc hoặc xoá lịch biểu, hãy đặt workingHoursEnabled thành false (và bỏ qua availableTimes hoặc truyền một danh sách trống). |
có thể ghi |
workingHours.availableTimes[] |
list |
Giờ làm việc. Mỗi khoảng thời gian rảnh đại diện cho một khoảng giờ làm việc của người dùng trong một ngày. | có thể ghi |
workingHours.availableTimes[].dayOfWeek |
string |
Ngày trong tuần. Bắt buộc. Các giá trị có thể sử dụng là:
|
có thể ghi |
workingHours.availableTimes[].periodEnd |
integer |
Thời điểm kết thúc khoảng thời gian, tính bằng phút kể từ thời điểm bắt đầu ngày, không bao gồm. Bắt buộc. | có thể ghi |
workingHours.availableTimes[].periodStart |
integer |
Thời điểm bắt đầu của khoảng thời gian, tính bằng phút kể từ thời điểm bắt đầu của ngày (bao gồm cả thời điểm này). Bắt buộc. | có thể ghi |
workingHours.workingHoursEnabled |
boolean |
Cho biết giờ làm việc có được bật cho lịch này hay không. Không thể đặt thành true khi availableTimes trống. |
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 Lịch trong nội dung phản hồi.
Hãy dùng thử!
Sử dụng APIs Explorer bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.