REST Resource: channels

Tài nguyên: Kênh

Một kênh thông báo dùng để theo dõi các thay đổi về tài nguyên.

Biểu diễn dưới dạng JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Trường
payload

boolean

Giá trị Boolean cho biết liệu có muốn tải trọng hay không. Không bắt buộc.

id

string

UUID hoặc chuỗi duy nhất tương tự giúp xác định kênh này.

resourceId

string

Mã nhận dạng 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 phân phối đến địa chỉ mục tiêu với mỗi thông báo được phân phối qua kênh này. Không bắt buộc.

expiration

string (int64 format)

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.

type

string

Loại cơ chế phân phối được dùng cho kênh này. Các giá trị hợp lệ là "web_hook" hoặc "webhook".

address

string

Địa chỉ nơi thông báo được gửi cho kênh này.

params

map (key: string, value: string)

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.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.

Phương thức

stop

Ngừng xem tài nguyên thông qua kênh này.