Method: accounts.adclients.urlchannels.list

Lists active url channels.

HTTP request

GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/urlchannels

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient}

Query parameters

Parameters
pageSize

integer

The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

pageToken

string

A page token, received from a previous urlchannels.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to urlchannels.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response definition for the url channels list rpc.

JSON representation
{
  "urlChannels": [
    {
      object (UrlChannel)
    }
  ],
  "nextPageToken": string
}
Fields
urlChannels[]

object (UrlChannel)

The url channels returned in this list response.

nextPageToken

string

Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's "pageToken" value to this.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/adsense
  • https://www.googleapis.com/auth/adsense.readonly

UrlChannel

Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see URL channels for more information.

JSON representation
{
  "name": string,
  "reportingDimensionId": string,
  "uriPattern": string
}
Fields
name

string

Resource name of the URL channel. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel}

reportingDimensionId

string

Output only. Unique ID of the custom channel as used in the URL_CHANNEL_ID reporting dimension.

uriPattern

string

URI pattern of the channel. Does not include "http://" or "https://". Example: www.example.com/home