Partager via


Service CREATIVE VAST

Vous pouvez utiliser le service Creative Vast pour ajouter des éléments créatifs vidéo ou audio à Xandr. Toutes les créations doivent être attachées à un annonceur ou à un éditeur.

  • Vous pouvez afficher votre ID d’annonceur en appelant le service annonceur.
  • Vous pouvez afficher votre ID d’éditeur en appelant le service serveur de publication.
  • Vous pouvez attacher un élément créatif à un éditeur pour l’utiliser en tant que création par défaut pour un placement. Vous devez ensuite attacher le créatif à un placement via son ID à l’aide du service de placement.

Remarque

video_attribute est toujours obligatoire sur le point de creative-vastterminaison.

Audit

Xandr travaille avec des membres qui se soucient profondément de la marque et de la réputation. Pour cette raison, nous nous assurons que les publicités (créatives) qui passent par notre système sont acceptables par toutes les parties. Pour garantir la qualité, toutes les créations qui servent sur l’inventaire tiers doivent être préinscrites à l’aide du service Créatif.

  • Les créatifs sont identifiés par leur media_url (soit une URL de serveur d’annonce tiers, soit une URL de réseau de distribution de contenu pour un fichier Flash ou vidéo).
  • Xandr vérifie régulièrement media_urls. Si un fichier disparaît, le créatif est traité comme non audité.
  • Une fois qu’un créatif a réussi l’audit Xandr, certaines modifications apportées au créatif entraînent son renvoi pour audit. Pour plus d’informations, consultez Modifications qui provoquent un ré audit ci-dessous .
  • Pour plus d’informations sur l’audit, consultez Creative Standards and Auditing.

API REST

HTTP, méthode Endpoint Description
POST https://api.appnexus.com/creative-vast?advertiser_id=ADVERTISER_ID
(JSON créatif)
Ajoutez un nouveau contenu vidéo ou audio hébergé à l’un de vos annonceurs.
POST https://api.appnexus.com/creative-vast?publisher_id=PUBLISHER_ID
(JSON créatif)
Ajoutez un nouveau contenu vidéo ou audio hébergé à l’un de vos éditeurs.
PUT - https://api.appnexus.com/creative-vast?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
(JSON créatif)
Modifier un contenu vidéo ou audio hébergé existant.
GET https://api.appnexus.com/creative-vast Affichez tous les contenus vidéo ou audio hébergés.
GET - https://api.appnexus.com/creative-vast?advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?advertiser_code=ADVERTISER_CODE
- https://api.appnexus.com/creative-vast?publisher_id=PUBLISHER_ID
- https://api.appnexus.com/creative-vast?publisher_code=PUBLISHER_CODE
Affichez tous les contenus vidéo ou audio hébergés pour un annonceur ou un éditeur.
GET - https://api.appnexus.com/creative-vast?id=CREATIVE_ID
- https://api.appnexus.com/creative-vast?code=CREATIVE_CODE
Afficher une création spécifique.
GET https://api.appnexus.com/creative-vast?id=1,2,3 Affichez plusieurs créations par ID à l’aide d’une liste séparée par des virgules.
GET https://api.appnexus.com/creative-vast?audit_stats=true Affichez les statistiques d’audit créatives.
DELETE - https://api.appnexus.com/creative-vast?id=CREATIVE_ID& advertiser_id=ADVERTISER_ID
- https://api.appnexus.com/creative-vast?id=CREATIVE_ID&p ublisher_id=PUBLISHER_ID
Supprimer un élément créatif.

Remarque

Vous pouvez filtrer les créations en fonction du moment où elles ont été servies pour la première et la dernière fois. Cela est particulièrement utile lorsque vous approchez de votre limite d’objets et que vous devez identifier les éléments créatifs qui peuvent être supprimés du système. Pour plus d’informations, consultez Première exécution/Dernière exécution ci-dessous.

Conseil

La réponse vous indique le nombre de créations avec chaque status d’audit Xandr, Microsoft et Google. Pour connaître le format de réponse, consultez les exemples ci-dessous.

Vous ne pouvez pas supprimer un élément créatif utilisé comme création par défaut pour un membre ou un placement. Les éléments créatifs par défaut peuvent être supprimés une fois qu’ils sont dissociés d’un placement.

Champs JSON

Champ Type Description
id int ID interne associé au créatif.
- Par défaut: Nombre généré automatiquement.
- Obligatoire On :PUT, dans la chaîne de requête.
code string (100) Code personnalisé pour le créatif.
code2 string (100) Code personnalisé supplémentaire pour le créatif.
name string (100) Nom du créatif.
type enum Type de créatif. Valeurs possibles :
- "standard"
- "html"
- "video"

