REST Resource: channels

Recurso: canal

Um canal de notificação usado para observar alterações de recursos.

Representação 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

Um valor booleano que indica se a carga útil é desejada. Opcional.

id

string

Um UUID ou uma string única semelhante que identifica esse canal.

resourceId

string

Um ID opaco que identifica o recurso que está sendo monitorado no canal. Estável em diferentes versões da API.

resourceUri

string

Identificador específico da versão do recurso monitorado.

token

string

Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por esse canal. Opcional.

expiration

string (int64 format)

Data e hora da expiração do canal de notificação, expressas como um carimbo de data/hora Unix, em milissegundos. Opcional.

type

string

O tipo de mecanismo de entrega usado para esse canal. Os valores válidos são "web_hook" ou "webhook".

address

string

O endereço onde as notificações do canal são entregues.

params

map (key: string, value: string)

Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Identifica isso como um canal de notificação usado para observar alterações em um recurso, que é api#channel.

Métodos

stop

Para de assistir recursos neste canal.