AdSense Management API . accounts . adclients . adunits

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. Note that ad units can only be created for ad clients with an "AFC" product code. For more info see the [AdClient resource](/adsense/management/reference/rest/v2/accounts.adclients). For now, this method can only be used to create `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566

Args:
  parent: string, Required. Ad client to create an ad unit under. Format: accounts/{account}/adclients/{adclient} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
  "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
    "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
    "type": "A String", # Required. Type of the ad unit.
  },
  "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
  "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
  "state": "A String", # Required. State of the ad unit.
}

  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 unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
  "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
    "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
    "type": "A String", # Required. Type of the ad unit.
  },
  "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
  "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
  "state": "A String", # Required. State of the ad unit.
}

get(name, x__xgafv=None)

Gets an ad unit from a specified account and ad client.

Args:
  name: string, Required. AdUnit to get information about. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (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 unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
  "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
    "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
    "type": "A String", # Required. Type of the ad unit.
  },
  "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
  "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
  "state": "A String", # Required. State of the ad unit.
}

getAdcode(name, x__xgafv=None)

Gets the ad unit code for a given ad unit. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634) and [Where to place the ad code in your HTML](https://support.google.com/adsense/answer/9190028).

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

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

Lists all ad units under a specified account and ad client.

Args:
  parent: string, Required. The ad client which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient} (required)
  pageSize: integer, The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units 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 `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` 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 adunit list rpc.
  "adUnits": [ # The ad units returned in the list response.
    { # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
      "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
        "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
        "type": "A String", # Required. Type of the ad unit.
      },
      "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
      "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
      "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
      "state": "A String", # Required. State of the ad unit.
    },
  ],
  "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
}

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

Lists all the custom channels available for an ad unit.

Args:
  parent: string, Required. The ad unit which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
  pageSize: integer, The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom 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 `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` 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 custom channels linked to an adunit list rpc.
  "customChannels": [ # The custom channels returned in this list response.
    { # Representation of a custom channel.
      "active": True or False, # Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
      "displayName": "A String", # Required. Display name of the custom channel.
      "name": "A String", # Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
      "reportingDimensionId": "A String", # Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
    },
  ],
  "nextPageToken": "A String", # Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
}

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

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an ad unit. This method can be called only by a restricted set of projects, which are usually owned by [AdSense for Platforms](https://developers.google.com/adsense/platforms/) publishers. Contact your account manager if you need to use this method. For now, this method can only be used to update `DISPLAY` ad units. See: https://support.google.com/adsense/answer/9183566

Args:
  name: string, Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} (required)
  body: object, The request body.
    The object takes the form of:

{ # Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
  "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
    "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
    "type": "A String", # Required. Type of the ad unit.
  },
  "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
  "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
  "state": "A String", # Required. State of the ad unit.
}

  updateMask: string, The list of fields to update. If empty, a full update is performed.
  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 unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
  "contentAdsSettings": { # Settings specific to content ads (AFC). # Required. Settings specific to content ads (AFC).
    "size": "A String", # Required. Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
    "type": "A String", # Required. Type of the ad unit.
  },
  "displayName": "A String", # Required. Display name of the ad unit, as provided when the ad unit was created.
  "name": "A String", # Output only. Resource name of the ad unit. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
  "reportingDimensionId": "A String", # Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
  "state": "A String", # Required. State of the ad unit.
}