Remarque :Avis alpha-bêta
Ce champ ou cette fonctionnalité fait partie de la fonctionnalité actuellement en phase Alpha ou Bêta. Il est donc susceptible d’être modifié.
En lecture seule.
advertiser_id int ID de l’annonceur auquel le créateur est attaché.
Obligatoire On :POST/PUT, dans la chaîne de requête, si le créatif est attaché à un annonceur.
publisher_id int ID de l’achat de l’éditeur/média auquel le créatif est attaché.
Obligatoire On :POST/PUT, dans la chaîne de requête, si le créatif est attaché à un annonceur.
brand_id int ID de la marque de l’entreprise qui annonce le créatif. S’il est inclus, il sera vérifié par l’équipe d’audit Xandr. S’il n’est pas inclus, il est attribué par l’équipe d’audit. Pour récupérer la liste complète des marques, consultez Le service de marque.
state enum État du créatif. Valeurs possibles : "active" ou "inactive".
En lecture seule.
status objet Le status du créatif décrivant si le créatif est prêt à servir. Pour plus d’informations, consultez État ci-dessous.
click_track_result enum Résultat du test de suivi des clics, fonctionnalité disponible uniquement dans l’interface utilisateur de la console.
Valeurs possibles : "not_tested", "passed"ou "failed".
Obligatoire On :POST/PUT, dans la chaîne de requête, si le créatif est attaché à un serveur de publication.
campaigns tableau d’objets Liste des campagnes auxquelles le créatif est associé. Pour plus d’informations, consultez Campagnes ci-dessous.

Pointe: Ce champ n’est retourné que si un advertiser_id est spécifié dans la chaîne de requête.
template objet Modèle créatif (exemple : template_id 6439) pour le format et le type de média de la création. Le modèle inclut du code pour contrôler la façon dont la création s’affiche sur les pages web.
Valeurs possibles :
- Créations vidéo : 6439
- Créations audio : 38745
Obligatoire sur :POST
media_url string (1000) L’URL du créatif - peut être flash, HTML, javascript (voir format). L’URL doit exister et doit pointer vers un fichier VAST XML hébergé par CDN.
Ce champ s’applique uniquement aux créations tierces.
Par défaut:"not_tested"
media_url_secure string (1000) L’URL de l’élément créatif sécurisé (HTTPS) peut être flash, HTML, javascript (voir le format) à servir lors d’un appel publicitaire sécurisé. L’URL doit exister et doit pointer vers un fichier VAST XML hébergé par CDN.
Ce champ s’applique uniquement aux créations tierces.
click_url string (2000) URL (facultative) de la page d’accueil pour les images tierces et les créations flash.

Note: Cette valeur doit commencer par « http:// » ou « https:// »
Obligatoire On :POST, si le contenu n’est pas utilisé.
file_name string (1000) Ce champ ne s’applique pas aux créations vidéo hébergées.
audit_status enum Audit status du créatif. Valeurs possibles : "no_audit", "pending", "rejected"ou "audited".

Remarque :
- Si allow_audit a la valeur false, ce champ doit être "no_audit".
- Si une création a expiré, vous pouvez la réactiver en modifiant ce champ. Si vous la définissez sur "pending" , vous la renvoyez à des fins d’audit. Pour les modifications qui resoumettent automatiquement le créatif à des fins d’audit, consultez Modifications qui provoquent un ré-audit ci-dessous .
Obligatoire On :POST, si le modèle est pour le "image" format.
audit_feedback string L’équipe d’audit créatif peut transmettre des messages sur un créatif dans ce domaine.
En lecture seule.
allow_audit Valeur booléenne Si truela valeur est , la création est soumise à l’audit. Si falsela valeur est , le créatif n’est pas envoyé. Les créations non auditées ne peuvent s’exécuter que sur l’inventaire managé d’un réseau.

Remarque :
- Si audit_status a la valeur "no_audit", ce champ doit être "false".
- Si votre membre n’est pas encore actif, vous pouvez ajouter des éléments créatifs, mais ils ne seront pas envoyés pour audit (allow_audit auront la valeur false). Une fois que votre membre a été activé, si vous souhaitez que ces éléments créatifs soient audités, vous devez mettre à jour les éléments créatifs et définir allow_audit sur true.
Par défaut:"pending"
ssl_status enum Le status ssl (HTTPS) du créatif. Seuls les créatifs avec ssl_status = approuvé peuvent servir sur un inventaire sécurisé.

