AdSense Management API . accounts . sites

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets information about the selected site.

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

Lists all the sites available in an account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets information about the selected site.

Args:
  name: string, Required. Name of the site. Format: accounts/{account}/sites/{site} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Representation of a Site.
  "autoAdsEnabled": True or False, # Whether auto ads is turned on for the site.
  "domain": "A String", # Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.
  "name": "A String", # Resource name of a site. Format: accounts/{account}/sites/{site}
  "reportingDimensionId": "A String", # Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.
  "state": "A String", # Output only. State of a site.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the sites available in an account.

Args:
  parent: string, Required. The account which owns the collection of sites. Format: accounts/{account} (required)
  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites 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 `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` 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 sites list rpc.
  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
  "sites": [ # The sites returned in this list response.
    { # Representation of a Site.
      "autoAdsEnabled": True or False, # Whether auto ads is turned on for the site.
      "domain": "A String", # Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.
      "name": "A String", # Resource name of a site. Format: accounts/{account}/sites/{site}
      "reportingDimensionId": "A String", # Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.
      "state": "A String", # Output only. State of a site.
    },
  ],
}
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.