Reach Extension VAST Tag Cheat Sheet

Précédent Suivant

As an inventory owner, you must customize the VAST response from the Triton Digital ad server. You do this by replacing the macros in the VAST tag template that your reseller has provided to you.

Example VAST Tag Template

Here is an example of a VAST tag template that your reseller provides. Le contract-id, contract-secret, et placement-id parameters are only examples. The actual values from your reseller will be different.

https://resell-ad-server.example.com/resell/vast?contract-id=10001&contract-secret=1382169h-02ns-6a83-04gl-zeu158201ivq&placement-id=123456&lsid=${listenerId}&position=${position}&ip=${ip}&deviceid=${deviceId}&timestamp=${timestamp}&ua=${ua}&gdpr=${gdpr}&gpp_string=${gpp_string}&gpp_sid=${gpp_sid}&us_privacy=${us_privacy}&coppa=${coppa}&bundle-id=${bundle-id}&store-url=${store-url}&iab-v2-cat=${iab-v2-cat}&feed-type=${feed-type}&content-language=${content-language}&store-id=${store-id}&site-url=${site-url}

Example of a VAST Tag Template for a Podcast

In this example for a podcast episode, an inventory owner has further customized the URL by appending extra parameters about the podcast to the end of the template. For details, see Other Supported Parameters.

https://resell-ad-server.example.com/resell/vast?contract-id=10001&contract-secret=1382169h-02ns-6a83-04gl-zeu158201ivq&placement-id=123456&lsid=${listenerId}&position=${position}&ip=${ip}&deviceid=${deviceId}&timestamp=${timestamp}&ua=${ua}&gdpr=${gdpr}&gpp_string=${gpp_string}&gpp_sid=${gpp_sid}&us_privacy=${us_privacy}&coppa=${coppa}&bundle-id=${bundle-id}&store-url=${store-url}&iab-v2-cat=${iab-v2-cat}&feed-type=${feed-type}&content-language=${content-language}&store-id=${store-id}&site-url=${site-url}&series-title=My Series Title&episode-season=3&episode-number=4&episode-title=My Episode Title&episode-url=https%3A%2F%2Fwww.example.com%2Fpodcasts%2FPodcastName%3Fepisode%3D1&episode-duration=1800&guid=6B29FC40-CA47-1067-B31D-00DD010662DA

These extra parameters:

  • &series-title=My%20Series%20Title

  • &episode-season=3

  • &episode-number=4

  • &episode-title=My%20Episode%20Title

  • &episode-url=https%3A%2F%2Fwww.example.com%2Fpodcasts%2FPodcastName%3Fepisode%3D1

  • &episode-duration=1800

  • &guid=6B29FC40-CA47-1067-B31D-00DD010662DA

Customize a VAST Tag Template

  1. Do not modify contract-id, contract-secret, et placement-id. These parameters are required and pre-populated by Triton Digital.

  2. Replace the required position macro with preroll, midroll, ou  postroll. For example, to specify a pre-roll ad insertion, you replace ${position} par  preroll. The position parameter in your VAST request would then be position=preroll.

  3. Replace the macros of other parameters as needed. If you do not know a parameter's value, or it's not applicable, leave the macro unchanged. Example: If you do not know the language, then use content-language=${content-language}.

  4. Append other parameters, as needed. See Other Supported Parameters.

VAST Tag Parameters

Paramètre

Macro

Description

Format

placement-id

n/a

Obligatoire.

ID of the placement, historically known as the "station ID". It is the numerical ID of the station as assigned by Triton Digital.

Its value is pre-populated in the VAST template and must not be altered.

contract-id

n/a

Obligatoire.

Its value is pre-populated in the VAST template and must not be altered.

contract-secret

n/a

Obligatoire.

Its value is pre-populated in the VAST template and must not be altered.

position

${position}

Obligatoire.

The ad position.

Chaîne.

Valeurs valides : 

  • preroll

  • midroll

  • postroll

lsid

${listenerId}

Recommended. 

Important for TAP Programmatic to enrich the profile. 

Listener ID is the main user identifier for Triton Digital to use as the basis for measurements and frequency capping. For details, see Listener ID Management.

Chaîne.

Caractères alphanumériques, y compris la liste suivante de caractères spéciaux : 

_=*+.[]{}()~- 

ip

HTTP Header: X-Device-IP

${ip}

Requis pour les intégrations de serveur à serveur.

Adresse IP du lecteur/dispositif auditeur.

Pour IPv4 : format décimal en pointillé. Exemple : 192.0.2.254 

For IPv6: Colon-separated hexadecimal characters conforming to IPv6 format. Exemple : 2001:db8:0000:1111:2222:3333:4444:5555 

deviceId

${deviceId} 

Identifies the device. 

String that starts with app: followed by 10 to 40 alphanumeric characters.

Exemple : app:EBE52E703EE455AB3

timestamp

${timestamp}

Horodatage Unix en secondes. 

ua 

HTTP Header: X-Device-ua 

${ua}

User-Agent full. Corresponds to the listener ID attribute.  

Chaîne.

Exemple : Mozilla/5.0 android-user-agent 