Remarque :
Si un créatif échoue à l’audit Ssl Sherlock, vous pouvez l’envoyer pour un nouveau test (une fois que vous avez corrigé le contenu non sécurisé en aval) en remplaçant ce champ "pending"par . Valeurs autorisées :
- "disabled"
- "pending"
- "approved"
- "failed"
Par défaut:"disabled"
allow_ssl_audit Valeur booléenne Si truela valeur est , le créatif est soumis à un audit sécurisé (HTTPS). Si falsela valeur est , le créatif n’est pas envoyé. Si true, media_url_secure ou content_secure est également requis.
Par défaut:"disabled"
google_audit_status enum Déconseillé. Voir adx_audit à la place.
google_audit_feedback string Déconseillé. Voir adx_audit à la place.
msft_audit_status enum Déconseillée.
msft_audit_feedback string Déconseillée.
is_self_audited Valeur booléenne Si truela valeur est , la création est auto-auditée et ne passe donc pas par l’audit de la plateforme (Xandr). Le créatif ne peut servir que sur l’inventaire qui accepte votre création auto-classifiée ou sur l’inventaire qui accepte les créatifs non audités.
Par défaut:false
is_expired Valeur booléenne Si votre création (1) n’a pas été exécutée et (2) n’a pas été modifiée dans les 45 jours, elle sera automatiquement marquée comme ayant expiré et ne sera servie sur aucun inventaire.
- Les créations expirées doivent être réinitditées pour s’exécuter sur un inventaire tiers. Pour annuler l’authentification d’un créatif pour l’inventaire tiers, définissez audit_status sur "pending".
- Les créations expirées n’ont pas besoin d’être rééditées pour s’exécuter sur un inventaire direct. Pour annuler l’exécution d’un élément créatif pour l’inventaire direct, définissez sur audit_status"no_audit".
Par défaut:false
En lecture seule.
is_prohibited Valeur booléenne Si Sherlock marque le créatif pour avoir un programme malveillant ou charger des domaines bloqués, cette valeur est définie sur true pour empêcher le contenu créatif de servir.
Par défaut:false
En lecture seule.
is_hosted Valeur booléenne Si truela valeur est , la création est hébergée par Xandr.
En lecture seule.
lifetime_budget double Le budget à vie en dollars.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:false
lifetime_budget_imps int Limite de durée de vie du nombre d’impressions.
Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
daily_budget double Le budget quotidien en dollars.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
daily_budget_imps int Limite quotidienne du nombre d’impressions.

Remarque :
Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
enable_pacing Valeur booléenne Si truela valeur est , les dépenses budgétées quotidiennes sont réparties uniformément tout au long d’une journée.

Note: Pour inclure ce champ dans une GET réponse, transmettez attributes=1 la chaîne de requête.
Par défaut:unlimited
allow_safety_pacing Valeur booléenne Si truela valeur est , les dépenses par minute sont limitées à un maximum de 1 % du budget de durée de vie et de 5 % du budget quotidien.
Administration uniquement.
profile_id int Vous pouvez attacher un ciblage tel que le sexe et la géographie à un créateur en créant un profil et en l’associant ici.
folder objet Pour organiser vos créations dans des dossiers par souci pratique (généralement dans l’interface utilisateur), vous allez créer un dossier à l’aide du service De dossiers créatifs , puis l’associer ici via l’ID de dossier ou dans le service Dossier créatif via l’ID créatif. La sortie est {"id": "41", "name": "MyFolder"}.
line_items tableau d’objets Éléments de ligne associés au créatif. Pour plus d’informations, consultez Éléments de ligne ci-dessous.
is_control Valeur booléenne Il s’agit d’un indicateur utilisé pour marquer ce créatif dans le cadre d’un groupe de contrôle/test dans les tests A/B. Pour plus d’informations, consultez Ciblage de test et de contrôle.
Par défaut:true
segments tableau Liste des segments auxquels un utilisateur sera ajouté lors de l’affichage ou du clic sur cette création. Pour plus d’informations, consultez Segments et l’exemple ci-dessous.
created_on Timestamp Date et heure de création de cette création. S’il a été créé avant janvier 2010, ce sera zéro.
En lecture seule.
last_modified Timestamp Date et heure de la dernière modification de la création.
En lecture seule.
creative_upload_status enum Déconseillée.
categories tableau d’objets Catégories qui décrivent le type de création et d’offre.

Remarque :
Pour inclure des catégories dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des catégories, consultez service de catégorie et l’exemple ci-dessous.
adservers tableau d’objets Les serveurs publicitaires qui fournissent le créatif ou sont appelés à des fins de collecte de données pendant la remise de la création.

