REST Resource: channels

Ressource: Kanal

Ein Benachrichtigungskanal, der zum Überwachen von Ressourcenänderungen verwendet wird.

JSON-Darstellung 
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Felder
payload

boolean

Boolescher Wert, der angibt, ob Nutzlast erwünscht ist. Optional.
id

string

Ein UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
resourceId

string

Eine intransparente ID, die die auf diesem Kanal beobachtete Ressource identifiziert. Stabil bei verschiedenen API-Versionen.
resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.
token

string

Beliebiger String, der bei jeder Benachrichtigung über diesen Kanal an die Zieladresse gesendet wird. Optional.
expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals, ausgedrückt als Unix-Zeitstempel in Millisekunden. Optional.
type

string

Die Art des Auslieferungsmechanismus, der für diesen Kanal verwendet wird. Gültige Werte: „web_hook“ oder einen Webhook.
address

string

Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.
params

map (key: string, value: string)

Zusätzliche Parameter, die das Verhalten des Auslieferungschannels steuern. Optional.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
kind

string

Gibt an, dass dies als Benachrichtigungskanal verwendet wird, um nach Änderungen an einer Ressource (api#channel) zu suchen.

Methoden

stop

 Beendet das Ansehen von Ressourcen über diesen Kanal.