REST Resource: channels

Ressource: Channel

Canal de notification utilisé pour surveiller les modifications des 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 cette chaîne.

resourceId

string

ID opaque qui identifie la ressource regardée sur cette chaîne. Stable entre les différentes versions de l'API.

resourceUri

string

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

token

string

Chaîne arbitraire envoyée à l'adresse cible avec chaque notification envoyée via 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 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.

params

map (key: string, value: string)

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

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

kind

string

Indique qu'il s'agit d'un canal de notification utilisé pour surveiller les modifications apportées à une ressource, qui est api#channel.

Méthodes

stop

Arrêter de regarder des ressources via ce canal