Remarque :
Pour inclure des serveurs adserver dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des serveurs publicitaires, consultez le service Ad Server et l’exemple ci-dessous.
En lecture seule.
technical_attributes tableau d’objets Attributs qui décrivent les caractéristiques techniques du créatif, tels que "Expandable" ou "Video".

Remarque :
Pour inclure des attributs techniques dans une GET réponse, transmettez attributes=1 la chaîne de requête. Pour récupérer la liste complète des attributs techniques, consultez le service d’attributs techniques et l’exemple ci-dessous.
language objet Le langage du créatif. Pour récupérer la liste complète des langues, consultez le service de langage et l’exemple ci-dessous.
brand objet La marque de l’entreprise qui annonce le créatif et la catégorie associée à la marque. Pour plus d’informations, consultez Marque ci-dessous.
En lecture seule.
sla int Les créations définies sur 0 seront soumises pour audit avec un contrat SLA standard.

Attention: Les créations soumises avec un nombre autre que 0 entraînent un audit prioritaire (lorsqu’ils sont activés) et des frais qui en résultent.
Si vous avez un contrat de services supplémentaire avec Xandr pour les audits prioritaires, vous pouvez soumettre un élément créatif pour l’audit prioritaire (audit dans les 2 heures pendant les heures d’ouverture) en définissant ce champ sur 2. Pour plus d’informations sur l’audit prioritaire, consultez Creative Standards and Auditing.
sla_eta Timestamp Estimation de la durée d’exécution d’un audit prioritaire.
En lecture seule.
currency chaîne Code qui définit la devise principale de l’annonceur (par exemple, USD). Pour plus d’informations sur les types de devises disponibles, consultez Service monétaire.
Par défaut: Devise par défaut du membre.
En lecture seule.
first_run Timestamp Date et heure auxquelles le créatif a été servi pour la première fois, actualisé toutes les heures. Cette valeur reflète le fuseau horaire UTC. Pour inclure ces informations dans une GET réponse, transmettez flight_info=true la chaîne de requête. Pour plus d’informations sur la façon de filtrer les éléments créatifs en fonction du moment où ils sont servis pour la première fois, voir Première exécution/Dernière exécution ci-dessous.
En lecture seule.
last_run Timestamp Date et heure de la dernière exécution de la création, actualisée toutes les heures. Cette valeur reflète le fuseau horaire UTC. Pour inclure ces informations dans une GET réponse, transmettez flight_info=true la chaîne de requête. Pour plus d’informations sur la façon de créer en fonction du moment où ils ont été servis pour la dernière fois, voir Première exécution/Dernière exécution ci-dessous.
En lecture seule.
video_attribute objet Attributs pour tiers in-stream (VAST) et les créations vidéo et audio hébergées. Pour plus d’informations, consultez Attribut vidéo ci-dessous.
Par défaut: Devise par défaut du membre.
Obligatoire Sur :POST, si le modèle est pour le sous-type de média « Standard VAST ».
competitive_brands tableau d’objets Les créatifs associés aux marques de ce tableau ne serviront pas ensemble aux /mtj enchères. L’exemple classique des marques concurrentes est Coke vs Pepsi. Voir Les marques concurrentielles ci-dessous. Pour plus d’informations sur les marques de notre système, consultez service de marque.
Valeur par défaut :N/A
competitive_categories tableau d’objets Les créatifs associés aux catégories de ce tableau ne seront pas mis en /mtj vente aux enchères, par exemple, « Rencontre » et « Éducation ». Voir Catégories concurrentielles ci-dessous. Pour plus d’informations sur les catégories que nous appliquons aux créatifs (et aux marques), consultez service de catégorie.
Valeur par défaut :N/A
adx_audit objet Cet objet contient des informations sur les status et les commentaires relatifs à l’audit Google AdExchange de la création. Les informations indiquant si une création a été approuvée ou non sont retournées dans le audit_status champ.
En lecture seule.
member_id int ID du membre propriétaire du créatif.
media_assets tableau d’objets Permet d’associer des fichiers hébergés par Xandr à votre contenu créatif. Ce champ est renseigné automatiquement lors du chargement de fichiers via l’API.
Voir exemple.

Remarque :
creative_field doit toujours avoir la valeur Null pour un créatif VAST.
ad_type string Pointe:
Ce champ s’applique uniquement lorsque vous associez des éléments créatifs à des éléments de ligne augmentée.
Type de création utilisé. Valeurs possibles :
- "banner"
- "video" (inclut des créations audio)
- "native"