gdpr

${gdpr}

Drapeau indiquant si le Règlement général sur la protection des données (RGPD) s'applique.

See GDPR

Chiffres entiers

Value values:

  • 0: GDPR does not apply 

  • 1: GDPR applies

gpp

HTTP Header: X-gpp 

${gpp_string}

Chaîne GPP permettant la transmission de signaux de confidentialité, de consentement et de choix du consommateur. La chaîne doit être conforme à la spécification IAB Tech Lab Global Privacy Platform.

Chaîne.

URL-safe base64-encoded GPP string. 

gpp_sid

HTTP Header: X-gpp-sid 

${gpp_sid}

Section ID to indicate which legislation is considered “in force”. 

Chiffres entiers

us_privacy 

${us_privacy}

U.S. Privacy String that signals whether the U.S. Privacy Regulations apply to the consumer, if an “explicit notice” legal disclosure has been established with a consumer, and if the consumer has chosen to opt out of the sale of their personal data. La version 1 ne prend en charge que les signaux relatifs à la CCPA (loi californienne sur la protection de la vie privée des consommateurs). La chaîne doit être conforme au format de l'U.S. Privacy String

Chaîne.

coppa 

${coppa} 

Drapeau indiquant si la réglementation Children's Online Privacy Protection Act (COPPA) s'applique. La COPPA a été établie par la U.S. Federal Trade Commission. 

0 = COPPA restrictions do not apply 

1 = COPPA restrictions apply 

bundle-id

${bundle-id}

Important for Programmatic. 

Réservé à l'inventaire pour application mobile, si nécessaire. 

L'identifiant de l'application est unique à l'application et ne dépend pas de l'app store où elle a été distribuée. 

Chaîne.

On Android and iOS, this should be a package name. Exemple : com.tritondigital.tritonradio

store-url

${store-url}

Important for Programmatic. 

Réservé à l'inventaire pour application mobile 

URL de l'App Store pour une application installée qui effectue la requête publicitaire/la connexion au flux. 

Required by programmatic buyers to verify Triton Digital is allowed to sell your inventory using the app-ads.txt framework.  

URL encoded string of a URL. 

Exemple : 

https%3A%2F%2Fexample.com%2Fstore%2Fapps%2Fdetails%3F1d%3Dcom.tritondigital.tritonradio 

iab-v2-cat

${iab-v2-cat}

Recommended for personalized audio content (e.g., music services) where genre is dynamic and based on listener's choice.

Category of the content as defined by the IAB Tech Lab Content Taxonomy. La première catégorie de la liste sera considérée comme la catégorie principale. 

Triton RefData API

Requires JWT Bearer token.

Liste de valeurs entières séparées par des virgules, chacune dans la plage 1-698.  Reportez-vous aux notes d’utilisation de la catégorie IAB.

feed-type

${feed-type}

Obligatoire pour le cas d’utilisation spécifique où l’inventaire est offert de manière programmatique et les annonces publicitaires réalisées à la demande sont insérées dans un podcast. Peut également être utilisé pour les flux en direct.

See also delivery-method

Chaîne.

Valeurs valides : 

  • podcast 

  • music 

  • radio 

  • game 

  • pureplay 

  • Replay 

  • txt2speech 

content-language

${content-language}

La langue du contenu dans lequel les publicités seront lues. Elle peut être utilisée dans le ciblage par campagne ou pour définir une règle spécifique d'échange de publicité. 

Chaîne.

Two-letter code that corresponds to ISO 639-1 language codes.

store-id

${store-id}

Important for Programmatic.

Required by programmatic buyers to verify Triton Digital is allowed to sell your inventory using the app-ads.txt framework.

Réservé à l'inventaire pour application mobile

Identificateur de l'app store pour une application installée, utilisé pour localiser l'application dans le store en question.

Chaîne.

Exemple pour iTunes : 726533955 

Exemple pour Google Play : com.tritondigital.tritonradio 

site-url

${site-url}

URL of the website where the ad will be heard. Programmatic buyers use this to identify the inventory they bid on. It is also used to verify if Triton Digital is allowed to sell your inventory using the ads.txt framework. 

If you do not replace this macro with a value, Triton Digital uses the value configured for this placement. Pour en savoir plus, consultez Vendeurs numériques autorisés (ads.txt)

URL encoded string of a URL, which must include the protocol such as http or https. 

Exemple : 

https%3A%2F%2Fwww.blork. example%2Fradio%2Fhits%2F

Other Supported Parameters

Triton Digital encourages you to inform the Inventory Owner that they can personalize the generated VAST that you share with them upon the contract creation. This ensures that the ad servers and DSP (demand side provider) can better process the ad selection and bid request on the given inventory. 

To add another parameter from this table, use this format: &parametername=value

For example to pass the maxAds parameter with a value of 5, you would append this to the VAST tag:

&maxAds=5 

Catégorie

Paramètre

Description

Format

Contenu 

maxAds

Maximum number of ads.

Value between 1 and 10 inclusively.

Auditeur 

device-language 

HTTP Header: X-Device-Accept-Language ou accept-language 

