REST Resource: channels

Risorsa: canale

Un canale di notifica utilizzato per monitorare le modifiche alle risorse.

Rappresentazione JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Campi
payload

boolean

Un valore booleano per indicare se il payload è richiesto. Facoltativo.

id

string

Un UUID o una stringa univoca simile che identifica questo canale.

resourceId

string

Un ID opaco che identifica la risorsa guardata su questo canale. Stabile nelle diverse versioni dell'API.

resourceUri

string

Un identificatore specifico per la versione della risorsa guardata.

token

string

Una stringa arbitraria inviata all'indirizzo di destinazione con ogni notifica inviata tramite questo canale. Facoltativo.

expiration

string (int64 format)

Data e ora di scadenza del canale di notifica, espresse come timestamp Unix, in millisecondi. Facoltativo.

type

string

Il tipo di meccanismo di importazione utilizzato per questo canale. I valori validi sono "web_hook" o "webhook".

address

string

L'indirizzo a cui vengono inviate le notifiche per questo canale.

params

map (key: string, value: string)

Parametri aggiuntivi che controllano il comportamento del canale di importazione. Facoltativo.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Identifica questo canale di notifica come utilizzato per monitorare le modifiche a una risorsa, ovvero api#channel.

Metodi

stop

Interrompe la visualizzazione delle risorse tramite questo canale.