Method: advertisers.creatives.list

Liste les créations d'un annonceur.

L'ordre est défini par le paramètre orderBy. Si aucun élément filter par entityStatus n'est spécifié, les créations associées à l'attribut ENTITY_STATUS_ARCHIVED ne seront pas incluses dans les résultats.

Requête HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/creatives

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épertorier les créations.

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

string

Champ selon lequel trier la liste. Les valeurs acceptées sont les suivantes :

  • creativeId (par défaut)
  • createTime
  • mediaDuration
  • dimensions (trier par largeur, puis par hauteur)

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, vous devez ajouter le suffixe "desc" au nom du champ. Exemple : createTime desc
filter

string

Permet de filtrer par champs de création.

Syntaxe acceptée:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • Les restrictions peuvent être combinées par 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}.
  • Le champ lineItemIds doit utiliser l'opérateur HAS (:).
  • 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 (=).
  • Pour les champs entityStatus, minDuration, maxDuration, updateTime et dynamic, il peut y avoir au maximum une restriction.

Champs acceptés:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions (entrée au format {width}x{height})
  • dynamic
  • entityStatus
  • exchangeReviewStatus (entrée au format {exchange}-{reviewStatus})
  • lineItemIds
  • maxDuration (entrée au format {duration}s. Seules les secondes sont acceptées.)
  • minDuration (entrée au format {duration}s. Seules les secondes sont acceptées.)
  • updateTime (entrée au format ISO 8601, ou YYYY-MM-DDTHH:MM:SSZ)

Remarques :

  • Pour updateTime, la valeur du champ d'une ressource de création reflète la dernière fois qu'une création a été mise à jour, y compris les mises à jour effectuées par le système (par exemple, les mises à jour de l'examen des créations).

Exemples :

  • Toutes les créations natives: creativeType="CREATIVE_TYPE_NATIVE"
  • Toutes les créations actives de dimensions 300 x 400 ou 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Toutes les créations dynamiques approuvées par AdX ou AppNexus d'une durée minimale de 5 secondes et 200 ms: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Toutes les créations vidéo associées à l'ID 1 ou 2 de l'élément de campagne: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Rechercher des créations en fonction de plusieurs ID: creativeId=1 OR creativeId=2
  • Toutes les créations 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 les requêtes LIST de filtrage.

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

object (Creative)

Liste des créations.

Si cette liste est vide, elle sera absente.
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 ListCreativesRequest 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.