AdSense Host API . urlchannels

Instance Methods

close()

Close httplib2 connections.

delete(adClientId, urlChannelId)

Delete a URL channel from the host AdSense account.

insert(adClientId, body=None)

Add a new URL channel to the host AdSense account.

list(adClientId, maxResults=None, pageToken=None)

List all host URL channels in the host AdSense account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(adClientId, urlChannelId)
Delete a URL channel from the host AdSense account.

Args:
  adClientId: string, Ad client from which to delete the URL channel. (required)
  urlChannelId: string, URL channel to delete. (required)

Returns:
  An object of the form:

    {
      "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
      "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
      "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    }
insert(adClientId, body=None)
Add a new URL channel to the host AdSense account.

Args:
  adClientId: string, Ad client to which the new URL channel will be added. (required)
  body: object, The request body.
    The object takes the form of:

{
    "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
    "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
    "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
  }


Returns:
  An object of the form:

    {
      "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
      "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
      "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
    }
list(adClientId, maxResults=None, pageToken=None)
List all host URL channels in the host AdSense account.

Args:
  adClientId: string, Ad client for which to list URL channels. (required)
  maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
  pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns:
  An object of the form:

    {
    "kind": "adsensehost#urlChannels", # Kind of list this is, in this case adsensehost#urlChannels.
    "items": [ # The URL channels returned in this list response.
      {
          "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
          "kind": "adsensehost#urlChannel", # Kind of resource this is, in this case adsensehost#urlChannel.
          "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
        },
    ],
    "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
    "etag": "A String", # ETag of this response for caching purposes.
  }
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.