Google Apps Script API
    Preparing search index...

    Interface Channel

    A notification channel used to watch for resource changes.

    interface Channel {
        address?: string;
        expiration?: string;
        id?: string;
        kind?: string;
        params?: Record<string, string>;
        payload?: boolean;
        resourceId?: string;
        resourceUri?: string;
        token?: string;
        type?: string;
    }
    Index

    Properties

    address? expiration? id? kind? params? payload? resourceId? resourceUri? token? type?

    Properties
    address?: string

    The address where notifications are delivered for this channel.

    expiration?: string

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

    id?: string

    A UUID or similar unique string that identifies this channel.

    kind?: string

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

    params?: Record<string, string>

    Additional parameters controlling delivery channel behavior. Optional.

    payload?: boolean

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

    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.

    type?: string

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

    Settings
    Member Visibility

    On This Page
    Properties