REST Resource: channels
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: Channel
Um canal de notificação usado para monitorar mudanças de recursos.
Representação JSON |
{
"params": {
string: string,
...
},
"payload": boolean,
"id": string,
"resourceId": string,
"resourceUri": string,
"token": string,
"expiration": string,
"type": string,
"address": string,
"kind": string
} |
Campos |
params |
map (key: string, value: string)
Parâmetros adicionais que controlam o comportamento do canal de exibição. Opcional. Um objeto com uma lista de pares "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
|
payload |
boolean
Um valor booleano para indicar se o payload é desejado. Opcional.
|
id |
string
Um UUID ou uma string exclusiva semelhante que identifica o canal.
|
resourceId |
string
Um ID opaco que identifica o recurso monitorado neste canal. Estável em diferentes versões da API.
|
resourceUri |
string
Um identificador específico da versão para o recurso monitorado.
|
token |
string
Uma string arbitrária entregue ao endereço de destino com cada notificação enviada por esse canal. Opcional.
|
expiration |
string (int64 format)
Data e hora de expiração do canal de notificação, expressas como um carimbo de data/hora Unix, em milissegundos. Opcional.
|
type |
string
O tipo de mecanismo de entrega usado para este canal. Os valores válidos são "web_hook" ou "webhook".
|
address |
string
O endereço em que as notificações são entregues para esse canal.
|
kind |
string
Identifica isso como um canal de notificação usado para monitorar mudanças em um recurso, que é api#channel .
|
Métodos |
|
Interrompe a observação de recursos por este canal. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# REST Resource: channels\n\n- [Resource: Channel](#Channel)\n - [JSON representation](#Channel.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Channel\n-----------------\n\nA notification channel used to watch for resource changes.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"params\": { string: string, ... }, \"payload\": boolean, \"id\": string, \"resourceId\": string, \"resourceUri\": string, \"token\": string, \"expiration\": string, \"type\": string, \"address\": string, \"kind\": string } ``` |\n\n| Fields ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `params` | `map (key: string, value: string)` Additional parameters controlling delivery channel behavior. Optional. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `payload` | `boolean` A Boolean value to indicate whether payload is wanted. Optional. |\n| `id` | `string` A UUID or similar unique string that identifies this channel. |\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| `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. Valid values are \"web_hook\" or \"webhook\". |\n| `address` | `string` The address where notifications are delivered for this channel. |\n| `kind` | `string` Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. |\n\n| Methods ------- ||\n|------------------------------------------------------------------|------------------------------------------------|\n| ### [stop](/workspace/drive/api/reference/rest/v2/channels/stop) | Stops watching resources through this channel. |"]]