AdSense Management API . accounts . adclients . urlchannels

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists active url channels.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists active url channels.

Args:
  parent: string, Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient} (required)
  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 `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the url channels list rpc.
  "nextPageToken": "A String", # Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's "page_token" value to this.
  "urlChannels": [ # The url channels returned in this list response.
    { # Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see [URL channels](https://support.google.com/adsense/answer/2923836) for more information.
      "name": "A String", # Resource name of the URL channel. Format: accounts/{account}/adclients/{adclient}/urlchannels/{urlchannel}
      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `URL_CHANNEL_ID` reporting dimension.
      "uriPattern": "A String", # URI pattern of the channel. Does not include "http://" or "https://". Example: www.example.com/home
    },
  ],
}
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.