Method: advertisers.locationLists.list

L'

Liste les listes de zones géographiques en fonction d'un ID d'annonceur donné.

Requête HTTP

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

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 DV360 auquel appartiennent les listes de zones géographiques récupérées.

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 ce champ n'est pas défini, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si une valeur non valide est spécifiée.
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 à la méthode locationLists.list. Si cette option n'est pas spécifiée, la première page de résultats est renvoyée.
orderBy

string

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

  • locationListId (par défaut)
  • displayName

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

Permet de filtrer les données en fonction des champs de la liste des établissements.

Syntaxe acceptée :

  • 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 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 (=).

Champs acceptés :

  • locationType

Exemples :

  • Toutes les listes des zones géographiques régionales : locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • Liste de tous les lieux à proximité : locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

Pour en savoir plus, consultez notre guide sur les demandes de filtrage 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 
{
  "locationLists": [
    {
      object (LocationList)
    }
  ],
  "nextPageToken": string
}
Champs
locationLists[]

object (LocationList)

Liste des listes d'établissements.

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 de l'appel suivant à la méthode locationLists.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 plus d'informations, consultez la OAuth 2.0 Overview.