Method: accounts.adUnits.list

Enumera las unidades de anuncios de la cuenta de AdMob especificada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de la cuenta para la que se enumerarán las unidades de anuncios. Ejemplo: accounts/pub-9876543210987654

Parámetros de consulta

Parámetros
pageSize

integer

Es la cantidad máxima de unidades de anuncios que se devolverán. Si no se especifica o se establece en 0, se devolverán, como máximo, 10,000 bloques de anuncios. El valor máximo es 20,000,y los valores superiores se convertirán a 20,000.

pageToken

string

Es el valor que devolvió el último ListAdUnitsResponse y que indica que se trata de una continuación de una llamada anterior a adUnits.list y que el sistema debe devolver la siguiente página de datos.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta a la solicitud de la lista de unidades de anuncios.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Campos
adUnits[]

object (AdUnit)

Son las unidades de anuncios resultantes para la cuenta solicitada.

nextPageToken

string

Si no está vacío, indica que puede haber más bloques de anuncios para la solicitud. Este valor se debe pasar en un nuevo ListAdUnitsRequest.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

AdUnit

Describe una unidad de anuncios de AdMob.

Representación JSON
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Campos
name

string

Es el nombre del recurso de este bloque de anuncios. El formato es accounts/{publisherId}/adUnits/{ad_unit_id_fragment}. Por ejemplo: accounts/pub-9876543210987654/adUnits/0123456789

adUnitId

string

Es el ID visible de forma externa de la unidad de anuncios que se puede usar para la integración con el SDK de AdMob. Esta propiedad es de solo lectura. Ejemplo: ca-app-pub-9876543210987654/0123456789

appId

string

Es el ID visible de forma externa de la app con la que se asocia esta unidad de anuncios. Ejemplo: ca-app-pub-9876543210987654~0123456789

displayName

string

Es el nombre visible de la unidad de anuncios, tal como se muestra en la IU de AdMob y que proporciona el usuario. La longitud máxima permitida es de 80 caracteres.

adFormat

string

Es el AdFormat de la unidad de anuncios. Los valores posibles se detallan a continuación:

"APP_OPEN": Es el formato de anuncio de inicio de aplicación. "BANNER": Es el formato de anuncio de banner. "BANNER_INTERSTITIAL": Es un formato heredado que se puede usar como banner o intersticial. Ya no se puede crear este formato, pero los grupos de mediación pueden segmentarlo. "INTERSTITIAL": Es un anuncio de pantalla completa. Los tipos de anuncios admitidos son "RICH_MEDIA" y "VIDEO". "NATIVE": Formato del anuncio nativo. "RECOMPENSADO": Es un anuncio que, una vez visualizado, recibe una devolución de llamada que verifica la visualización para que se le pueda otorgar una recompensa al usuario. Los tipos de anuncios admitidos son "RICH_MEDIA" (interactivo) y video, en el que no se puede excluir el video. "REWARDED_INTERSTITIAL": Es el formato de anuncio intersticial recompensado. Solo admite el tipo de anuncio de video. Consulta https://support.google.com/admob/answer/9884467.

adTypes[]

string

Es el tipo de contenido multimedia del anuncio que admite esta unidad de anuncios. Los valores posibles son los siguientes:

"RICH_MEDIA": Texto, imágenes y otro contenido multimedia que no sea de video. "VIDEO": Es contenido multimedia de video.