Trang này được dịch bởi Cloud Translation API.

Freebusy: query

Trả về thông tin rảnh/bận cho một nhóm lịch. Thử ngay.

Yêu cầu

Yêu cầu HTTP

POST https://www.googleapis.com/calendar/v3/freeBusy

Ủy quyền

Yêu cầu này cho phép uỷ quyền với ít nhất một trong các phạm vi sau:

Phạm vi
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`

Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.

Nội dung yêu cầu

Trong nội dung yêu cầu, cung cấp dữ liệu có cấu trúc sau:

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}

Tên tài sản	Giá trị	Nội dung mô tả
`timeMin`	`datetime`	Điểm bắt đầu khoảng thời gian cho truy vấn được định dạng theo RFC3339.
`timeMax`	`datetime`	Kết thúc khoảng thời gian cho truy vấn được định dạng theo RFC3339.
`timeZone`	`string`	Múi giờ dùng trong câu trả lời. Không bắt buộc. Chế độ mặc định là giờ UTC.
`groupExpansionMax`	`integer`	Số lượng tối đa giá trị nhận dạng lịch được cung cấp cho một nhóm. Không bắt buộc. Hệ thống sẽ trả về lỗi cho một nhóm có nhiều thành viên hơn giá trị này. Giá trị tối đa là 100.
`calendarExpansionMax`	`integer`	Số lượng lịch tối đa cần cung cấp thông tin về FreeBusy. Không bắt buộc. Giá trị tối đa là 50.
`items[]`	`list`	Danh sách lịch và/hoặc nhóm cần truy vấn.
`items[].id`	`string`	Giá trị nhận dạng của lịch hoặc nhóm.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một nội dung phản hồi có cấu trúc như sau:

{
  "kind": "calendar#freeBusy",
  "timeMin": datetime,
  "timeMax": datetime,
  "groups": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "calendars": [
        string
      ]
    }
  },
  "calendars": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "busy": [
        {
          "start": datetime,
          "end": datetime
        }
      ]
    }
  }
}

Tên tài sản	Giá trị	Nội dung mô tả
`kind`	`string`	Loại tài nguyên ("calendar#freeBusy").
`timeMin`	`datetime`	Điểm bắt đầu của khoảng thời gian.
`timeMax`	`datetime`	Kết thúc khoảng thời gian.
`groups`	`object`	Mở rộng nhóm.
`groups.(key)`	`nested object`	Danh sách lịch là thành viên của nhóm này.
`groups.(key).errors[]`	`list`	(Các) lỗi không bắt buộc (nếu phép tính cho nhóm không thành công).
`groups.(key).errors[].domain`	`string`	Miền hay danh mục rộng của lỗi.
`groups.(key).errors[].reason`	`string`	Lý do cụ thể gây ra lỗi. Một số giá trị có thể là: "`groupTooBig`" – Nhóm người dùng được yêu cầu quá lớn cho một truy vấn. "`tooManyCalendarsRequested`" – Số lượng lịch được yêu cầu quá lớn cho một truy vấn. "`notFound`" – Không tìm thấy tài nguyên được yêu cầu. "`internalError`" – Dịch vụ API đã gặp lỗi nội bộ. Các loại lỗi khác có thể được thêm vào trong tương lai, vì vậy, khách hàng nên xử lý linh hoạt những trạng thái lỗi khác không có trong danh sách này.
`groups.(key).calendars[]`	`list`	Danh sách giá trị nhận dạng của lịch trong một nhóm.
`calendars`	`object`	Danh sách thông tin rảnh/bận của lịch.
`calendars.(key)`	`nested object`	Tính năng mở rộng rảnh/bận của một lịch.
`calendars.(key).errors[]`	`list`	(Các) lỗi không bắt buộc (nếu không tính toán được cho lịch).
`calendars.(key).errors[].domain`	`string`	Miền hay danh mục rộng của lỗi.
`calendars.(key).errors[].reason`	`string`	Lý do cụ thể gây ra lỗi. Một số giá trị có thể là: "`groupTooBig`" – Nhóm người dùng được yêu cầu quá lớn cho một truy vấn. "`tooManyCalendarsRequested`" – Số lượng lịch được yêu cầu quá lớn cho một truy vấn. "`notFound`" – Không tìm thấy tài nguyên được yêu cầu. "`internalError`" – Dịch vụ API đã gặp lỗi nội bộ. Các loại lỗi khác có thể được thêm vào trong tương lai, vì vậy, khách hàng nên xử lý linh hoạt những trạng thái lỗi khác không có trong danh sách này.
`calendars.(key).busy[]`	`list`	Danh sách phạm vi thời gian mà lịch này phải được coi là bận.
`calendars.(key).busy[].start`	`datetime`	Thời điểm bắt đầu (bao gồm) khoảng thời gian.
`calendars.(key).busy[].end`	`datetime`	Thời điểm kết thúc (loại trừ) khoảng thời gian.

Hãy dùng thử!

Hãy sử dụng APIs Explorer bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.