REST Resource: channels

Recurso: Channel

Un canal de notificaciones que se usa para buscar cambios en los recursos.

Representación JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Campos
payload

boolean

Un valor booleano para indicar si se desea la carga útil. Opcional.

id

string

Un UUID o una cadena única similar que identifica este canal.

resourceId

string

Un ID opaco que identifica el recurso que se mira en este canal. Estable en diferentes versiones de la API.

resourceUri

string

Un identificador específico de la versión para el recurso observado.

token

string

Una cadena arbitraria entregada a la dirección de destino con cada notificación entregada a través de este canal. Opcional.

expiration

string (int64 format)

Es la fecha y hora del vencimiento del canal de notificación, expresada como una marca de tiempo de Unix, en milisegundos. Opcional.

type

string

Es el tipo de mecanismo de entrega que se usa para este canal. Los valores válidos son "web_hook". o “webhook”.

address

string

Es la dirección a la que se envían las notificaciones de este canal.

params

map (key: string, value: string)

Parámetros adicionales que controlan el comportamiento del canal de publicación. Opcional.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Identifica esto como un canal de notificaciones que se usa para detectar cambios en un recurso, que es api#channel.

Métodos

stop

Dejará de ver recursos a través de este canal.