Method: combinedAudiences.list

Liste les audiences combinées.

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

Requête HTTP

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

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 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 à la méthode combinedAudiences.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 :

  • combinedAudienceId (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 d'audience combinés.

Syntaxe acceptée :

  • Les expressions de filtre pour les audiences combinées ne peuvent contenir qu'une seule restriction.
  • 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 audiences combiné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 d'audience combinées accessibles à l'entité DV360 identifiée dans accessor. La accessor ne peut être qu'un des éléments suivants :
partnerId

string (int64 format)

ID du partenaire ayant accès aux audiences combinées extraites.

advertiserId

string (int64 format)

ID de l'annonceur ayant accès aux audiences combiné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
{
  "combinedAudiences": [
    {
      object (CombinedAudience)
    }
  ],
  "nextPageToken": string
}
Champs
combinedAudiences[]

object (CombinedAudience)

Liste des audiences combiné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 combinedAudiences.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.