Calendars

Tập hợp tất cả lịch hiện có. Xem thêm bài viết Lịch so với CalendarList.

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

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

{
  "kind": "calendar#calendar",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  },
  "labelProperties": {
    "eventLabels": [
      {
        "id": string,
        "backgroundColor": string,
        "name": string
      }
    ]
  },
  "autoAcceptInvitations": boolean
}
Tên tài sản Giá trị Mô tả Ghi chú
autoAcceptInvitations boolean Liệu lịch này có tự động chấp nhận lời mời hay không. Chỉ hợp lệ đối với lịch tài nguyên.
conferenceProperties nested object Thuộc tính hội nghị cho lịch này, ví dụ: 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ể có 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ụ. Đây là thông tin chỉ cho phép đọc.
description string Nội dung mô tả lịch. Không bắt buộc. có thể ghi
etag etag ETag của tài nguyên.
id string Mã nhận dạng của lịch. Để truy xuất mã nhận dạng, hãy gọi phương thức calendarList.list().
kind string Loại tài nguyên ("calendar#calendar").
labelProperties nested object 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 không được chỉ định, các thuộc tính 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 thuộc tính này xuất hiện khi bạn cập nhật lịch, thì thuộc tính 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". Các 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ã nhận dạng 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 riêng biệt. Bắt buộc khi cập nhật nhãn.

Nếu bạn cung cấp, mã nhận dạng phải là riêng biệ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 bạn cung cấp, tên này phải có 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 tự do. 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

Phương thức

clear
Xoá lịch chính. Thao tác này sẽ xoá tất cả sự kiện liên kết với lịch chính của một tài khoản.
xóa
Xoá lịch phụ. Sử dụng calendars.clear để xoá tất cả sự kiện trên lịch chính.
get
Trả về siêu dữ liệu cho một lịch.
insert
Tạo lịch phụ.

Người dùng được xác thực cho yêu cầu sẽ trở thành chủ sở hữu dữ liệu của lịch mới.

patch
Cập nhật siêu dữ liệu cho một lịch. Phương thức này hỗ trợ ngữ nghĩa 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 rồi đến 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 đó.
transferOwnership
Chuyển lịch phụ giữa những người dùng trong một tổ chức Google Workspace. Yêu cầu xác thực người dùng có đặc quyền quản trị viên Quản lý lịch và một trong các phạm vi uỷ quyền sau:
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars
Trong yêu cầu, hãy đặt useAdminAccess thành true. Lịch phụ phải đang hoạt động thì mới có thể chuyển. Không hỗ trợ chuyển lịch đã bị tắt hoặc bị xoá.
update
Cập nhật siêu dữ liệu cho một lịch.