REST Resource: advertisers.creatives

Ressource: Création

Une seule création.

Représentation JSON
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la création.

advertiserId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'annonceur auquel la création appartient.

creativeId

string (int64 format)

Uniquement en sortie. Identifiant unique de la création. Attribué par le système.

cmPlacementId

string (int64 format)

Uniquement en sortie. ID unique de l'emplacement Campaign Manager 360 associé à la création. Ce champ ne s'applique qu'aux créations synchronisées à partir de Campaign Manager.

displayName

string

Obligatoire. Nom à afficher de la création.

Doit être encodé au format UTF-8 avec une taille maximale de 240 octets.

entityStatus

enum (EntityStatus)

Obligatoire. Détermine si la création peut être diffusée ou non.

Les valeurs acceptées sont les suivantes :

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de la création, soit par l'utilisateur, soit par le système (examen des créations, par exemple). Attribué par le système.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la génération de la création. Attribué par le système.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

creativeType

enum (CreativeType)

Obligatoire. Immuable. Type de la création.

hostingSource

enum (HostingSource)

Obligatoire. Indique où la création est hébergée.

dynamic

boolean

Uniquement en sortie. Indique si la création est dynamique.

dimensions

object (Dimensions)

Obligatoire. Dimensions principales de la création. Applicable à tous les types de créations. La valeur de widthPixels et heightPixels est définie par défaut sur 0 lorsque creativeType est l'une des valeurs suivantes:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

Dimensions supplémentaires. Applicable lorsque creativeType correspond à l'une des valeurs suivantes:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Si ce champ est spécifié, widthPixels et heightPixels sont obligatoires et doivent être supérieurs ou égal à 0.

mediaDuration

string (Duration format)

Uniquement en sortie. Durée du support de la création. Applicable lorsque creativeType correspond à l'une des valeurs suivantes:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

creativeAttributes[]

enum (CreativeAttribute)

Uniquement en sortie. Liste des attributs de la création générée par le système.

reviewStatus

object (ReviewStatusInfo)

Uniquement en sortie. État actuel du processus d'examen des créations.

assets[]

object (AssetAssociation)

Obligatoire. Éléments associés à cette création.

exitEvents[]

object (ExitEvent)

Obligatoire. Événements de sortie pour cette création Une sortie (également appelée "tag de clic") est une zone de la création sur laquelle un utilisateur peut cliquer ou appuyer pour ouvrir la page de destination d'un annonceur. Chaque création doit inclure au moins une sortie. Vous pouvez ajouter une sortie à une création de l'une des manières suivantes:

  • Utilisez la zone cliquable de Google Web Designer.
  • Définissez une variable JavaScript appelée "clickTAG".
  • Utilisez l'activateur (Enabler.exit()) pour effectuer le suivi des sorties dans les formats rich media.
timerEvents[]

object (TimerEvent)

Événements personnalisés de minuteur pour une création rich media. Les minuteurs enregistrent la durée pendant laquelle un internaute affiche une partie spécifique d'une création rich media et interagit avec celle-ci. Une création peut disposer de plusieurs événements de minuteur, chacun étant chronométré indépendamment. Laissez ce champ vide ou n'est pas défini pour les créations contenant des composants Image uniquement.

counterEvents[]

object (CounterEvent)

Événements de compteur pour une création rich media. Les compteurs comptabilisent le nombre de fois qu'un internaute interagit avec n'importe quelle partie d'une création rich media d'une manière déterminée (survols et sorties du curseur, clics, appuis, chargement de données, saisies au clavier, etc.). Tout événement pouvant être capturé dans la création peut être enregistré en tant que compteur. Laissez ce champ vide ou n'est pas défini pour les créations contenant des composants Image uniquement.

appendedTag

string

Balise de suivi HTML tierce à ajouter au tag de la création.

integrationCode

string

Identifiant utilisé pour associer cette création à un système externe. Doit être encodé au format UTF-8 avec une longueur maximale de 10 000 caractères.

notes

string

Remarques de l'utilisateur concernant cette création. Doit être encodé au format UTF-8 avec une longueur maximale de 20 000 caractères.

iasCampaignMonitoring

boolean

