REST Resource: channels

Resource: Channel

A notification channel used to watch for resource changes.

JSON representation 
 { 
 "payload" 
 : 
 boolean 
 , 
 "id" 
 : 
 string 
 , 
 "resourceId" 
 : 
 string 
 , 
 "resourceUri" 
 : 
 string 
 , 
 "token" 
 : 
 string 
 , 
 "expiration" 
 : 
 string 
 , 
 "type" 
 : 
 string 
 , 
 "address" 
 : 
 string 
 , 
 "params" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "kind" 
 : 
 string 
 }
Fields
payload

boolean

A Boolean value to indicate whether payload is wanted. Optional.
id

string

A UUID or similar unique string that identifies this channel.
resourceId

string

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
resourceUri

string

A version-specific identifier for the watched resource.
token

string

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
expiration

string ( int64 format)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
type

string

The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
address

string

The address where notifications are delivered for this channel.
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" } .
kind

string

Identifies this as a notification channel used to watch for changes to a resource, which is api#channel .

Methods

stop

Stops watching resources through this channel.