Events: watch

Chú ý đến những thay đổi đối với các tài nguyên về Sự kiện.

Yêu cầu

Yêu cầu HTTP

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch

Tham số

Tên thông số Giá trị Nội dung mô tả
Tham số đường dẫn
calendarId string Giá trị nhận dạng lịch. Để truy xuất mã lịch, hãy gọi phương thức calendarList.list. Nếu bạn muốn truy cập vào lịch chính của người dùng hiện đã đăng nhập, hãy sử dụng từ khóa "primary".
Tham số truy vấn không bắt buộc
eventTypes string Các loại tài nguyên sự kiện để xem. Không bắt buộc. Bạn có thể lặp lại tham số này nhiều lần để xem các tài nguyên thuộc nhiều loại. Nếu không được đặt, hàm này sẽ trả về mọi loại sự kiện.

Các giá trị có thể chấp nhận là:
  • "default": Sự kiện định kỳ.
  • "focusTime": Sự kiện thời gian cần tập trung.
  • "outOfOffice": Sự kiện không có mặt tại văn phòng.
  • "workingLocation": Sự kiện tại địa điểm làm việc.

Ủy quyền

Yêu cầu này cho phép uỷ quyền trong í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
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events

Để 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, hãy cung cấp dữ liệu theo cấu trúc sau:

{
  "id": string,
  "token": string,
  "type": string,
  "address": string,
  "params": {
    "ttl": string
  }
}
Tên tài sản Giá trị Nội dung mô tả Ghi chú
id string Mã nhận dạng duy nhất (UUID) hoặc chuỗi duy nhất tương tự giúp nhận dạng kênh này.
token string Một chuỗi tuỳ ý được gửi tới địa chỉ đích với mỗi thông báo được gửi qua kênh này. Không bắt buộc.
type string Loại cơ chế phân phối được sử dụng cho kênh này. Giá trị hợp lệ là "web_hook" (hoặc "webhook"). Cả hai giá trị đều chỉ một kênh mà yêu cầu HTTP được dùng để gửi thông báo.
address string Địa chỉ gửi thông báo cho kênh này.
params object Các tham số bổ sung kiểm soát hành vi của kênh phân phối. Không bắt buộc.
params.ttl string Thời gian tồn tại tính bằng giây cho kênh thông báo. Giá trị mặc định là 604800 giây.

Phản hồi

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

{
  "kind": "api#channel",
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": long
}
Tên tài sản Giá trị Nội dung mô tả Ghi chú
kind string Nhận dạng đây là kênh thông báo dùng để theo dõi các thay đổi đối với tài nguyên, đó là "api#channel".
id string Mã nhận dạng duy nhất (UUID) hoặc chuỗi duy nhất tương tự giúp nhận dạng kênh này.
resourceId string Mã không rõ ràng xác định tài nguyên đang được xem trên kênh này. Ổn định trên nhiều phiên bản API.
resourceUri string Giá trị nhận dạng theo phiên bản cụ thể của tài nguyên đã xem.
token string Một chuỗi tuỳ ý được gửi tới địa chỉ đích với mỗi thông báo được gửi qua kênh này. Không bắt buộc.
expiration long Ngày và giờ hết hạn kênh thông báo, được biểu thị bằng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc.