Method: lookalikeAudiences.list

Répertorie les audiences similaires.

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

Requête HTTP

GET https://displayvideo.googleapis.com/v5/lookalikeAudiences

L'URL utilise la syntaxe de transcodage gRPC.

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 une valeur non valide est spécifiée.

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 de la méthode lookalikeAudiences.list. Si ce paramètre n'est pas spécifié, 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 :

  • lookalikeAudienceId (par défaut)
  • displayName

L'ordre de tri par défaut est croissant. Pour spécifier l'ordre décroissant d'un champ, ajoutez le suffixe "desc" au nom du champ. Exemple : displayName desc.

filter

string

Permet de filtrer les audiences similaires selon certains champs.

Syntaxe acceptée :

  • Les expressions de filtre pour les audiences similaires 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 acceptés :

  • displayName

Exemples :

  • Toutes les audiences similaires dont le nom à afficher contient "Lookalike" : displayName:"Lookalike".

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

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

Obligatoire. Identifie l'entité DV360 pour laquelle la requête est effectuée. La requête LIST ne renvoie que les entités d'audience similaire accessibles à l'entité DV360 identifiée dans accessor. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
partnerId

string (int64 format)

ID du partenaire ayant accès aux audiences similaires récupérées.

advertiserId

string (int64 format)

ID de l'annonceur ayant accès aux audiences similaires récupérées.

Fin des champs mutuellement exclusifs.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour LookalikeAudienceService.ListLookalikeAudiences.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "lookalikeAudiences": [
    {
      object (LookalikeAudience)
    }
  ],
  "nextPageToken": string
}
Champs
lookalikeAudiences[]

object (LookalikeAudience)

Liste des audiences similaires.

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 lookalikeAudiences.list pour récupérer la page de résultats suivante.

Niveaux d'accès 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.