REST Resource: channels

Ресурс: Канал

Канал уведомлений, используемый для отслеживания изменений ресурсов.

JSON-представление
{   "params": {     string: string,     ...   },   "payload": boolean,   "id": string,   "resourceId": string,   "resourceUri": string,   "token": string,   "expiration": string,   "type": string,   "address": string,   "kind": string }
Поля
params

map (key: string, value: string)

Дополнительные параметры, управляющие поведением канала доставки. Необязательно.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

payload

boolean

Логическое значение, указывающее, нужна ли полезная нагрузка. Необязательно.

id

string

UUID или аналогичная уникальная строка, идентифицирующая этот канал.

resourceId

string

Непрозрачный идентификатор, идентифицирующий ресурс, просматриваемый на этом канале. Стабилен в разных версиях API.

resourceUri

string

Идентификатор версии отслеживаемого ресурса.

token

string

Произвольная строка, отправляемая на целевой адрес с каждым уведомлением, доставленным по этому каналу. Необязательно.

expiration

string ( int64 format)

Дата и время истечения срока действия канала уведомлений, выраженные в виде временной метки Unix в миллисекундах. Необязательно.

type

string

Тип механизма доставки, используемый для этого канала. Допустимые значения: «web_hook» или «webhook».

address

string

Адрес, на который доставляются уведомления для этого канала.

kind

string

Определяет это как канал уведомлений, используемый для отслеживания изменений ресурса, то есть api#channel .

Методы

stop

Прекращает просмотр ресурсов через этот канал.