Indique si le contrôle des campagnes Integral Ad Science (IAS) est activé. Afin d'activer cette option pour la création, assurez-vous que Advertiser.creative_config.ias_client_id a été défini sur votre numéro client IAS.

companionCreativeIds[]

string (int64 format)

Identifiants des créations associées à une création vidéo.

Vous pouvez attribuer des créations display existantes (avec des éléments image ou HTML5) à diffuser autour du lecteur vidéo de l'éditeur. Les créations associées s'affichent autour du lecteur vidéo pendant la lecture de la vidéo et restent en place une fois la vidéo terminée.

Les créations contenant "additional dimensions" ne peuvent pas être des créations associées.

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Indique si l'utilisateur peut choisir d'ignorer une création vidéo.

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

Durée de lecture de la vidéo avant que le bouton "Ignorer" ne s'affiche.

Ce champ est obligatoire lorsque la valeur de skippable est "true".

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

Durée de lecture de la vidéo avant qu'une vue soit comptabilisée.

Ce champ est obligatoire lorsque la valeur de skippable est "true".

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

Facultatif. Identifiant de création facultatif fourni par un registre unique sur toutes les plates-formes.

L'identifiant d'annonce universelle fait partie de la norme VAST 4.0. Il peut être modifié après la conception de la création.

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

URL de suivi provenant de tiers pour suivre les interactions avec une création vidéo

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

Uniquement en sortie. Transcodages audio/vidéo

Display & Video 360 transcode l'élément principal en un certain nombre de versions alternatives qui utilisent différents formats de fichiers ou qui possèdent différentes propriétés (résolution, débit audio et débit vidéo). Chacune est conçue pour des lecteurs vidéo ou des bandes passantes spécifiques.

Ces transcodages offrent au système de l'éditeur un choix plus large d'options pour chaque impression de votre vidéo. De plus, le fichier approprié est diffusé en fonction de la connexion de l'internaute et de la taille de son écran.

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

URL de suivi pour les fournisseurs de solutions d'analyse ou les fournisseurs de technologies publicitaires tiers.

Les URL doivent commencer par "https" (sauf pour les inventaires qui n'exigent pas d'être conformes à la norme SSL). Si vous incluez des macros dans votre URL, utilisez uniquement des macros compatibles avec Display & Video 360.

URL standards uniquement, pas de tags IMG ou SCRIPT.

Ce champ n'est accessible en écriture que dans le fichier creativeType suivant:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

URL de mesure JavaScript provenant de fournisseurs de validation tiers compatibles (ComScore, DoubleVerify, IAS, Moat). Les tags de script HTML ne sont pas acceptés.

Ce champ n'est accessible en écriture que dans le fichier creativeType suivant:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

Annonce de suivi Campaign Manager 360 associée à la création.

Facultatif pour l'élément creativeType suivant, lorsqu'il est créé par un annonceur utilisant à la fois Campaign Manager 360 et un service de diffusion d'annonces par un tiers:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

Sortie uniquement pour les autres cas.

obaIcon

object (ObaIcon)

Spécifie l'icône PCL pour une création vidéo.

Ce champ n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

Facultatif. Tag tiers d'origine utilisé pour la création.

Obligatoire et valide uniquement pour les créations avec tag tiers.

Les créations avec tag tiers sont associées aux attributs hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

Facultatif. Indique que la création nécessite le système MRAID (Mobile Rich Media Ad Interface Definitions).

Définissez ce paramètre si la création implique des gestes d'interaction (s'il est nécessaire de balayer l'écran ou d'appuyer dessus, par exemple).

Facultatif et valide uniquement pour les créations avec tag tiers.

Les créations avec tag tiers sont associées aux attributs hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

Facultatif. Indique que la création n'a besoin que d'HTML5 pour s'afficher correctement.

Facultatif et valide uniquement pour les créations avec tag tiers. Les créations avec tag tiers sont associées aux attributs hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

Facultatif. Indique que la création attendra un ping renvoyé pour l'attribution.

N'est valide que lorsque vous utilisez une annonce de suivi Campaign Manager 360 avec un paramètre d'ad server tiers et la macro ${DC_DBM_TOKEN}.

Facultatif et valide uniquement pour les créations avec tag tiers ou avec tag VAST tiers.

