Method: customBiddingAlgorithms.list

Répertorie les algorithmes d'enchères personnalisées accessibles à l'utilisateur actuel et pouvant être utilisés dans les stratégies d'enchères.

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

Requête HTTP

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

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

string

Champ selon lequel la liste doit être triée. Les valeurs acceptées sont les suivantes :

  • displayName (par défaut)

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, ajoutez un suffixe "desc". doit être ajouté au nom du champ. Exemple : displayName desc
filter

string

Permet le filtrage par champs d'algorithme d'enchères personnalisées.

Syntaxe compatible:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par AND. Une séquence de restrictions utilise implicitement AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Le champ customBiddingAlgorithmType doit utiliser l'opérateur EQUALS (=).
  • Le champ displayName doit utiliser l'opérateur HAS (:).

Champs acceptés:

  • customBiddingAlgorithmType
  • displayName

Exemples :

  • Tous les algorithmes d'enchères personnalisées pour lesquels le nom à afficher contient "politique" : displayName:"politics".
  • Tous les algorithmes d'enchères personnalisées pour lesquels le type est "SCRIPT_BASED" : customBiddingAlgorithmType=SCRIPT_BASED

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 au sein de laquelle la requête est effectuée. La demande LIST ne renvoie que les entités d'algorithme d'enchères personnalisées accessibles à l'entité DV360 identifiée dans accessor. Pour exécuter une requête LIST, l'utilisateur doit disposer d'une autorisation pour l'entité accessor. accessor ne peut être que l'un des éléments suivants:
partnerId

string (int64 format)

ID du partenaire DV360 ayant accès à l'algorithme d'enchères personnalisées.
advertiserId

string (int64 format)

ID de l'annonceur DV360 ayant accès à l'algorithme d'enchères personnalisées.

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

object (CustomBiddingAlgorithm)

Liste des algorithmes d'enchères personnalisées.

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 ListCustomBiddingAlgorithmsRequest pour récupérer la page de résultats suivante. Si ce champ est nul, cela signifie qu'il s'agit de la dernière page.

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.