REST Resource: channels

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

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

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

boolean

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

id

string

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

resourceId

string

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

resourceUri

string

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

token

string

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

expiration

string ( int64 format)

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

type

string

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

address

string

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

params

map (key: string, value: string)

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

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

kind

string

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

Методы

stop

 Перестает смотреть ресурсы через этот канал.