Method: guaranteedOrders.list

L'

Liste les commandes garanties accessibles à l'utilisateur actuel.

L'ordre est défini par le paramètre orderBy. Si le filtre (filter) entityStatus n'est pas spécifié, les commandes garanties avec l'état d'entité ENTITY_STATUS_ARCHIVED ne seront pas incluses dans les résultats.

Requête HTTP

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

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

string

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 guaranteedOrders.list. Si cette option n'est pas spécifiée, 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 :

  • displayName (par défaut)

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. Par exemple, displayName desc.
filter

string

Permet de filtrer les commandes garanties selon certains champs.

  • 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 séquence de restrictions utilise implicitement AND.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • Tous les champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés : * guaranteedOrderId * exchange * displayName * status.entityStatus

Exemples :

  • Toutes les commandes garanties actives : status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Commandes garanties appartenant aux places de marché Google Ad Manager ou Rubicon : exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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.

Paramètre d'union accessor. Obligatoire.

Identifie l'entité DV360 pour laquelle la requête est effectuée. La requête LIST ne renvoie que les commandes garanties accessibles à l'entité DV360 identifiée dans accessor. accessor ne peut être qu'un des éléments suivants :
partnerId

string (int64 format)

ID du partenaire ayant accès à la commande garantie.
advertiserId

string (int64 format)

ID de l'annonceur ayant accès à la commande garantie.

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

object (GuaranteedOrder)

Liste des commandes garanties.

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 de l'appel suivant à la méthode guaranteedOrders.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 page OAuth 2.0 Overview.