Method: advertisers.insertionOrders.list

Répertorie les ordres d'insertion d'un annonceur.

L'ordre est défini par le paramètre orderBy. Si aucun filter par entityStatus n'est spécifié, les ordres d'insertion avec ENTITY_STATUS_ARCHIVED ne sont pas inclus dans les résultats.

Requête HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

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 lister les ordres d'insertion.

Paramètres de requête

Paramètres
pageSize

integer

Taille de la page demandée. Doit être compris entre 1 et 100. 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. Il s'agit généralement de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode insertionOrders.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 :

  • "displayName" (par défaut)
  • "entityStatus"
  • "updateTime"

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 en fonction des champs d'ordre d'insertion.

Syntaxe acceptée:

  • 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}.
  • Le champ updateTime doit utiliser les opérateurs GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=).
  • Tous les autres champs doivent utiliser l'opérateur EQUALS (=).

Champs acceptés:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (saisir au format ISO 8601 ou YYYY-MM-DDTHH:MM:SSZ)

Exemples :

  • Tous les ordres d'insertion d'une campagne: campaignId="1234"
  • Tous les ordres d'insertion ENTITY_STATUS_ACTIVE ou ENTITY_STATUS_PAUSED d'un annonceur: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Toutes les commandes d'insertion dont l'heure de mise à jour est inférieure ou égale à 2020-11-04T18:54:47Z (format ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Toutes les commandes d'insertion dont l'heure de mise à jour est supérieure ou égale à 2020-11-04T18:54:47Z (format ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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.

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

object (InsertionOrder)

Liste des ordres d'insertion.

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 insertionOrders.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 OAuth 2.0 Overview.