REST Resource: channels

Ressource: Kanal

Benachrichtigungskanal zur Überwachung von Ressourcenänderungen.

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 gebraucht wird. Optional.

id

string

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

resourceId

string

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

resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.

token

string

Eine beliebige Zeichenfolge, die an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional.

expiration

string (int64 format)

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

type

string

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

Kennzeichnet dies als Benachrichtigungskanal, über den nach Änderungen an einer Ressource (api#channel) gesucht wird.

Methoden

stop

Beendet das Ansehen von Ressourcen über diesen Kanal.