Chú ý đến những thay đổi đối với tài nguyên trong phần Cài đặt.
Yêu cầu
Yêu cầu HTTP
POST https://www.googleapis.com/calendar/v3/users/me/settings/watch
Các tham số
Tên thông số | Giá trị | Nội dung mô tả |
---|
Ủy quyền
Yêu cầu này cần được 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.settings.readonly |
Để 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:
{ "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ự xác định kênh này. | |
token |
string |
Một chuỗi tuỳ ý được gửi đến địa chỉ đích cùng 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. Các giá trị hợp lệ là "web_hook " (hoặc "webhook "). Cả hai giá trị đều đề cập đến một kênh có 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ề một 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 để xem các thay đổi đối với tài nguyên, chính là "api#channel ". |
|
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. | |
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 được theo dõi. | |
token |
string |
Một chuỗi tuỳ ý được gửi đến địa chỉ đích cùng 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. |