Les créations avec tag tiers sont associées aux attributs hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

Les créations avec tag VAST tiers sont associées aux hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

Facultatif. Spécifie la direction d'expansion de la création.

Obligatoire et valide uniquement pour les créations extensibles tierces.

Les créations extensibles tierces sont des créations dont la source d'hébergement est la suivante:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Facultatif. Indique que la création se déplie automatiquement lorsque l'utilisateur passe la souris dessus.

Facultatif et valide uniquement pour les créations extensibles tierces. Les créations extensibles tierces sont des créations dont la source d'hébergement est la suivante:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

Facultatif. URL du tag VAST pour une création avec tag VAST tiers.

Obligatoire et valide uniquement pour les créations avec tag VAST tiers.

Les créations avec tag VAST tiers sont associées aux hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

Uniquement en sortie. Indique que la création avec tag VAST tiers requiert la norme VPAID (Digital Video Player-Ad Interface).

Uniquement disponible pour les créations avec tag VAST tiers.

Les créations avec tag VAST tiers sont associées aux hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Uniquement en sortie. Indique que la création avec tag VAST tiers nécessite une compatibilité vidéo HTML5.

Uniquement disponible pour les créations avec tag VAST tiers.

Les créations avec tag VAST tiers sont associées aux hostingSource suivants:

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

Uniquement en sortie. ID des éléments de campagne auxquels cette création est associée.

Pour associer une création à un élément de campagne, utilisez plutôt LineItem.creative_ids.

mp3Audio

boolean

Uniquement en sortie. Indique que la création audio tierce est compatible avec le format MP3.

Uniquement en sortie et valides uniquement pour les créations audio tierces.

Les créations audio tierces sont des créations présentant les caractéristiques suivantes : hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

Uniquement en sortie. Indique que la création audio tierce est compatible avec le format OGG.

Uniquement en sortie et valides uniquement pour les créations audio tierces.

Les créations audio tierces sont des créations présentant les caractéristiques suivantes : hostingSource :

  • HOSTING_SOURCE_THIRD_PARTY

combiné aux creativeType suivants:

  • CREATIVE_TYPE_AUDIO

HostingSource

Sources d'hébergement possibles pour une création. Indique où une création est générée et hébergée.

Enums
HOSTING_SOURCE_UNSPECIFIED La source d'hébergement n'est pas spécifiée ou est inconnue dans cette version.
HOSTING_SOURCE_CM

Une création synchronisée à partir de Campaign Manager 360.

Les méthodes de création et de mise à jour ne sont pas compatibles avec ce type d'hébergement.

HOSTING_SOURCE_THIRD_PARTY

Il s'agit d'une création hébergée par un ad server tiers (3PAS).

Les méthodes de création et de mise à jour sont acceptées pour ce type d'hébergement si creativeType est l'un des suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Il s'agit d'une création conçue dans DV360 et hébergée par Campaign Manager 360.

Les méthodes de création et de mise à jour sont acceptées pour ce type d'hébergement si creativeType est l'un des suivants:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

Création rich media conçue dans Studio et hébergée par Campaign Manager 360.

Les méthodes de création et de mise à jour ne sont pas compatibles avec ce type d'hébergement.

CreativeAttribute

Attributs possibles d'une création.

Enums
CREATIVE_ATTRIBUTE_UNSPECIFIED L'attribut de création n'est pas spécifié ou est inconnu dans cette version.
CREATIVE_ATTRIBUTE_VAST La création est de type VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR La création est une création VPAID linéaire.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR La création est une création VPAID non linéaire.

ReviewStatusInfo

État de l'examen de la création

Représentation JSON
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
Champs
approvalStatus

enum (ApprovalStatus)

Représente l'approbation de base nécessaire pour qu'une création puisse être diffusée. Récapitulatif pour creativeAndLandingPageReviewStatus et contentAndPolicyReviewStatus.

creativeAndLandingPageReviewStatus

enum (ReviewStatus)

État de l'examen de la création et de la page de destination.

contentAndPolicyReviewStatus

enum (ReviewStatus)

État de la vérification du contenu et du respect des règles pour la création.

exchangeReviewStatuses[]

