Method: guaranteedOrders.list

Liste les commandes garanties accessibles à l'utilisateur actuel.

L'ordre est défini par le paramètre orderBy. Si aucun élément filter par entityStatus n'est 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/v1/guaranteedOrders

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 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. En règle générale, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode guaranteedOrders.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 spécifier l'ordre décroissant d'un champ, vous devez ajouter le suffixe "desc" au nom du champ. Par exemple, displayName desc.
filter

string

Permet de filtrer par champs de commande garantis.

  • Les expressions de filtre sont composées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées avec les 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"
  • Campagnes garanties appartenant à des 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 le filtrage des requêtes LIST.

Paramètre d'union accessor. Obligatoire.

Identifie l'entité DV360 au sein de laquelle la demande est envoyée. La requête LIST ne renvoie que les entités de commande garanties qui sont accessibles à l'entité DV360 identifiée dans l'élément 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)

Référence de l'annonceur ayant accès à la campagne 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 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 lors de l'appel suivant de la méthode guaranteedOrders.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.