Method: customLists.list

Répertorie les listes personnalisées.

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

Requête HTTP

GET https://displayvideo.googleapis.com/v3/customLists

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
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. 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 customLists.list. Si cette valeur n'est pas spécifiée, la première page de résultats est renvoyée.
orderBy

string

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

  • customListId (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 selon les champs de liste personnalisés.

Syntaxe compatible:

  • Les expressions de filtre pour les listes personnalisées ne peuvent contenir qu'une seule restriction au maximum.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Tous les champs doivent utiliser l'opérateur HAS (:).

Champs compatibles:

  • displayName

Exemples :

  • Toutes les listes personnalisées dont le nom à afficher contient "Google" : displayName:"Google".

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.
Paramètre d'union accessor. Obligatoire. Identifie l'entité DV360 dans laquelle la requête est effectuée. La requête LIST ne renvoie que les entités de liste personnalisées accessibles à l'entité DV360 identifiée dans accessor. La accessor ne peut être qu'un des éléments suivants :
advertiserId

string (int64 format)

ID de l'annonceur DV360 ayant accès aux listes personnalisées extraites.

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

object (CustomList)

Liste des listes personnalisées.

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