Method: advertisers.list

Répertorie les annonceurs accessibles à l'utilisateur actuel.

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

Un seul 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 des annonceurs que pour un partenaire à la fois.
pageSize

integer

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.
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 advertisers.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
  • updateTime

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. Par exemple, displayName desc.
filter

string

Permet de filtrer selon les champs des annonceurs.

Syntaxe compatible:

  • Les expressions de filtre sont composées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées à l'aide des 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 (au format ISO 8601, ou YYYY-MM-DDTHH:MM:SSZ)

Exemples :

  • Tous les annonceurs actifs sous un partenaire: entityStatus="ENTITY_STATUS_ACTIVE"
  • Tous les annonceurs dont la date de mise à jour est inférieure ou égale à 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 à 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 Filtrer les 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 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Champs
advertisers[]

object (Advertiser)

Liste des annonceurs.

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 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.