Method: accounts.adUnits.list

Permet de lister les blocs d'annonces du compte AdMob spécifié.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource du compte pour lequel répertorier les blocs d'annonces. Exemple: accounts/pub-9876543210987654

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de blocs d'annonces à afficher. Si aucune valeur n'est spécifiée ou si elle est égale à 0, 10 000 blocs d'annonces au maximum seront renvoyés. La valeur maximale est 20 000. Les valeurs supérieures à 20 000 sont forcées à 20 000.
pageToken

string

Valeur renvoyée par le dernier ListAdUnitsResponse. Elle indique qu'il s'agit de la suite d'un appel adUnits.list précédent et que le système doit renvoyer la page de données suivante.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour la demande de liste de blocs d'annonces.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Champs
adUnits[]

object (AdUnit)

Blocs d'annonces obtenus pour le compte demandé.
nextPageToken

string

Si ce champ n'est pas vide, indique que la demande peut contenir d'autres blocs d'annonces. Cette valeur doit être transmise dans une nouvelle ListAdUnitsRequest.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

AdUnit

Décrit un bloc d'annonces AdMob.

Représentation JSON 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Champs
name

string

Nom de ressource pour ce bloc d'annonces. Le format est le suivant : accounts/{publisherId}/adUnits/{ad_unit_id_fragment}. Exemple : accounts/pub-9876543210987654/adUnits/0123456789
adUnitId

string

ID du bloc d'annonces, visible par les utilisateurs, qui peut être utilisé pour intégrer le SDK AdMob. Cette propriété est en lecture seule. Exemple: ca-app-pub-9876543210987654/0123456789
appId

string

ID de l'application à laquelle ce bloc d'annonces est associé, visible par les utilisateurs. Exemple: ca-app-pub-9876543210987654~0123456789
displayName

string

Nom à afficher du bloc d'annonces, tel qu'il apparaît dans l'interface utilisateur AdMob (fournie par l'utilisateur). La longueur maximale autorisée est de 80 caractères.
adFormat

string

Format d'annonce du bloc d'annonces. Les valeurs possibles sont les suivantes:

"APP_OPEN" : format d'annonce à l'ouverture d'une application. "BANNIÈRE" : format d'annonce "Bannière" "BANNER_INTERSTITIAL" : ancien format pouvant être utilisé comme bannière ou interstitiel. Vous ne pouvez plus créer ce format, mais vous pouvez le cibler par des groupes de médiation. "INTERSTITIAL" : annonce en plein écran. Les types d'annonces "RICH_MEDIA" et "VIDEO" sont acceptés. "NATIVE" : format d'annonce native. "RÉCOMPENSÉE" : une annonce qui, une fois vue, reçoit un rappel confirmant la vue afin qu'une récompense puisse être accordée à l'utilisateur. Les types d'annonces compatibles sont "RICH_MEDIA" (interactifs) et les annonces vidéo, pour lesquelles la vidéo ne peut pas être exclue. "REWARDED_INTERSTITIAL" : format d'annonce interstitielle avec récompense. Uniquement compatible avec le type d'annonce vidéo. Consultez https://support.google.com/admob/answer/9884467.
adTypes[]

string

Type de support d'annonce compatible avec ce bloc d'annonces. Les valeurs possibles sont les suivantes:

"RICH_MEDIA" : texte, image et autre support non vidéo. "VIDEO" : média vidéo.