Cette valeur détermine la façon dont les articles aux enchères sont suivis pour la stratégie d’achat, la stratégie de paiement, les options d’optimisation, l’association créative et les options de ciblage de l’article.

Remarque :
Toutes les créations associées à un élément de ligne doivent avoir le même type d’annonce, qui doit correspondre au ad_type sélectionné dans le service d’élément de ligne - ALI.

segments Exemple

"segments":[
{"id":11111,
"action":"add_on_view"
},
{"id":22222,
"action":"add_on_click"
}
]

categories Exemple

"categories":[{"id":"13","name":"Online Games"}]

adservers Exemple

"adservers":[{"id":"1","use_type":"adserver","name":"24/7 Real Media"}]

technical_attributes Exemple

"technical_attributes":[{"id":"1","name":"Image"}]

language Exemple

"language":{"id":"1","name":"English"}

media_assets Exemple

"media_assets":[
{
"media_asset_id":22,
"creative_field":null
}
]

L’audio

Champ Type Description
click_target string La cible du click_action, qui est l’action que l’appareil doit effectuer lorsque l’utilisateur clique sur le créateur. Entrez une URL que notre équipe d’audit peut utiliser pour vérifier la marque et les attributs de votre création audio. Vérifiez que le site vers lequel pointe l’URL est dans la même langue que l’audio. Cette URL est utilisée uniquement à des fins d’audit.

Attention:
Vous devez fournir une URL pouvant être auditable pour que votre créativité réussisse l’audit.

Éléments de ligne

Chaque objet du line_items tableau inclut les champs suivants. Pour obtenir des informations pour "id" les champs ou "code" , vous pouvez utiliser le service d’élément de ligne - ALI.

Champ Type (Longueur) Description
name string Nom de l’élément de ligne.
En lecture seule.
state enum État du créatif. Valeurs possibles : "active" ou "inactive".
En lecture seule.
id int ID de l’élément de ligne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT
code chaîne Code personnalisé pour l’élément de ligne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT

Campagnes

Chaque objet du campaigns tableau inclut les champs suivants. Pour obtenir des informations sur "id" les champs ou "code" , vous pouvez utiliser le service Campaign.

Champ Type (Longueur) Description
id int ID de la campagne. ou "id""code" est requis lors de la mise à jour de l’association de campagne.
Obligatoire sur :PUT
campaign_id int ID de la campagne.
creative_id int ID du créatif.
name string Nom de la campagne.
En lecture seule.
state enum État de la campagne. Valeurs possibles : "active", "inactive"ou "parent_inactive".
En lecture seule.
code string Code personnalisé pour la campagne. ou "id""code" est requis lors de la mise à jour de l’association d’éléments de ligne.
Obligatoire sur :PUT

État

Nom Type Description
user_ready valeur booléenne La status de l’ensemble créatif par l’utilisateur qui décrit si le créatif est prêt à être utilisé ou non. Valeurs possibles : "true" ou "false".
Par défaut:true
hosted_assets_association_complete booléen/null État de la création chargée par les systèmes internes de Xandr. Valeurs possibles : "true" ou "false" pour les créations hébergées et « null » pour les créations tierces.
En lecture seule.

Marques concurrentielles

Conseil

Pour plus d’informations sur les marques, consultez Service de marque.

Nom Type Description
id int ID de la marque.
Par défaut: N/A
Obligatoire sur : N/A
name string Nom de la marque.
Par défaut: N/A
Obligatoire sur : N/A

Media-asset

media-asset l’objet inclut les champs suivants :

Nom Type Description
id int ID de la ressource multimédia.
Obligatoire sur :POST
parent_media_asset_id int ID de la ressource multimédia parente.
size_in_bytes int Taille en octets.
cdn_uploaded_on int Date à laquelle il a été chargé sur cdn.
cdn_url string URL CDN non sécurisée vers la ressource multimédia.
cdn_secure_url string URL CDN sécurisée vers la ressource multimédia.
deleted valeur booléenne Indicateur booléen qui détermine si la ressource multimédia a été supprimée ou non.
mime_type enum Type de ressource.
asset_type enum L’un des types de ressources suivants :
- html5
-Vidéo
-Audio
-Image
duration double Durée de la ressource vidéo en millisecondes.

Media_asset_status

media_asset_status l’objet inclut les champs suivants :

Nom Type Description
cdn_upload_attempt_count int Nombre de tentatives effectuées lors du chargement sur cdn.
status enum Indique l’étape de traitement de la ressource.

Modèle

template l’objet inclut les champs suivants :

