Tập hợp lịch trong danh sách lịch của người dùng. Hãy xem thêm phần Lịch và CalendarList.
Để xem danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang này.
Biểu diễn tài nguyên
{ "kind": "calendar#calendarListEntry", "etag": etag, "id": string, "summary": string, "description": string, "location": string, "timeZone": string, "summaryOverride": string, "colorId": string, "backgroundColor": string, "foregroundColor": string, "hidden": boolean, "selected": boolean, "accessRole": string, "defaultReminders": [ { "method": string, "minutes": integer } ], "notificationSettings": { "notifications": [ { "type": string, "method": string } ] }, "primary": boolean, "deleted": boolean, "conferenceProperties": { "allowedConferenceSolutionTypes": [ string ] } }
Tên tài sản | Giá trị | Nội dung mô tả | Ghi chú |
---|---|---|---|
accessRole |
string |
Vai trò truy cập hiệu quả của người dùng đã xác thực trên lịch. Chỉ đọc. Các giá trị có thể sử dụng là:
|
|
backgroundColor |
string |
Màu chính của lịch ở định dạng thập lục phân "#0088aa ". Thuộc tính này thay thế thuộc tính colorId dựa trên chỉ mục. Để thiết lập hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các thông số của phương thức insert, update và patch. Không bắt buộc. |
có thể ghi |
colorId |
string |
Màu của lịch. Đây là mã nhận dạng tham chiếu đến một mục nhập trong phần calendar của định nghĩa về màu sắc (xem điểm cuối của màu). Thuộc tính này được thay thế bằng các thuộc tính backgroundColor và foregroundColor , đồng thời có thể bị bỏ qua khi sử dụng các thuộc tính này. Không bắt buộc. |
có thể ghi |
conferenceProperties |
nested object |
Thuộc tính hội nghị truyền hình cho lịch này, chẳng hạn như các loại hội nghị được cho phép. | |
conferenceProperties.allowedConferenceSolutionTypes[] |
list |
Các loại giải pháp hội nghị được hỗ trợ cho lịch này. Các giá trị có thể là:
|
|
defaultReminders[] |
list |
Lời nhắc mặc định mà người dùng đã xác thực có đối với lịch này. | có thể ghi |
defaultReminders[].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 |
defaultReminders[].minutes |
integer |
Số phút trước khi bắt đầu sự kiện khi lời nhắc sẽ kích hoạt. Các 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 |
deleted |
boolean |
Liệu mục nhập danh sách lịch này đã bị xoá khỏi danh sách lịch hay chưa. Chỉ đọc. Không bắt buộc. Giá trị mặc định là False. | |
description |
string |
Nội dung mô tả về lịch. Không bắt buộc. Chỉ đọc. | |
etag |
etag |
ETag của tài nguyên. | |
foregroundColor |
string |
Màu nền trước của lịch ở định dạng thập lục phân "#ffffff ". Thuộc tính này thay thế thuộc tính colorId dựa trên chỉ mục. Để thiết lập hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các thông số của phương thức insert, update và patch. Không bắt buộc. |
có thể ghi |
id |
string |
Giá trị nhận dạng của lịch. | |
kind |
string |
Loại tài nguyên ("calendar#calendarListEntry"). | |
location |
string |
Vị trí địa lý của lịch dưới dạng văn bản dạng tự do. Không bắt buộc. Chỉ đọc. | |
notificationSettings |
object |
Thông báo mà người dùng đã xác thực nhận được đối với lịch này. | có thể ghi |
notificationSettings.notifications[] |
list |
Danh sách thông báo đã được đặt cho lịch này. | |
notificationSettings.notifications[].method |
string |
Phương thức được dùng để gửi thông báo. Giá trị có thể là:
Bắt buộc khi thêm thông báo. |
có thể ghi |
notificationSettings.notifications[].type |
string |
Loại thông báo. Các giá trị có thể sử dụng là:
Bắt buộc khi thêm thông báo. |
có thể ghi |
primary |
boolean |
Liệu lịch có phải là lịch chính của người dùng đã xác thực hay không. Chỉ đọc. Không bắt buộc. Giá trị mặc định là False. | |
selected |
boolean |
Liệu nội dung lịch có hiển thị trong giao diện người dùng của lịch hay không. Không bắt buộc. Giá trị mặc định là False. | có thể ghi |
summary |
string |
Tên lịch. Chỉ đọc. | |
summaryOverride |
string |
Phần tóm tắt mà người dùng đã xác thực đã đặt cho lịch này. Không bắt buộc. | có thể ghi |
timeZone |
string |
Múi giờ của lịch. Không bắt buộc. Chỉ đọc. |
Phương thức
- xóa
- Xoá lịch khỏi danh sách lịch của người dùng.
- nhận
- Trả về một lịch từ danh sách lịch của người dùng.
- chèn
- Chèn một lịch hiện có vào danh sách lịch của người dùng.
- list
- Trả về các lịch trên danh sách lịch của người dùng.
- bản vá
- Cập nhật lịch hiện có trên danh sách lịch của người dùng. Phương thức này hỗ trợ ngữ nghĩa bản vá. Hãy lưu ý rằng mỗi yêu cầu bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng
get
sauupdate
. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà 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 đó. - cập nhật
- Cập nhật lịch hiện có trên danh sách lịch của người dùng.
- đồng hồ
- Chú ý đến những thay đổi đối với tài nguyên của CalendarList.