REST Resource: channels

Tài nguyên: Kênh

Kênh thông báo được dùng để xem 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ó cần tải trọng hay không. Không bắt buộc.

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

string (int64 format)

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.

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".

address

string

Địa chỉ gửi thông báo 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

Nhận định đây là kênh thông báo dùng để xem các thay đổi đối với 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.