Nom Type Description
id int ID du modèle créatif.
name chaîne Nom du modèle créatif.
En lecture seule.
media_subtype_id int ID du sous-type de média affecté au modèle. Vous pouvez utiliser le service De sous-type multimédia pour afficher tous les sous-types multimédias pris en charge.
En lecture seule.
format_id string Nom du format affecté au modèle. Vous pouvez utiliser creative format service pour afficher tous les formats pris en charge.
En lecture seule.

Catégories concurrentielles

Conseil

Pour plus d’informations sur les catégories, consultez service de catégorie.

Nom Type Description
id int ID de la catégorie.
Par défaut: N/A
Obligatoire sur : N/A
name chaîne Nom de la catégorie.
Par défaut: N/A
Obligatoire sur : N/A

Attribut vidéo

video_attribute est requis pour les créations audio et vidéo sur le point de creative-vast terminaison. Les ID de modèle sont les suivants :

  • 6439 - Vidéo : Standard VAST
  • 38745 - Audio : Standard VAST

L’objet video_attribute inclut les champs suivants :

Champ Type Description
is_skippable valeur booléenne Déconseillé. Xandr ajoute automatiquement un suivi de saut à toutes les créations VAST qui ont fait l’objet d’un trafic.
duration_ms double Durée, en millisecondes, de la création vidéo ou audio en flux (VAST). Cette valeur doit être supérieure à 0.
Obligatoire le :POST, PUT.
wrapper objet Wrapper de document VAST qui contient le elements tableau et le trackers tableau. Pour plus d’informations, consultez Wrapper d’attribut vidéo ci-dessous.
Obligatoire sur : Le wrapper ou l’objet inline est requis sur POST, PUT.
inline objet Document VAST inline. Pour plus d’informations, consultez Attribut vidéo inline ci-dessous.
Obligatoire sur : Le wrapper ou l’objet inline est requis sur POST, PUT.

Remarque

L’objet wrapper ou inlinepeut être spécifié dans l’appel créatif. Ces propriétés s’excluent mutuellement.

Wrapper d’attributs vidéo

L’objet wrapper contient les champs suivants :

Champ Type Description
url string URL du document VAST.
Obligatoire le :POST, PUT.
secure_url string URL sécurisée du document VAST.
elements tableau Éléments du wrapper VAST.
Obligatoire le :POST, PUT.

Élément Wrapper d’attribut vidéo

Le elements tableau contient les champs suivants :

Remarque

Au moins un élément doit être spécifié.

Champ Type Description
vast_element_type_id int ID d’élément VAST. Valeur possible :
1:Linéaire
type chaîne Type d’élément. Valeur possible : "linear"
En lecture seule.
trackers tableau Traqueurs d’événements VAST.
media_files tableau Fichiers multimédias dans le wrapper VAST.

Video Wrapper Event Tracker

Vous pouvez supprimer des pixels sur chaque événement que nous suivons dans les rapports (voir vast_event_type_id ci-dessous). Ajoutez le ou les pixels comme trackers sur le créatif. Le trackers tableau contient les champs suivants :

Champ Type Description
name string Nom du suivi d’événements.
vast_event_type_id int ID de l’événement VAST. Valeurs possibles :
- 2:Commencer
- 3: skip
- 4:Erreur
- 5: first_quartile
- 6:Milieu
- 7: third_quartile
- 8:Achèvement
- 9:Impression
- 10:Cliquez sur
url chaîne URL du suivi d’événements.
secure_url string URL sécurisée du suivi des événements.
event_type string Type d’événement correspondant à vast_event_type_id.
En lecture seule.

Fichiers multimédias du wrapper vidéo

Champ Type Description
maintain_aspect_ratio string Rapport entre les tailles d’un fichier multimédia dans différentes dimensions.
En lecture seule.
scalable string Le fichier multimédia est-il évolutif.
En lecture seule.
media_asset chaîne Les valeurs sont dérivées de l’application de chargement vidéo ou audio.
En lecture seule.

Attribut vidéo inline

Champ Type Description
ad_title string Titre de l’annonce.
Obligatoire le :POST, PUT.
ad_description string Facultatif. Description de l’annonce.
linear objet Annonce qui apparaît avant, après ou pendant une interruption de contenu.
companion_ads tableau d’objets Bannières d’accompagnement qui s’affichent dans les emplacements de bannières dans la même page que la vidéo ou l’audio qui l’accompagne (voir Objet Annonces complémentaires inline ci-dessous).

Objet linéaire inline

Champ Type Description
trackers tableau Suivis linéaires inline.
media_files tableau Fichiers multimédias linéaires inline.
skipoffset_seconds int Nombre de secondes autorisées pour la lecture de la vidéo, avant qu’elle ne puisse être ignorée. La valeur par défaut est null.