Recommandé pour les intégrations de serveur à serveur.

En-tête HTTP du lecteur/dispositif auditeur. 

Elle indique la langue configurée pour le client et la région géographique préférée. Nous sommes compatibles avec les deux : la chaîne de requête et/ou l'en-tête HTTP. 

Chaîne.

Code à deux lettres qui correspond aux codes de langue ISO-639-1

Contenu 

iab-categories-to-exclude 

Liste des catégories d'annonces NON autorisées pour l'annonce demandée. Les catégories sont définies dans la spécification DAAST de l’IAB et répertoriées avec des codes dans OpenRTB.

Bien que la spécification DAAST soit obsolète, ses catégories de publicité sont toujours utilisées régulièrement. Triton passera à la taxonomie des produits publicitaires de l’IAB une fois qu’elle aura atteint un niveau d’utilisation acceptable.

Blocking a tier-1 category does not block tier-2 under it (e.g., blocking IAB1 does not block IAB1-1 to IAB1-7). Pour bloquer le niveau 2 d'une catégorie, chaque catégorie du niveau 2 doit être bloquée individuellement. 

Liste de codes de catégorie séparés par des virgules (chaîne).

Contenu

delivery-method

Required if the content in which the ad will appear is downloaded, and ad inventory is offered to programmatic buyers.

Comment le contenu audio sera fourni à l'auditeur. Voir les remarques sur les méthodes de diffusion.

Chaîne.

Valeurs valides : 

  • streaming

  • progressive

  • download  

 

Content, podcast 

series-title

Important for Programmatic, only if it is for podcast. 

Titre de la série (contenu de podcast). 

Chaîne.

Content, podcast 

episode-season

Important for Programmatic, only if it is for podcast. 

Numéro de la saison (contenu de podcast). 

Chaîne.

Content, podcast 

episode-number

Important for Programmatic, only if it is for podcast. 

Numéro de l'épisode (contenu de podcast). 

String. Content, podcast 

Content, podcast 

episode-title

Important for Programmatic, only if it is for podcast. 

Titre de l'épisode (contenu de podcast). 

Chaîne. 

 

Content, podcast 

episode-url

Important for Programmatic, only if it is for podcast. 

URL de l'épisode (contenu de podcast). 

Encodé en URL si envoyé sous forme de chaîne de requête. 

Content, podcast 

episode-duration 

Important for Programmatic, only if it is for podcast. 

Episode duration, in seconds. 

Chiffres entiers

Content, podcast 

guid

Important for Programmatic, only if it is for podcast. 

Identifiant de l'épisode. 

String in the format of a UUID (universally unique identifier).

See RFC 9562.

Auditeur 

age

Âge de l'auditeur, selon les informations obtenues lors de l'enregistrement de l'auditeur. 

Chiffres entiers

From 1 pour 125.

Auditeur

gender

Sexe de l'auditeur, selon les informations obtenues lors de l'enregistrement de l'auditeur. 

Chaîne.

Case-sensitive.

Valeurs valides : 

  • m: male

  • f: female

  • o: other

Réglementaire 

gdpr_consent

HTTP Header: X-gdpr-consent

La chaîne de transparence et de consentement du RGPD résume les détails pertinents sur la manière dont la transparence et le consentement ont été établis. The string must comply with the IAB Transparency and Consent Framework specifications.

URL-safe base64-encoded GDPR consent string of the form

GDPR_CONSENT_XXXXX 

where XXXXX is the tracking vendor’s numeric ID where the macro is being used.

Remarques sur le mode de diffusion

Ci-dessous se trouvent les définitions des delivery-method values.

  • streaming: Endless flow of content, such as live radio. The user session ends only when the device closes the connection. Le contenu est récupéré au fur et à mesure qu’il est consommé. Cela s’applique également aux services de musique à la demande. For "live" on-demand performances, where new content is constantly added to the playlist as current content is consumed, the value of delivery-method should be empty.

  • download: Pre-recorded or finite single content, such as a podcast. The user session ends once the content is downloaded or before, if the user disconnects midway. La récupération et la consommation du contenu sont généralement indépendantes l'une de l'autre. C'est le cas quand un auditeur télécharge un podcast et l'écoute plus tard, par exemple avec l'appareil hors ligne. Ainsi, les impressions sont déclenchées par le téléchargement, et non par la consommation.

  • progressive: Also called progressive download, is for the same type of pre-recorded or finite content as the download delivery method but the content is retrieved as it is consumed. Cette règle doit être appliquée par le lecteur sur l’appareil de l’utilisateur. Il s’agit d’une implémentation client, de sorte que les implémentations côté serveur qui limitent le taux de téléchargement ne qualifient pas une session de téléchargement progressif.

GDPR

Triton Digital conforms to the General Data Protection Regulation (GDPR). Le RGPD a été établi par le Parlement européen et le Conseil de l'Union européenne.

Triton Digital is a registered and approved vendor under the Global Vendor List (GVL) TCF v2.0. maintained by the Interactive Advertising Bureau Europe (IAB Europe). L'ID du fournisseur GVL de Triton Digital est 239.