object (ExchangeReviewStatus)

États d'examen de la place de marché pour la création

publisherReviewStatuses[]
(deprecated)

object (PublisherReviewStatus)

États d'examen de l'éditeur pour la création.

ApprovalStatus

Types possibles d'états d'approbation. Il s'agit du résumé de creativeAndLandingPageReviewStatus et contentAndPolicyReviewStatus.

Enums
APPROVAL_STATUS_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
APPROVAL_STATUS_PENDING_NOT_SERVABLE La création est toujours en cours d'examen et ne peut pas être diffusée.
APPROVAL_STATUS_PENDING_SERVABLE La création a réussi l'examen de la création et de la page de destination et peut être diffusée, mais elle est en attente d'une vérification supplémentaire du contenu et du respect des règles.
APPROVAL_STATUS_APPROVED_SERVABLE L'examen des créations et des pages de destination ainsi que la vérification du contenu et du respect des règles sont approuvés. La création peut être diffusée.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE Un problème lié à la création doit être corrigé pour que vous puissiez la diffuser.

ReviewStatus

Types possibles d'états d'examen.

Enums
REVIEW_STATUS_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
REVIEW_STATUS_APPROVED La création est approuvée.
REVIEW_STATUS_REJECTED La création a été refusée.
REVIEW_STATUS_PENDING La création est en attente d'examen.

ExchangeReviewStatus

État de l'examen de la place de marché pour la création.

Représentation JSON
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
Champs
exchange

enum (Exchange)

Place de marché qui examine la création.

status

enum (ReviewStatus)

État de l'examen de la place de marché.

PublisherReviewStatus

État de l'examen de l'éditeur pour la création.

Représentation JSON
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
Champs
publisherName

string

L'éditeur qui examine la création.

status

enum (ReviewStatus)

État de l'examen de l'éditeur.

AssetAssociation

Association d'élément pour la création.

Représentation JSON
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
Champs
asset

object (Asset)

Élément associé.

role

enum (AssetRole)

Rôle de cet élément pour la création.

Élément

Un seul élément.

Représentation JSON
{
  "mediaId": string,
  "content": string
}
Champs
mediaId

string (int64 format)

ID élément multimédia de l'élément importé. Il s'agit de l'identifiant unique de l'élément. Cet ID peut être transmis à d'autres appels d'API (par exemple, creatives.create) pour associer l'élément à une création.

Espace "ID média" mis à jour le 5 avril 2023. Mettez à jour les ID multimédias mis en cache avant le 5 avril 2023 en récupérant le nouvel ID multimédia des ressources de création associées ou en réimportant l'élément.

content

string

Contenu de l'élément. Pour les éléments importés, le contenu correspond au chemin de diffusion.

AssetRole

Rôle de cet élément pour la création.

Enums
ASSET_ROLE_UNSPECIFIED Le rôle de l'élément n'est pas spécifié ou est inconnu dans cette version.
ASSET_ROLE_MAIN L'élément est l'élément principal de la création.
ASSET_ROLE_BACKUP L'élément est un élément de back-up de la création.
ASSET_ROLE_POLITE_LOAD L'élément est un élément polite load de la création.
ASSET_ROLE_HEADLINE

Titre d'une création native.

L'content doit être encodé au format UTF-8 et ne pas dépasser 25 caractères.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Titre long d'une création native.

L'content doit être encodé au format UTF-8 et ne pas dépasser 50 caractères.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Corps du texte d'une création native.

L'content doit être encodé au format UTF-8 et ne pas dépasser 90 caractères.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Corps du texte long d'une création native.

Le content doit être encodé au format UTF-8 et ne pas dépasser 150 caractères.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

Version courte et conviviale de l'URL de la page de destination à afficher dans la création. Cette URL donne aux utilisateurs une idée de la page vers laquelle ils seront redirigés s'ils cliquent sur la création.

L'content doit être encodé au format UTF-8 et ne pas dépasser 30 caractères.

