SubscriptionChannel
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Canal de notification utilisé pour surveiller les modifications des ressources.
Représentation JSON |
{
"id": string,
"token": string,
"expiration": string,
"type": string,
"address": string,
"payload": boolean,
"params": {
string: string,
...
},
"resourceId": string,
"resourceUri": string,
"kind": string
} |
Champs |
id |
string
UUID ou chaîne unique similaire qui identifie cette chaîne.
|
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 sous la forme d'un code temporel Unix, en millisecondes. Facultatif.
|
type |
string
Type de mécanisme de diffusion utilisé pour ce canal.
|
address |
string
Adresse à laquelle les notifications sont envoyées pour ce canal.
|
payload |
boolean
Valeur booléenne indiquant si la charge utile est souhaitée. Facultatif.
|
params |
map (key: string, value: string)
Paramètres supplémentaires qui contrôlent le comportement du canal de diffusion. Facultatif. Par exemple, params.ttl spécifie la valeur TTL en secondes pour le canal de notification, où la valeur par défaut est de deux heures et la valeur TTL maximale est de deux jours. Objet contenant une liste de paires "key": value . Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
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.
|
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 .
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/24 (UTC).
[null,null,["Dernière mise à jour le 2025/07/24 (UTC)."],[],[],null,["# SubscriptionChannel\n\nAn notification channel used to watch for resource changes.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"token\": string, \"expiration\": string, \"type\": string, \"address\": string, \"payload\": boolean, \"params\": { string: string, ... }, \"resourceId\": string, \"resourceUri\": string, \"kind\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` A UUID or similar unique string that identifies this channel. |\n| `token` | `string` An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. |\n| `expiration` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. |\n| `type` | `string` The type of delivery mechanism used for this channel. |\n| `address` | `string` The address where notifications are delivered for this channel. |\n| `payload` | `boolean` A Boolean value to indicate whether payload is wanted. Optional. |\n| `params` | `map (key: string, value: string)` Additional parameters controlling delivery channel behavior. Optional. For example, `params.ttl` specifies the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL is 2 days. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `resourceId` | `string` An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. |\n| `resourceUri` | `string` A version-specific identifier for the watched resource. |\n| `kind` | `string` Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. |"]]