REST Resource: channels

Ressource : Channel

Canal de notification utilisé pour surveiller les modifications apportées aux ressources.

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

map (key: string, value: string)

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

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

boolean

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

string

UUID ou chaîne unique similaire identifiant ce canal.
resourceId

string

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

string

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

string

Chaîne arbitraire envoyé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 sous la forme d'un code temporel Unix, en millisecondes. Facultatif.
type

string

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

string

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

string

Identifie ce canal de notification comme étant utilisé pour surveiller les modifications apportées à une ressource, qui est api#channel.

Méthodes

stop

 Arrête de regarder les ressources sur cette chaîne.