Method: advertisers.youtubeAdGroups.list

Liste les groupes d'annonces YouTube.

Requête HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroups

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

Taille de la page demandée. La valeur doit être comprise entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si la valeur spécifiée n'est pas valide.
pageToken

string

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

string

Champ selon lequel la liste doit être triée. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)
  • entityStatus

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, ajoutez un suffixe "desc". doit être ajouté au nom du champ. Exemple : displayName desc
filter

string

Permet le filtrage par champs de groupe d'annonces YouTube 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 ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED YOUTUBE_AND_PARTNERS_AD_GROUP_FORMAT_IN_STREAM d'un annonceur: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="YOUTUBE_AND_PARTNERS_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 
{
  "youtubeAdGroups": [
    {
      object (YoutubeAdGroup)
    }
  ],
  "nextPageToken": string
}
Champs
youtubeAdGroups[]

object (YoutubeAdGroup)

Liste des groupes d'annonces.

Cette liste sera 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 lors de l'appel suivant de la méthode youtubeAdGroups.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.