SubscriptionChannel

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

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

string

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

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.

address

string

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

payload

boolean

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

params

map (key: string, value: string)

Zusätzliche Parameter, die das Verhalten des Auslieferungschannels steuern. Optional. Beispielsweise gibt params.ttl die Gültigkeitsdauer in Sekunden für den Benachrichtigungskanal an. Der Standardwert ist 2 Stunden und die maximale Gültigkeitsdauer 2 Tage.

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

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.

kind

string

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