REST Resource: channels

Ressource: Channel

Canal de notification utilisé pour surveiller les modifications apportées aux 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 identifiant ce canal.

resourceId

string

ID opaque qui identifie la ressource surveillée sur ce canal. Stable dans différentes versions d'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 transmise 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" et "webhook".

address

string

Adresse à laquelle les notifications sont envoyées pour cette chaîne.

params

map (key: string, value: string)

Paramètres supplémentaires contrôlant le comportement des canaux de diffusion. Facultatif.

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

kind

string

Identifie cela comme un canal de notification utilisé pour surveiller les modifications apportées à une ressource, à savoir api#channel.

Méthodes

stop

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