Remarque :
Ce champ ne peut être utilisé que si vous distribuez des publicités dans un placement par le même membre.

Suivis linéaires inline

Champ Type Description
vast_event_type string Type d’événement de suivi. Valeurs possibles :
- start
- skip
- error
- first_quartile
- completion
- impression
- click
Obligatoire le :POST, PUT.
name string Nom du dispositif de suivi.
url string URL du suivi d’événements linéaires inline.
Obligatoire le :POST, PUT.
secure_url string URL sécurisée du suivi d’événements linéaires inline.

Fichiers multimédias linéaires inline

Champ Type Description
maintain_aspect_ratio string Rapport entre les tailles d’un fichier multimédia dans différentes dimensions.
En lecture seule.
scalable string Le fichier multimédia est-il évolutif.
En lecture seule.
media_assets string Les valeurs sont dérivées de l’application de chargement de vidéos.
En lecture seule.

Objet Inline Companion Ads

Champ Type Description
trackers tableau d’objets Suivis d’annonces complémentaires inline.
companion_creative_id int ID de l’annonce complémentaire.

Segments

Ces champs seront inclus dans le tableau Segments :

Champ Type Description
id int ID du segment.
Obligatoire le :POST, PUT.
segment_id int ID du segment. Ce champ contient les mêmes informations que le id champ .
action enum Action effectuée par les utilisateurs qui les ajouteront au segment. Valeurs possibles : "add on view" ou "add on click".
Obligatoire le :POST, PUT.
name chaîne Nom du segment.

Marque

L’objet brand contient les champs suivants.

Conseil

Cet objet est en lecture seule. Pour définir la marque d’un créatif, utilisez le brand_id champ en dehors de cet objet.

Champ Type Description
id int ID de la marque de l’entreprise qui annonce le créatif.
En lecture seule.
name string Nom de la marque de la société qui annonce le créatif.
En lecture seule.
category_id int ID de la catégorie associée à la marque.
En lecture seule.
category_name string Nom de la catégorie associée à la marque.

Remarque :
Le category_name champ est retourné uniquement lorsque vous passez show_category_name=true la chaîne de requête de votre appel.

Première exécution/dernière exécution

Pour inclure les first_run champs et last_run dans une GET réponse, transmettez flight_info=true la chaîne de requête. Vous pouvez également filtrer les éléments créatifs en fonction du moment où ils ont été servis pour la première et la dernière fois, comme suit :

Récupérer uniquement les créations qui n’ont jamais été servies

Transmettez never_run=true la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&never_run=true'

Conseil

Vous pouvez utiliser never_run=true en combinaison avec d’autres filtres, mais notez qu’il s’agit toujours d’une relation OR. Par exemple, si vous transmettez never_run=true et min_first_run=2012-01-01 00:00:00 dans la chaîne de requête, vous recherchez des éléments créatifs qui n’ont jamais servi des éléments de ligne OR qui ont servi pour la première fois le ou après le 01-01-2012.

Récupérer uniquement les créations qui ont été servies pour la première fois à ou après une date spécifique

Transmettez min_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la première fois à ou avant une date spécifique

Transmettez max_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

Récupérer uniquement les créations d’abord servies dans une plage de dates spécifique

Transmettez min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois à ou après une date spécifique

Transmettez min_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois ou avant une date spécifique

Transmettez max_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

Récupérer uniquement les créations qui ont été servies pour la dernière fois dans une plage de dates spécifique

Transmettez min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS la chaîne de requête.

curl -b cookies -c cookies 'https://api.appnexus.com/creative-vast?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

Modifications qui provoquent un audit de nouveau

Une fois qu’un créatif a réussi l’audit Xandr (audit_status est "audited"), la modification de l’un des champs suivants entraîne la soumission du créatif pour l’audit (allow_audit est défini sur "pending").

  • media_url
  • click_url
  • language
  • categories
  • technical_attributes
  • brand_id
  • pixel_url
  • video_attribute
  • media_assets

En outre, si a la audit_status valeur "no_audit", le passage allow_audit de "false" à "true" entraîne la soumission de la création pour l’audit Xandr.

Exemples

Charger une vidéo ou une création audio

Lors du chargement d’un élément créatif pour l’hébergement avec Xandr :

Étape 1 : Charger la ressource dans le service de chargement créatif.

curl -X POST -H "Authorization: hbapi:139072:5761726637ada:nym2" --form "type=video" --form "file=@./Xandr_30_1280_720_2500k.mp4" "https://api.appnexus.com/creative-upload?member_id=123"

Le media_asset_id est retourné.

