CalendarList

Tập hợp các lịch trong danh sách lịch của người dùng. Xem thêm Calendars so với CalendarList.

Để xem danh sách phương thức cho tài nguyên này, hãy xem cuối trang này.

Cách trình bày tài nguyên

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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ị Mô tả Ghi chú
accessRole string Vai trò truy cập có hiệu lực mà người dùng đã xác thực có trên lịch. Chỉ đọc. Các giá trị có thể là:
  • "freeBusyReader" – Cung cấp quyền đọc thông tin về trạng thái rảnh/bận.
  • "reader" – Cung cấp quyền đọc cho lịch. Sự kiện riêng tư sẽ xuất hiện với những người dùng có quyền truy cập đọc, nhưng thông tin chi tiết về sự kiện sẽ bị ẩn.
  • "writer" – Cung cấp quyền đọc và ghi vào lịch. Người dùng có quyền ghi sẽ thấy các sự kiện riêng tư và thông tin chi tiết về sự kiện.
  • "owner" – Cấp quyền quản lý cho lịch. Vai trò này có tất cả các quyền của vai trò người viết, cộng thêm quyền xem và sửa đổi cấp độ truy cập của những người dùng khác.

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. Để đặt hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các tham 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ột mã nhận dạng đề cập đến một mục trong phần calendar của định nghĩa màu (xem điểm cuối màu). Thuộc tính này được thay thế bằng thuộc tính backgroundColor và foregroundColor, đồng thời bạn có thể 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 Các thuộc tính hội nghị cho lịch này, chẳng hạn như những loại hội nghị được 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à:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Không bắt buộc.
dataOwner string Email của chủ sở hữu lịch. Chỉ đặt cho lịch phụ. Chỉ đọc.
defaultReminders[] list Lời nhắc mặc định mà người dùng đã xác thực có cho 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ể 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
defaultReminders[].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
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. Để đặt hoặc thay đổi thuộc tính này, bạn cần chỉ định colorRgbFormat=true trong các tham số của phương thức insert, update và patch. Không bắt buộc. có thể ghi
hidden boolean Lịch có bị ẩn khỏi danh sách hay không. Không bắt buộc. Thuộc tính này chỉ được trả về khi lịch bị ẩn, trong trường hợp đó, giá trị là true. 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 tự do. Không bắt buộc. Chỉ đọc.
notificationSettings object Những thông báo mà người dùng đã xác thực đang nhận được cho lịch này. có thể ghi
notificationSettings.notifications[] list Danh sách thông báo được thiết lập cho lịch này.
notificationSettings.notifications[].method string Phương thức dùng để gửi thông báo. Giá trị có thể là:
  • "email" – Thông báo được gửi qua email.

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ể là:
  • "eventCreation" – Thông báo được gửi khi một sự kiện mới được thêm vào lịch.
  • "eventChange" – Thông báo được gửi khi một sự kiện bị thay đổi.
  • "eventCancellation" – Thông báo được gửi khi một sự kiện bị huỷ.
  • "eventResponse" – Thông báo được gửi khi người tham dự phản hồi lời mời tham dự sự kiện.
  • "agenda" – Lịch trình có các sự kiện trong ngày (gửi vào buổi sáng).

Bắt buộc khi thêm thông báo.

 có thể ghi
primary boolean Cho biết 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 Nội dung lịch có xuất hiện 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 Tiêu đề của lịch. Chỉ đọc.
summaryOverride string Thông tin 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á một lịch khỏi danh sách lịch của người dùng.
get
Trả về một lịch trong 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 trong danh sách lịch của người dùng.
patch
Cập nhật một lịch hiện có trong danh sách lịch của người dùng. 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; bạn nên sử dụng get, sau đó là update. Các giá trị 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. Nếu được chỉ định, các trường mảng 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 đó.
update
Cập nhật một lịch hiện có trong danh sách lịch của người dùng.
watch
Theo dõi các thay đổi đối với tài nguyên CalendarList.