Display & Video 360 API . advertisers . channels

Instance Methods

get(advertiserId, channelId, partnerId=None, x__xgafv=None)

Gets a channel for a partner or advertiser.

list(advertiserId, orderBy=None, partnerId=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)

Lists channels for a partner or advertiser.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

get(advertiserId, channelId, partnerId=None, x__xgafv=None)
Gets a channel for a partner or advertiser.

Args:
  advertiserId: string, The ID of the advertiser that owns the fetched channel. (required)
  channelId: string, Required. The ID of the channel to fetch. (required)
  partnerId: string, The ID of the partner that owns the fetched channel.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single channel. Channels are custom groups of related websites and apps.
    "name": "A String", # Output only. The resource name of the channel.
    "displayName": "A String", # Required. The display name of the channel.
        # Must be UTF-8 encoded with a maximum length of 240 bytes.
    "partnerId": "A String", # The ID of the partner that owns the channel.
    "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
    "advertiserId": "A String", # The ID of the advertiser that owns the channel.
  }
list(advertiserId, orderBy=None, partnerId=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)
Lists channels for a partner or advertiser.

Args:
  advertiserId: string, The ID of the advertiser that owns the channels. (required)
  orderBy: string, Field by which to sort the list.
Acceptable values are:

* `displayName` (default)
* `channelId`

The default sorting order is ascending. To specify descending order for a
field, a suffix " desc" should be added to the field name. Example:
`displayName desc`.
  partnerId: string, The ID of the partner that owns the channels.
  filter: string, Allows filtering by channel fields.

Supported syntax:

* Filter expressions for channel currently can only contain at most one
* restriction.
* A restriction has the form of `{field} {operator} {value}`.
* The operator must be `CONTAINS (:)`.
* Supported fields:
    - `displayName`

Examples:

* All channels for which the display name contains "google":
`displayName : "google"`.

The length of this field should be no more than 500 characters.
  pageToken: string, A token identifying a page of results the server should return.
Typically, this is the value of
next_page_token returned from the
previous call to `ListChannels` method. If not specified, the first page
of results will be returned.
  pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
is specified.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token to retrieve the next page of results.
        # Pass this value in the page_token field
        # in the subsequent call to `ListChannels` method to retrieve the next page
        # of results.
    "channels": [ # The list of channels.
        #
        # This list will be absent if empty.
      { # A single channel. Channels are custom groups of related websites and apps.
        "name": "A String", # Output only. The resource name of the channel.
        "displayName": "A String", # Required. The display name of the channel.
            # Must be UTF-8 encoded with a maximum length of 240 bytes.
        "partnerId": "A String", # The ID of the partner that owns the channel.
        "channelId": "A String", # Output only. The unique ID of the channel. Assigned by the system.
        "advertiserId": "A String", # The ID of the advertiser that owns the channel.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.