AdSense Management API . accounts . adclients

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the ad client from the given resource name.

Args:
  name: string, Required. The name of the ad client to retrieve. Format: accounts/{account}/adclients/{adclient} (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 an ad client. An ad client represents a user's subscription with a specific AdSense product.
  "name": "A String", # Output only. Resource name of the ad client. Format: accounts/{account}/adclients/{adclient}
  "productCode": "A String", # Output only. Reporting product code of the ad client. For example, "AFC" for AdSense for Content. Corresponds to the `PRODUCT_CODE` dimension, and present only if the ad client supports reporting.
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
  "state": "A String", # Output only. State of the ad client.
}

getAdcode(name, x__xgafv=None)

Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).

Args:
  name: string, Required. Name of the ad client for which to get the adcode. Format: accounts/{account}/adclients/{adclient} (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 the AdSense code for a given ad client. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
  "adCode": "A String", # Output only. The AdSense code snippet to add to the head of an HTML page.
  "ampBody": "A String", # Output only. The AdSense code snippet to add to the body of an AMP page.
  "ampHead": "A String", # Output only. The AdSense code snippet to add to the head of an AMP page.
}

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

Lists all the ad clients available in an account.

Args:
  parent: string, Required. The account which owns the collection of ad clients. Format: accounts/{account} (required)
  pageSize: integer, The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients 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 `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` 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 ad client list rpc.
  "adClients": [ # The ad clients returned in this list response.
    { # Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.
      "name": "A String", # Output only. Resource name of the ad client. Format: accounts/{account}/adclients/{adclient}
      "productCode": "A String", # Output only. Reporting product code of the ad client. For example, "AFC" for AdSense for Content. Corresponds to the `PRODUCT_CODE` dimension, and present only if the ad client supports reporting.
      "reportingDimensionId": "A String", # Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
      "state": "A String", # Output only. State of the ad client.
    },
  ],
  "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "page_token" value to this.
}

list_next()

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.