Method: advertisers.list

Liste les annonceurs accessibles à l'utilisateur actuel.

L'ordre est défini par le paramètre orderBy.

Un seul élément partnerId est requis. Les fiches multipartenaires ne sont pas acceptées.

Requête HTTP

GET https://displayvideo.googleapis.com/v2/advertisers

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
partnerId

string (int64 format)

Obligatoire. Identifiant du partenaire auquel les annonceurs récupérés doivent tous appartenir. Le système ne permet de lister les annonceurs que pour un partenaire à la fois.
pageSize

integer

Taille de la page demandée. Doit être compris entre 1 et 200. Si aucune valeur n'est spécifiée, la valeur par défaut est 100.
pageToken

string

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 de la méthode advertisers.list. Si aucune valeur n'est spécifiée, la première page de résultats est affichée.
orderBy

string

Champ selon lequel trier la liste. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)
  • entityStatus
  • updateTime

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, vous devez ajouter le suffixe "desc" au nom du champ. Par exemple, displayName desc.
filter

string

Permet de filtrer par champs d'annonceur.

Syntaxe acceptée:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par les opérateurs logiques AND ou OR.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Le champ updateTime doit utiliser les opérateurs GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=).
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (entrée au format ISO 8601, ou YYYY-MM-DDTHH:MM:SSZ)

Exemples :

  • Tous les annonceurs actifs d'un partenaire: entityStatus="ENTITY_STATUS_ACTIVE"
  • Tous les annonceurs dont l'heure de mise à jour est inférieure ou égale au 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Tous les annonceurs dont l'heure de mise à jour est supérieure ou égale au 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Pour en savoir plus, consultez notre guide sur les requêtes LIST de filtrage.

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 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Champs
advertisers[]

object (Advertiser)

Liste des annonceurs.

Si cette liste est vide, elle sera absente.
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 advertisers.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.