Par exemple, si l'URL de la page de destination est "http://www.example.com/page", l'URL de la légende peut être "example.com". Le protocole (http://) est facultatif, mais l'URL ne peut pas contenir d'espaces ni de caractères spéciaux.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

Texte à utiliser sur le bouton d'incitation à l'action d'une création native.

L'content doit être encodé au format UTF-8 et contenir 15 caractères au maximum.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

Texte qui identifie le nom de l'annonceur ou de la marque.

L'content doit être encodé au format UTF-8 et ne pas dépasser 25 caractères.

Ce rôle n'est compatible qu'avec les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

Prix d'achat de votre application sur le Google Play Store ou l'App Store iOS (5,99 €, par exemple).

Notez que cette valeur n'est pas automatiquement synchronisée avec la valeur réelle indiquée dans le magasin. Il s'agit toujours de celle fournie lors de l'enregistrement de la création.

L'content doit être encodé au format UTF-8 et contenir 15 caractères au maximum.

Les éléments de ce rôle sont en lecture seule.

ASSET_ROLE_ANDROID_APP_ID

ID d'une application Android sur le Google Play Store.

Cet ID se trouve dans l'URL Google Play Store de l'application, après "id". Par exemple, dans https://play.google.com/store/apps/details?id=com.company.appname, l'identifiant est com.entreprise.nomapplication.

Les éléments de ce rôle sont en lecture seule.

ASSET_ROLE_IOS_APP_ID

ID d'une application iOS sur l'App Store d'Apple.

Cet identifiant se trouve dans l'URL de l'App Store d'Apple, sous la forme d'une chaîne de chiffres juste après "id". Par exemple, dans https://apps.apple.com/us/app/gmail-email-by-google/id422689480, l'ID est 422689480.

Les éléments de ce rôle sont en lecture seule.

ASSET_ROLE_RATING

Note d'une application sur le Google Play Store ou l'App Store iOS.

Notez que cette valeur n'est pas automatiquement synchronisée avec la note réelle affichée dans le magasin. Il s'agit toujours de celle fournie lors de l'enregistrement de la création.

Les éléments de ce rôle sont en lecture seule.

ASSET_ROLE_ICON

Icône d'une création.

Ce rôle n'est compatible et obligatoire que dans les creativeType suivants:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

Image de couverture d'une création vidéo native.

Ce rôle n'est compatible et obligatoire que dans les creativeType suivants:

  • CREATIVE_TYPE_VIDEO

ExitEvent

Événement de sortie de la création

Représentation JSON
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
Champs
type

enum (ExitEventType)

Obligatoire. Type d'événement de sortie.

url

string

Obligatoire. URL de destination de l'événement de sortie. Ce champ est obligatoire lorsque type est:

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

Nom du tag de clic de l'événement de sortie.

Le nom doit être unique au sein d'une création.

Laissez ce champ vide ou n'est pas défini pour les créations contenant des composants Image uniquement.

reportingName

string

Nom utilisé pour identifier cet événement dans les rapports. Laissez ce champ vide ou n'est pas défini pour les créations contenant des composants Image uniquement.

ExitEventType

Type d'un événement de sortie.

Enums
EXIT_EVENT_TYPE_UNSPECIFIED Le type d'événement de sortie n'est pas spécifié ou est inconnu dans cette version.
EXIT_EVENT_TYPE_DEFAULT L'événement de sortie est l'événement par défaut.
EXIT_EVENT_TYPE_BACKUP L'événement de sortie est un événement de sortie de back-up. Une création peut contenir plusieurs événements de sortie de back-up.

TimerEvent

Événement de minuteur de la création.

Représentation JSON
{
  "name": string,
  "reportingName": string
}
Champs
name

string

Obligatoire. Nom de l'événement de minuteur.

reportingName

string

Obligatoire. Nom permettant d'identifier cet événement de minuteur dans les rapports.

CounterEvent

Événement de compteur de la création.

Représentation JSON
{
  "name": string,
  "reportingName": string
}
Champs
name

string

Obligatoire. Nom de l'événement de compteur.

reportingName

string

Obligatoire. Nom utilisé pour identifier cet événement de compteur dans les rapports.

AudioVideoOffset

Durée de lecture d'un fichier audio ou d'une vidéo.

Représentation JSON
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
Champs
Champ d'union offset. Valeur du décalage. offset ne peut être qu'un des éléments suivants :
percentage

string (int64 format)

Décalage, en pourcentage, par rapport à la durée de l'audio ou de la vidéo.

seconds

string (int64 format)

Décalage, en secondes, à partir du début de l'audio ou de la vidéo.

UniversalAdId

Identifiant de création fourni par un registre unique sur toutes les plates-formes. Cela fait partie de la norme VAST 4.0.

Représentation JSON
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
Champs
id

string

Identifiant unique de la création.

registry

enum (UniversalAdRegistry)

Le registre fournit des identifiants de création uniques.

UniversalAdRegistry

Le registre fournit des identifiants de création uniques dans un identifiant d'annonce universelle.

Enums
UNIVERSAL_AD_REGISTRY_UNSPECIFIED Le registre Universal Ad Registry n'est pas spécifié ou est inconnu dans cette version.
UNIVERSAL_AD_REGISTRY_OTHER Utilisez un fournisseur personnalisé pour fournir l'identifiant de l'annonce universelle.
UNIVERSAL_AD_REGISTRY_AD_ID Utilisez l'identifiant de l'annonce pour indiquer l'identifiant de l'annonce universelle.
UNIVERSAL_AD_REGISTRY_CLEARCAST Utilisez le site clearcast.co.uk pour indiquer l'identifiant de l'annonce universelle.
UNIVERSAL_AD_REGISTRY_DV360 Utilisez Display & Video 360 pour fournir l'identifiant d'annonce universelle.
UNIVERSAL_AD_REGISTRY_CM Utilisez Campaign Manager 360 pour fournir l'identifiant d'annonce universelle.

ThirdPartyUrl

URL de suivi provenant de tiers pour suivre les interactions avec une création audio ou vidéo

Représentation JSON
{
  "type": enum (ThirdPartyUrlType),
  "url": string
}
Champs
type

enum (ThirdPartyUrlType)

Le type d'interaction doit être suivi à l'aide de l'URL de suivi.

url

string

URL de suivi utilisée pour suivre l'interaction.

Indiquez une URL avec un chemin d'accès ou une chaîne de requête facultatifs commençant par https:. (par exemple, https://www.example.com/path).

ThirdPartyUrlType

Le type d'interaction doit être suivi par l'URL de suivi tierce.

Enums
THIRD_PARTY_URL_TYPE_UNSPECIFIED Le type d'URL tierce n'est pas spécifié ou est inconnu dans cette version.
THIRD_PARTY_URL_TYPE_IMPRESSION Permet de comptabiliser les impressions de la création une fois la mise en mémoire tampon audio ou vidéo terminée.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING Utilisé pour suivre les clics des utilisateurs sur l'audio ou la vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START Indique le nombre de fois où un utilisateur lance l'audio ou la vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE Indique le nombre de fois où l'audio ou la vidéo a été lu jusqu'à 25% de sa durée.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT Indique le nombre de fois où le contenu audio ou vidéo a été lu jusqu'à 50% de sa durée.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE Indique le nombre de fois où l'audio ou la vidéo a été lu jusqu'à 75% de sa durée.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Indique le nombre de fois où l'audio ou la vidéo ont été lus dans leur intégralité.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE Indique le nombre de fois où un utilisateur a désactivé le son de l'audio ou de la vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE Indique le nombre de fois où un utilisateur a mis l'audio ou la vidéo en pause.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND Indique le nombre de fois où un utilisateur lit à nouveau l'audio ou la vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Indique le nombre de fois où un internaute a affiché le lecteur en plein écran.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP Indique le nombre de fois où un utilisateur arrête la lecture audio ou vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM Indique le nombre de fois où un utilisateur effectue un clic personnalisé, comme un clic sur une zone réactive vidéo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP Indique le nombre de fois où l'audio ou la vidéo ont été ignorés.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Indique le nombre de fois où l'audio ou la vidéo sont lus par rapport à un décalage déterminé par progressOffset.

Conversion

Représente les informations relatives au fichier audio ou vidéo transcodé.

Représentation JSON
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Champs
name

string

Nom du fichier transcodé.

mimeType

string

Type MIME du fichier transcodé.

transcoded

boolean

Indique si le transcodage a réussi.

dimensions

object (Dimensions)

Dimensions de la vidéo transcodée.

bitRateKbps

string (int64 format)

Débit de transcodage de la vidéo transcodée, en kilobits par seconde.

frameRate

number

Fréquence d'images de la vidéo transcodée, exprimée en images par seconde.

audioBitRateKbps

string (int64 format)

Débit du flux audio de la vidéo transcodée, ou débit du contenu audio transcodé, en kilobits par seconde.

audioSampleRateHz

string (int64 format)

Taux d'échantillonnage du flux audio de la vidéo transcodée ou du taux d'échantillonnage du contenu audio transcodé, en hertz.

fileSizeBytes

string (int64 format)

Taille du fichier transcodé, en octets.

CmTrackingAd

Annonce de suivi Campaign Manager 360.

Représentation JSON
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Champs
cmPlacementId

string (int64 format)

ID d'emplacement de l'annonce de suivi Campaign Manager 360.

cmCreativeId

string (int64 format)

ID de la création de l'annonce de suivi Campaign Manager 360.

cmAdId

string (int64 format)

ID de l'annonce de suivi Campaign Manager 360.

ObaIcon

Icône de publicité comportementale en ligne pour une création

Représentation JSON
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
Champs
resourceUrl

string

URL de la ressource d'icône de publicité comportementale en ligne.

resourceMimeType

string

Type MIME de la ressource d'icône de publicité comportementale en ligne.

position

enum (ObaIconPosition)

Position de l'icône de publicité comportementale en ligne dans la création.

dimensions

object (Dimensions)

Dimensions de l'icône de publicité comportementale en ligne.

program

string

Programme de l'icône de publicité comportementale en ligne. Par exemple : "Choisir sa pub".

landingPageUrl

string

Obligatoire. URL de la page de destination de l'icône de publicité comportementale en ligne.

Seules les URL des domaines suivants sont autorisées:

clickTrackingUrl

string

Obligatoire. URL de suivi des clics de l'icône de publicité comportementale en ligne.

Seules les URL des domaines suivants sont autorisées:

viewTrackingUrl

string

Obligatoire. URL de suivi des vues de l'icône de publicité comportementale en ligne.

Seules les URL des domaines suivants sont autorisées:

ObaIconPosition

Position de l'icône de publicité comportementale en ligne dans la création.

Enums
OBA_ICON_POSITION_UNSPECIFIED La position de l'icône de publicité comportementale en ligne n'est pas spécifiée.
OBA_ICON_POSITION_UPPER_RIGHT En haut à droite de la création.
OBA_ICON_POSITION_UPPER_LEFT En haut à gauche de la création.
OBA_ICON_POSITION_LOWER_RIGHT En bas à droite de la création.
OBA_ICON_POSITION_LOWER_LEFT En bas à gauche de la création.

ExpandingDirection

Direction d'expansion de la création extensible tierce.

Enums
EXPANDING_DIRECTION_UNSPECIFIED La direction d'expansion n'est pas spécifiée.
EXPANDING_DIRECTION_NONE ne se déplie pas dans toutes les directions ;
EXPANDING_DIRECTION_UP Se développe vers le haut.
EXPANDING_DIRECTION_DOWN Se développe vers le bas.
EXPANDING_DIRECTION_LEFT Se développe vers la gauche.
EXPANDING_DIRECTION_RIGHT Se développe vers la droite.
EXPANDING_DIRECTION_UP_AND_LEFT Se déplie vers le haut et sur le côté gauche.
EXPANDING_DIRECTION_UP_AND_RIGHT Se déplie vers le haut et sur le côté droit.
EXPANDING_DIRECTION_DOWN_AND_LEFT Se développe vers le bas et la gauche.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Se développe vers le bas et le côté droit.
EXPANDING_DIRECTION_UP_OR_DOWN Se déplie vers le haut ou vers le bas.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Se déplie vers la gauche ou le côté droit.
EXPANDING_DIRECTION_ANY_DIAGONAL Peut se déplier dans n'importe quelle direction en diagonale.

Méthodes

create

Permet d'ajouter une création.

delete

Supprime une création.

get

Permet d'obtenir une création.

list

Liste les créations d'un annonceur.

patch

Met à jour une création existante.