Method: accounts.adUnits.adUnitMappings.list

  • This method lists ad unit mappings for a specified AdMob account and ad unit using a GET HTTP request.

  • Access to this method is limited and requires contacting an account manager for access if a 403 error occurs.

  • The request requires a parent path parameter specifying the account and ad unit, and optionally accepts pageSize, pageToken, and filter as query parameters.

  • The request body must be empty, and the successful response body contains a list of adUnitMappings and a nextPageToken.

  • This method requires either the https://www.googleapis.com/auth/admob.monetization or https://www.googleapis.com/auth/admob.readonly OAuth scope.

List ad unit mappings under the specified AdMob account and ad unit.

HTTP request

GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adUnits/*}/adUnitMappings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent which owns this collection of ad unit mappings. Format: accounts/{publisherId}/adUnits/{adUnitId}

Query parameters

Parameters
pageSize

integer

The maximum number of ad unit mappings to return. If unspecified or 0, at most 10,000 ad unit mappings will be returned. The maximum value is 20,000; values above 20,000 will be coerced to 20,000.
pageToken

string

A page token, received from a previous adUnitMappings.list call. Provide this to retrieve the subsequent page.
filter

string

The filter string that uses EBNF grammar syntax. Possible field to filter by is:

  • "DISPLAY_NAME"

Possible filter function is:

  • IN: Used to filter fields that represent a singleton including "DISPLAY_NAME".

The filter functions can be added together using AND. OR functionality is not supported.

Example:

filter: IN(DISPLAY_NAME, "Test Ad Unit Mapping 1", "Test Ad Unit Mapping 2")

Request body

The request body must be empty.

Response body

Response for the ListAdUnitMappingsRequest.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "adUnitMappings": [
    {
      object (AdUnitMapping)
    }
  ],
  "nextPageToken": string
}
Fields
adUnitMappings[]

object (AdUnitMapping)

The ad unit mappings from the specified account and ad unit.
nextPageToken

string

Used to set the pageToken in the ListAdUnitMappingsRequest to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/admob.monetization
  • https://www.googleapis.com/auth/admob.readonly

For more information, see the OAuth 2.0 Overview.