Method: advertisers.reachForecast.retrievePlannableUserLists

Récupère les listes d'utilisateurs propriétaires et tierces disponibles pour les prévisions.

Requête HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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 pour lequel récupérer les listes d'utilisateurs planifiables.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de la page demandée. La valeur doit être comprise entre 1 et 5000. Si aucune valeur n'est spécifiée, la valeur définie par défaut est 5000.
pageToken

string

Facultatif. 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 reachForecast.retrievePlannableUserLists. Si aucun jeton n'est fourni, la première page de résultats est renvoyée.
filter

string

Facultatif. Permet de filtrer les données selon les propriétés des listes d'utilisateurs planifiables.

Syntaxe applicable :

  • 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 displayName doit utiliser l'opérateur HAS (:).
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs pris en charge :

  • plannableStatus
  • displayName
  • userListType
  • name

Exemples :

  • Toutes les listes d'utilisateurs planifiables : plannableStatus="PLANNABLE"
  • Listes d'utilisateurs planifiables dont le nom à afficher contient "Shopping" : plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Listes d'utilisateurs propriétaires : userListType="FIRST_PARTY"

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 filtre LIST requests.

Corps de la requête

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

Corps de la réponse

Réponse pour reachForecast.retrievePlannableUserLists.

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

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

object (PlannableUserList)

Uniquement en sortie. Liste des listes d'utilisateurs planifiables.
nextPageToken

string

Uniquement en sortie. Jeton permettant de 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.

PlannableUserList

Liste d'utilisateurs planifiables utilisée pour les prévisions de couverture.

Représentation JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Champs
displayName

string

Uniquement en sortie. Nom à afficher de la liste d'utilisateurs.
userListType

enum (UserListType)

Uniquement en sortie. Type de la liste d'utilisateurs.
name

string

Uniquement en sortie. Nom de la ressource identifiant la liste d'utilisateurs.

Format: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Uniquement en sortie. État de planifiabilité de la liste d'utilisateurs.

UserListType

Types de listes d'utilisateurs.

Enums
USER_LIST_TYPE_UNSPECIFIED Type de liste d'utilisateurs non spécifié.
FIRST_PARTY Liste d'utilisateurs propriétaires.
THIRD_PARTY Liste d'utilisateurs tierce.

PlannableStatus

État indiquant si une liste est planifiable ou non.

Enums
PLANNABLE_STATUS_UNSPECIFIED État de planifiabilité non spécifié.
PLANNABLE La liste d'utilisateurs est planifiable.
UNPLANNABLE La liste d'utilisateurs n'est pas planifiable.