Method: advertisers.adGroups.list

Liste les groupes d'annonces.

Requête HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
advertiserId

string (int64 format)

Obligatoire. ID de l'annonceur auquel appartiennent les groupes d'annonces.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de la page demandée. Doit être compris entre 1 et 200. Si cette valeur n'est pas spécifiée, elle prend la valeur par défaut de 100. Renvoie le code d'erreur INVALID_ARGUMENT si une valeur non valide est spécifiée.
pageToken

string

Facultatif. Jeton identifiant une page de résultats que le serveur doit renvoyer. Il s'agit généralement de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode adGroups.list. Si cette valeur n'est pas spécifiée, la première page de résultats est renvoyée.
orderBy

string

Facultatif. Champ à utiliser pour trier la liste. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)
  • entityStatus

L'ordre de tri par défaut est croissant. Pour spécifier un ordre décroissant pour un champ, le suffixe "desc" doit être ajouté au nom du champ. Exemple : displayName desc
filter

string

Facultatif. Permet de filtrer les groupes d'annonces en fonction de leurs champs personnalisés.

Syntaxe compatible:

  • Les expressions de filtre sont composées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par AND et OR. Une séquence de restrictions utilise implicitement AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Tous les champs doivent utiliser l'opérateur EQUALS (=).

Propriétés compatibles :

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Exemples :

  • Tous les groupes d'annonces d'un élément de campagne : lineItemId="1234"
  • Tous les groupes d'annonces AD_GROUP_FORMAT_IN_STREAM ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED d'un annonceur : (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

La longueur de ce champ ne doit pas dépasser 500 caractères.

Pour en savoir plus, consultez notre guide sur le filtrage des requêtes LIST.

Corps de la requête

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

Corps de la réponse

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

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

object (AdGroup)

Liste des groupes d'annonces.

Cette liste est absente si elle est vide.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ pageToken de l'appel suivant de la méthode adGroups.list pour récupérer la page de résultats suivante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/display-video

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