Method: advertisers.creatives.list

Liste les créations d'un annonceur.

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

Requête HTTP

GET https://displayvideo.googleapis.com/v1beta2/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. Référence 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. La valeur doit être comprise entre 1 et 100. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. Renvoie le code d'erreur INVALID_ARGUMENT si la valeur spécifiée n'est pas valide.
pageToken

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. En général, il s'agit de la valeur de nextPageToken renvoyée par l'appel précédent à la méthode creatives.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 :

  • creativeId (par défaut)
  • createTime
  • mediaDuration
  • dimensions (trie d'abord par largeur, puis par hauteur)

Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant d'un champ, ajoutez un suffixe "desc". doit être ajouté au nom du champ. Exemple : createTime desc
filter

string

Permet un filtrage en fonction des propriétés des créations.

Syntaxe compatible:

  • Les expressions de filtre sont constituées d'une ou de plusieurs restrictions.
  • La restriction pour le même champ doit être combinée par OR.
  • Les restrictions pour des champs différents doivent être combinées par AND.
  • Entre ( et ), il ne peut y avoir que des restrictions combinées par OR pour le même champ.
  • Une restriction se présente sous la forme {field} {operator} {value}.
  • L'opérateur doit être EQUALS (=) pour les champs suivants: <ph type="x-smartling-placeholder">
      </ph>
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • L'opérateur doit être HAS (:) pour les champs suivants: <ph type="x-smartling-placeholder">
      </ph>
    • lineItemIds
  • L'opérateur doit être GREATER THAN OR EQUAL TO (>=) ou LESS THAN OR EQUAL TO (<=) pour les champs suivants: <ph type="x-smartling-placeholder">
      </ph>
    • updateTime (entrée au format ISO 8601, ou AAAA-MM-JJTHH:MM:SSZ)
  • Pour entityStatus, minDuration, maxDuration, updateTime et dynamic, il peut y avoir au maximum une restriction.
  • Pour dimensions, la valeur se présente sous la forme "{width}x{height}".
  • Pour exchangeReviewStatus, la valeur se présente sous la forme {exchange}-{reviewStatus}.
  • Pour minDuration et maxDuration, la valeur se présente sous la forme "{duration}s". Seules les secondes sont acceptées avec une précision à la milliseconde.
  • 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, ce qui inclut les mises à jour effectuées par le système (par exemple, les mises à jour de l'examen des créations).
  • Il peut y avoir plusieurs restrictions lineItemIds pour effectuer une recherche parmi plusieurs ID d'élément de campagne possibles.
  • Plusieurs restrictions creativeId peuvent s'appliquer pour effectuer une recherche parmi plusieurs ID de création possibles.

Exemples :

  • Toutes les créations natives: creativeType="CREATIVE_TYPE_NATIVE"
  • Toutes les créations actives de 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 à l'ID d'élément de campagne 1 ou 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Rechercher des créations selon plusieurs ID: creativeId=1 OR creativeId=2

  • Toutes les créations dont la date de mise à jour est supérieure ou égale à 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" La longueur de ce champ ne doit pas dépasser 500 caractères.

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