Calendars

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

Để xem danh sách phương thức cho tài nguyên này, hãy xem phần cuối của 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,
  "workingHours": {
    "workingHoursEnabled": boolean,
    "availableTimes": [
      {
        "dayOfWeek": string,
        "periodStart": integer,
        "periodEnd": integer
      }
    ]
  }
}
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ệ cho lịch tài nguyên.
conferenceProperties nested object Các thuộc tính hội nghị cho lịch này, ví dụ: loại hội nghị nào được phép.
conferenceProperties.allowedConferenceSolutionTypes[] list Các loại giải pháp hội nghị truyền hình đượ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ụ. Chỉ có thể đọ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 Giá trị 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 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à:
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "sunday"
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ươ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 đã xác thực cho yêu cầu này sẽ trở thành chủ sở hữu dữ liệu của lịch mới.

bản vá
Cập nhật siêu dữ liệu cho lịch. 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á lỗi sẽ tiêu tốn 3 đơn vị hạn mức; bạn nên sử dụng get, sau đó là update. Giá trị của trường mà bạn chỉ định sẽ thay thế giá trị hiện có. Những 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 đó.
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 của quản trị viên là 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ị vô hiệu hoá hoặc bị xoá.
update
Cập nhật siêu dữ liệu cho lịch.