Adunits.customchannels: list

List all custom channels which the specified ad unit belongs to. Try it now.

Deprecated: Due to the possibility of ambiguity, accounts with both an AdSense publisher account and an AdExchange account will throw an error when trying to use the default account. Always use accounts.list to check if there's more than one account and let the user choose in that case. After that, specify the account ID on every call using the /accounts/ namespace.

Request

HTTP request

GET https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits/adUnitId/customchannels

Parameters

Parameter name	Value	Description
Path parameters
`adClientId`	`string`	Ad client which contains the ad unit.
`adUnitId`	`string`	Ad unit for which to list custom channels.
Optional query parameters
`maxResults`	`integer`	The maximum number of custom channels to include in the response, used for paging. Acceptable values are `0` to `10000`, inclusive.
`pageToken`	`string`	A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Authorization

This request requires authorization with at least one of the following scopes:

Scope
`https://www.googleapis.com/auth/adsense`
`https://www.googleapis.com/auth/adsense.readonly`

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "adsense#customChannels",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    {
      "kind": "adsense#customChannel",
      "id": string,
      "code": string,
      "name": string,
      "targetingInfo": {
        "adsAppearOn": string,
        "location": string,
        "description": string,
        "siteLanguage": string
      }
    }
  ]
}

Property name	Value	Description
`kind`	`string`	Kind of list this is, in this case adsense#customChannels.
`etag`	`etag`	ETag of this response for caching purposes.
`nextPageToken`	`string`	Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
`items[]`	`list`	The custom channels returned in this list response.
`items[].kind`	`string`	Kind of resource this is, in this case adsense#customChannel.
`items[].id`	`string`	Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
`items[].code`	`string`	Code of this custom channel, not necessarily unique across ad clients.
`items[].name`	`string`	Name of this custom channel.
`items[].targetingInfo`	`object`	The targeting information of this custom channel, if activated.
`items[].targetingInfo.adsAppearOn`	`string`	The name used to describe this channel externally.
`items[].targetingInfo.location`	`string`	The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. Acceptable values are: "`BOTTOM`" "`BOTTOM_CENTER`" "`BOTTOM_LEFT`" "`BOTTOM_RIGHT`" "`MIDDLE`" "`MIDDLE_CENTER`" "`MIDDLE_LEFT`" "`MIDDLE_RIGHT`" "`MULTIPLE_LOCATIONS`" "`TOP`" "`TOP_CENTER`" "`TOP_LEFT`" "`TOP_RIGHT`"
`items[].targetingInfo.description`	`string`	The external description of the channel.
`items[].targetingInfo.siteLanguage`	`string`	The language of the sites ads will be displayed on.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.