# AdSense Management API . adunits

## Instance Methods

Returns the customchannels Resource.

Close httplib2 connections.

Gets the specified ad unit in the specified ad client.

Get ad code for the specified ad unit.

List all ad units in the specified ad client for this AdSense account.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(adClientId, adUnitId)`

    Gets the specified ad unit in the specified ad client.

    Args:
      adClientId: string, Ad client for which to get the ad unit. (required)
      adUnitId: string, Ad unit to retrieve. (required)

    Returns:
      An object of the form:

        {
      "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
      "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
        "backupOption": { # The backup option to be used in instances where no ad is available.
          "color": "A String", # Color to use when type is set to COLOR.
          "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
          "url": "A String", # URL to use when type is set to URL.
        },
        "size": "A String", # Size of this ad unit.
        "type": "A String", # Type of this ad unit.
      },
      "customStyle": { # Custom style information specific to this ad unit.
        "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
          "background": "A String", # The color of the ad background.
          "border": "A String", # The color of the ad border.
          "text": "A String", # The color of the ad text.
          "title": "A String", # The color of the ad title.
          "url": "A String", # The color of the ad url.
        },
        "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
        "font": { # The font which is included in the style.
          "family": "A String", # The family of the font.
          "size": "A String", # The size of the font.
        },
        "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
      },
      "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated.
        "adPosition": "A String", # The position of the ads relative to the feed entries.
        "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
        "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
        "type": "A String", # The type of ads which should appear.
      },
      "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
      "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
      "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated.
        "markupLanguage": "A String", # The markup language to use for this ad unit.
        "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
        "size": "A String", # Size of this ad unit.
        "type": "A String", # Type of this ad unit.
      },
      "name": "A String", # Name of this ad unit.
      "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
      "status": "A String", # Status of this ad unit. Possible values are:
          # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
          #
          # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
          #
          # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
    }

`getAdCode(adClientId, adUnitId)`

    Get ad code for the specified ad unit.

    Args:
      adClientId: string, Ad client with contains the ad unit. (required)
      adUnitId: string, Ad unit to get the code for. (required)

    Returns:
      An object of the form:

        {
      "adCode": "A String", # The Auto ad code snippet. The ad code snippet.
      "ampBody": "A String", # The AMP Auto ad code snippet that goes in the body of an AMP page.
      "ampHead": "A String", # The AMP Auto ad code snippet that goes in the head of an AMP page.
      "kind": "adsense#adCode", # Kind this is, in this case adsense#adCode.
    }

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

    List all ad units in the specified ad client for this AdSense account.

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

    Returns:
      An object of the form:

        {
      "etag": "A String", # ETag of this response for caching purposes.
      "items": [ # The ad units returned in this list response.
        {
          "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
          "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
            "backupOption": { # The backup option to be used in instances where no ad is available.
              "color": "A String", # Color to use when type is set to COLOR.
              "type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
              "url": "A String", # URL to use when type is set to URL.
            },
            "size": "A String", # Size of this ad unit.
            "type": "A String", # Type of this ad unit.
          },
          "customStyle": { # Custom style information specific to this ad unit.
            "colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
              "background": "A String", # The color of the ad background.
              "border": "A String", # The color of the ad border.
              "text": "A String", # The color of the ad text.
              "title": "A String", # The color of the ad title.
              "url": "A String", # The color of the ad url.
            },
            "corners": "A String", # The style of the corners in the ad (deprecated: never populated, ignored).
            "font": { # The font which is included in the style.
              "family": "A String", # The family of the font.
              "size": "A String", # The size of the font.
            },
            "kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
          },
          "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated.
            "adPosition": "A String", # The position of the ads relative to the feed entries.
            "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
            "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
            "type": "A String", # The type of ads which should appear.
          },
          "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
          "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
          "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated.
            "markupLanguage": "A String", # The markup language to use for this ad unit.
            "scriptingLanguage": "A String", # The scripting language to use for this ad unit.
            "size": "A String", # Size of this ad unit.
            "type": "A String", # Type of this ad unit.
          },
          "name": "A String", # Name of this ad unit.
          "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
          "status": "A String", # Status of this ad unit. Possible values are:
              # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
              #
              # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
              #
              # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
        },
      ],
      "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
      "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
    }

`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.