Theo dõi các thay đổi đối với tài nguyên Sự kiện.
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events/watch
Thông số
Tên thông số | Giá trị | Mô tả |
---|---|---|
Thông 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ừ khoá "primary ".
|
Thông số truy vấn không bắt buộc | ||
eventTypes |
string |
Các loại tài nguyên để xem của sự kiện. 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, sẽ trả về tất cả các loại sự kiện.
Các giá trị được chấp nhận là:
|
Ủ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 |
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ị | 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ự xác định kênh này. | |
token |
string |
Một chuỗi tuỳ ý được phân phối đến địa chỉ mục tiêu cùng với mỗi thông báo được phân phối qua kênh này. Không bắt buộc. | |
type |
string |
Loại cơ chế phân phối được dùng cho kênh này. Giá trị hợp lệ là "web_hook " (hoặc "webhook "). Cả hai giá trị này đều đề cập đến một kênh mà các yêu cầu HTTP được dùng để phân phối thông báo. |
|
address |
string |
Địa chỉ nhận 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ề một phần nội dung phản hồi có cấu trúc sau:
{ "kind": "api#channel", "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": long }
Tên tài sản | Giá trị | Mô tả | Ghi chú |
---|---|---|---|
kind |
string |
Xác định đây là kênh thông báo dùng để theo dõi các thay đổi đối với một tài nguyên, đó là "api#channel ". |
|
id |
string |
UUID hoặc chuỗi duy nhất tương tự giúp xác định kênh này. | |
resourceId |
string |
ID mờ 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 cho tài nguyên được theo dõi. | |
token |
string |
Một chuỗi tuỳ ý được gửi tới địa chỉ đích, trong đó 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 của kênh thông báo, được biểu thị dưới dạng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc. |