REST Resource: channels

Ressource: Channel

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

Ein boolescher Wert, der angibt, ob eine Nutzlast gewünscht ist. Optional.
id

string

Eine UUID oder ein ähnlicher eindeutiger String, der diesen Channel identifiziert.
resourceId

string

Eine intransparente ID, die die Ressource identifiziert, die auf diesem Kanal angesehen wird. Sie sind für verschiedene API-Versionen stabil.
resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.
token

string

Ein beliebiger String, der mit jeder Benachrichtigung über diesen Kanal an die Zieladresse gesendet wird. Optional.
expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals als Unix-Zeitstempel in Millisekunden. Optional.
type

string

Der für diesen Kanal verwendete Übermittlungsmechanismus. Gültige Werte sind „web_hook“ oder „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 Übermittlungskanals steuern. Optional.

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

string

Hiermit wird angegeben, dass es sich um einen Benachrichtigungskanal handelt, mit dem Änderungen an einer Ressource (api#channel) überwacht werden.

Methoden

stop

 Das Ansehen von Ressourcen über diesen Kanal wird beendet.