CalendarList

Bộ sưu tập lịch trong danh sách lịch của người dùng. Hãy xem thêm bài viết Lịch và Danh sách lịch.

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

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ị 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ó thể đọc. Các giá trị có thể có là:
  • "freeBusyReader" - Cung cấp quyền đọc thông tin rảnh/bận.
  • "reader" – Cấp quyền đọc lịch. Các sự kiện riêng tư sẽ hiển thị với người dùng có quyền truy cập của độc giả, nhưng thông tin chi tiết về sự kiện sẽ bị ẩn.
  • "writer" – Cấp quyền đọc và ghi đối với lịch. Người dùng có quyền truy cập của người ghi sẽ thấy các sự kiện riêng tư và thông tin chi tiết về sự kiện sẽ hiển thị.
  • "owner" - Cung cấp quyền sở hữu lịch. Vai trò này có tất cả các quyền của vai trò người viết với khả năng bổ sung để xem và thao tác các ACL.
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 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 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 các thuộc tính backgroundColor và foregroundColor và 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 Hội nghị các tài sản cho lịch này, ví dụ như 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ể có là:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Không bắt buộc.
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ể có 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 bắt đầu sự kiện mà 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ó thể đọ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ó thể đọ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 thông số của phương thức insert, update và patch. Không bắt buộc. có thể ghi
hidden boolean Liệu 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 này, 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 dạng tự do. Không bắt buộc. Chỉ có thể đọc.
notificationSettings object Các 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à:
  • "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ể có là:
  • "eventCreation" – Thông báo được gửi khi có một sự kiện mới được đưa vào lịch.
  • "eventChange" – Thông báo được gửi khi một sự kiện thay đổi.
  • "eventCancellation" – Thông báo được gửi khi sự kiện bị huỷ.
  • "eventResponse" - Thông báo được gửi khi người tham dự trả lời lời mời tham gia sự kiện.
  • "agenda" - Một chương trình làm việc có các sự kiện trong ngày (được gửi vào buổi sáng).

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 được xác thực hay không. Chỉ có thể đọc. Không bắt buộc. Giá trị mặc định là False.
selected boolean Liệu 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ó thể đọc.
summaryOverride string Bả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ó thể đọ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ề 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ề 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 của bản vá. Lưu ý rằng mỗi yêu cầu bản vá cần 3 đơn vị hạn mức; thích dùng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Những trường 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ú ý theo dõi những thay đổi đối với tài nguyên CalendarList.