Method: advertisers.creatives.list

Liste les créations d'un annonceur.

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

Requête HTTP

GET https://displayvideo.googleapis.com/v4/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 vous souhaitez lister des 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 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 creatives.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 :

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

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 : createTime desc
filter

string

Permet de filtrer en fonction des champs de création.

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 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 ne peut y avoir qu'une seule 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 (saisir 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 au format 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, avec 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 aux ID d'élément de campagne 1 ou 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Rechercher des créations par plusieurs ID de création: 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 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 
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
Champs
creatives[]

object (Creative)

Liste des créations.

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