REST Resource: channels

Ressource: Chaîne

Canal de notification utilisé pour surveiller les modifications de ressources.

Représentation JSON 
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Champs
payload

boolean

Valeur booléenne indiquant si la charge utile est souhaitée. Facultatif.
id

string

UUID ou chaîne unique similaire qui identifie ce canal.
resourceId

string

ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans les différentes versions de l'API.
resourceUri

string

Identifiant spécifique à la version de la ressource surveillée.
token

string

Chaîne arbitraire délivrée à l'adresse cible avec chaque notification envoyée sur ce canal. Facultatif.
expiration

string (int64 format)

Date et heure d'expiration du canal de notification, exprimées en code temporel Unix, en millisecondes. Facultatif.
type

string

Type de mécanisme de distribution utilisé pour ce canal. Les valeurs valides sont "web_hook" ou "webhook".
address

string

Adresse à laquelle les notifications sont envoyées pour ce canal.
params

map (key: string, value: string)

Paramètres supplémentaires contrôlant le comportement du canal de distribution. Facultatif.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
kind

string

Identifie la modification comme un canal de notification permettant de surveiller les modifications apportées à une ressource, à savoir api#channel.

Méthodes

stop

 Arrête de regarder les ressources via ce canal.