{
    "response": 
        "status": "OK",
        "count": 0,
        "start_element": 0,
        "num_elements": 0,
        "media-asset": [
            {
                "id": 54621,
                "parent_media_asset_id": null,
                "member_id": 123,
                "advertiser_id": null,
                "publisher_id": null,
                "file_name": "Xandr_30_1280_720_2500k.mp4",
                "size_in_bytes": 8358845,
                "cdn_uploaded_on": null,
                "cdn_url": null,
                "cdn_secure_url": null,
                "created_on": "2016-06-15 15:33:17",
                "last_modified": "2016-06-15 15:33:17",
                "deleted": false,
                "media_asset_status": [
                    {
                        "id": 54621,
                        "media_asset_id": 54621,
                        "error_message": null,
                        "local_path": "03/36/2e/66/03362e66-674a-41b3-9477-fcd979cdbf0b/03362e66-674a-41b3-9477-fcd979cdbf0b.mp4",
                        "cdn_upload_attempt_count": 0,
                        "created_on": "2016-06-15 15:33:17",
                        "last_modified": "2016-06-15 15:33:17",
                        "deleted": false,
                        "status": "on_shared_storage"
                    }
                ],
                "media_asset_video": null,
                "media_asset_html5": null,
                "asset_type": "video",
                "mime_type": "video/mp4",
                "duration": "32000"
            }
        ]
    }

Étape 2 :Utilisez pourmedia_asset_idcharger le créatif.

$ cat creative_video

{
    "creative-vast": {
        "name": "upload hosted video",
        "media_assets": [
            {
               "media_asset_id": 54621
            }
        ],
        "click_url": "https://appnexus.com",
        "video_attribute": {
            "inline": {
                "ad_title": "hosting test",
                "linear": {
                    "trackers": []
                }
            },
            "is_skippable": true,
            "duration_ms": "57000"
        },
        "template": {
            "id": 6439
        },
        "advertiser_id": 164979,
        "segments": null,
        "allow_audit": true,
        "is_self_audited": false,
        "sla": 0
    }
}

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": 12345678,
        "start_element": 0,
        "num_elements": 100,
        "creative-vast": {
            "name": "hosted creative video",
            "brand_id": 1,
            "media_url": "http://appnexus.com",
            "id": 12345678,
            ...
            "track_clicks": true,
            "audit_status": "pending",
            ...
            "media_url_secure": "https://appnexus.com",
            ...
            "is_hosted": true,
            ...
            "language": {
                "id": 1,
                "name": "English"
            },
            ...
            },
            "template": {
                "id": 6439,
                "name": "Standard",
                "media_subtype_id": 64,
                "format_id": 10
            },
            ...
            "video_attribute": {
               "is_skippable": true,
                "duration_ms": 57000,
                "inline": {
                    "ad_title": "hosted video creative",
                    "ad_description": null,
                    "linear": {
                        "trackers": null,
                        "media_files": null
                    }
                },
                "video_frameworks": null
            },
            "media_assets": [
                {
                    "media_asset_id": 54621
                }
            ],
            ...
            "currency": "USD",
            "type": "video"
        },
        ...
    }
}

Exemple d’objet video_attribute avec wrapper

{
    "creative-vast": {
        "id": 145,
        ...
        "template_id": 6439,
        "video_attribute": {
            "is_skippable": true,
            "duration_ms": 21000,
            "wrapper": {
                "url": "http://www.doubleclick.net/...",
                "secure_url": "https://www.doubleclick.net/...",
                "elements": [
                    {
                        "vast_element_type_id": 1,
                        "name": "linear",
                        "trackers": [
                            {
                                "name": "startTracker",
                                "vast_event_type": "impression",
                                "url": "http://tracker.com/...",
                                "secure_url": "https://tracker.com/...",
                            }
                            {
                                "name": "completionTracker",
                                "vast_event_type_id": 8,
                                "url": "http://tracker.com/...",
                                "secure_url": "https://tracker.com/...",
                                "event_type": "completion"
                            }
                        ]
                    }
                ]
            }
        }
    }
    }

Un video_attribute objet avec un exemple VAST inline

{
    "creative-vast": {
        "name": "John-Doe test",
        "member_id": 1111,
        "advertiser_id": 2474202,
        "template": {
            "id": 6439
        },
        "video_attribute": {
            "duration_ms": 10000,
            "inline": {
                "ad_title": "John-Doe test",
                "linear": {
                    "trackers": []
                }
            }
        },
        "media_assets": [
            {
                "media_asset_id": 5375731,
                "creative_field": null
            }
        ]
    }
    }