API active de diffusion de séries d'annonces pour l'insertion dynamique d'annonces

L'API d'insertion dynamique d'annonces vous permet de demander et de suivre les diffusions en direct avec insertion dynamique d'annonces.

Service : dai.google.com

Tous les URI sont relatifs à https://dai.google.com.

Méthode : stream

Méthodes
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Enregistre une session de diffusion en direct avec insertion dynamique de séries d'annonces.

Requête HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.

custom_asset_key string

Identifiant personnalisé associé à cet événement dans Google Ad Manager.

Corps de la requête

Le corps de la requête est de type application/x-www-form-urlencoded et contient les paramètres suivants :

Paramètres
Paramètres de ciblage DFP Facultatif Paramètres de ciblage supplémentaires.
Remplacer les paramètres de flux Facultatif Remplacez les valeurs par défaut d'un paramètre de création de flux.
Authentification HMAC Facultatif S'authentifier à l'aide d'un jeton HMAC.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient un nouvel objet Stream.

Open Measurement

L'API DAI contient des informations pour la validation Open Measurement dans le champ Verifications. Ce champ contient un ou plusieurs éléments Verification qui listent les ressources et les métadonnées nécessaires à l'exécution du code de mesure tiers afin de vérifier la lecture de la création. Seule la fonctionnalité JavaScriptResource est prise en charge. Pour en savoir plus, consultez l'IAB Tech Lab et la spécification VAST 4.1.

Méthode : segment de série d'annonces

Méthodes
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Crée un flux d'insertion dynamique d'annonces pour l'ID d'événement donné.

Requête HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.

custom_asset_key string

Identifiant personnalisé associé à cet événement dans Google Ad Manager.

pod_identifier

Les formats suivants sont acceptés :

pod/{integer}

Identifiant numérique de la coupure publicitaire actuelle. Les ID de groupe d'annonces sont attribués de manière incrémentielle pour chaque événement de coupure publicitaire, en commençant par 1.

ad_break_id/{string}

Identifiant de chaîne pour la coupure publicitaire actuelle. Un ID de coupure publicitaire fourni par l'éditeur n'est pas soumis aux mêmes contraintes qu'un ID de série d'annonces. Tout ID de coupure publicitaire inconnu fourni à ce point de terminaison crée une coupure publicitaire pour l'événement en direct.

profile_name string

Le nom du profil d'encodage Google Ad Manager DAI demandé. Le profil d'encodage doit être l'un des profils d'encodage configurés pour l'événement sélectionné.

segment_number integer

Index du segment demandé dans la série d'annonces actuelle, en commençant par zéro.
segment_format string

Extension de fichier associée au format de segment demandé. Les extensions acceptées sont les suivantes : ts, mp4, vtt, aac, ac3 ou eac3.

Paramètres de requête

Paramètres
stream_id required string

ID du flux pour la session de l'utilisateur actuel. Cette valeur est renvoyée par une requête réussie au point de terminaison stream.
sd required1 integer

Durée du segment demandé, en millisecondes.
so facultatif

Décalage du segment demandé dans la série d'annonces, en millisecondes. Si vous omettez le paramètre so, il sera calculé en multipliant la durée du segment par le numéro du segment.
pd obligatoire2 integer

Durée de la série d'annonces, en millisecondes.
auth-token required string

Jeton HMAC signé et encodé au format URL pour le bloc d'annonces actuel.
last facultatif boolean

Indique le dernier segment de la coupure publicitaire. Omettez ce paramètre pour tous les autres segments.
scte35 facultatif string

Signal SCTE-35 encodé en base64 pour cette coupure publicitaire.
cust_params facultatif string

Ensemble de paires clé-valeur utilisées pour le ciblage des campagnes Ad Manager. Ces paires doivent être représentées sous forme de chaîne de requête encodée en URL.

Exemple :
Paramètres
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Notes de bas de page

  1. sd n'est pas requis pour les segments d'initialisation. ↩
  2. pd n'est pas obligatoire pour les événements dont les pauses publicitaires sans durée sont activées. ↩

Exemple

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

Corps de la réponse

Si la requête aboutit, le corps de la réponse sera un segment de flux lisible correspondant au format et aux paramètres spécifiés dans la requête.

Méthode : fichier manifeste HLS pour les séries d'annonces

Récupère un fichier manifeste de bloc d'annonces HLS d'une diffusion en direct prêt à être chargé et lu par un lecteur vidéo client.

Méthodes
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API permettant de récupérer une playlist multivariantes HLS pour une série d'annonces.

Requête HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.
custom_asset_key string

Identifiant personnalisé associé à cet événement dans Google Ad Manager
pod_identifier

Les formats suivants sont acceptés :

pod/{integer}

Identifiant numérique de la coupure publicitaire actuelle. Les ID de groupe d'annonces sont attribués de manière incrémentielle pour chaque événement de coupure publicitaire, en commençant par 1.

ad_break_id/{string}

Identifiant de chaîne pour la coupure publicitaire actuelle. Un ID de coupure publicitaire fourni par l'éditeur n'est pas soumis aux mêmes contraintes qu'un ID de série d'annonces. Tout ID de coupure publicitaire inconnu fourni à ce point de terminaison crée une coupure publicitaire pour l'événement en direct.

Paramètres de requête

Paramètres
stream_id Obligatoire string

ID du flux pour la session de l'utilisateur actuel. Cette valeur est renvoyée par une requête réussie au point de terminaison stream.
pd Obligatoire integer

Durée de la série d'annonces, en millisecondes.
scte35 facultatif string

Signal SCTE-35 encodé en base64 pour cette coupure publicitaire.
cust_params facultatif string

Ensemble de paires clé-valeur utilisées pour le ciblage des campagnes Ad Manager. Ces paires doivent être représentées sous forme de chaîne de requête encodée en URL.

Exemple :
Paramètres
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Corps de la réponse

Si la requête aboutit, le corps de la réponse est une playlist HLS multivariante.

Méthode : fichier manifeste de série d'annonces DASH

Récupère un fichier manifeste de série d'annonces MPEG-DASH d'une diffusion en direct prêt à être chargé et lu par un lecteur vidéo client.

Méthodes
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API permettant de récupérer une playlist MPEG-DASH MPD pour une série d'annonces.

Requête HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.
custom_asset_key string

Identifiant personnalisé associé à cet événement dans Google Ad Manager
stream_id string

ID du flux pour la session de l'utilisateur actuel. Cette valeur est renvoyée par une requête réussie au point de terminaison stream.
pod_id integer

Identifiant numérique de la coupure publicitaire actuelle. Les ID de groupe d'annonces sont attribués de manière incrémentielle pour chaque événement de coupure publicitaire, en commençant par 1.

Paramètres de requête

Paramètres
pd Obligatoire integer

Durée de la série d'annonces, en millisecondes.
scte35 facultatif string

Signal SCTE-35 encodé en base64 pour cette coupure publicitaire.
cust_params facultatif string

Ensemble de paires clé-valeur utilisées pour le ciblage des campagnes Ad Manager. Ces paires doivent être représentées sous forme de chaîne de requête encodée en URL.

Exemple :
Paramètres
  • section = sports
  • page = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Corps de la réponse

Si la requête aboutit, le corps de la réponse est une playlist MPEG-DASH mpd.

Méthode : modèle de période de pod DASH

Méthodes
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Demande un modèle de période DASH à Google Ad Manager. Ce modèle contient des macros que vous devez remplir avec les paramètres de votre flux. Une fois ces macros renseignées, le modèle devient votre période d'insertion publicitaire et peut être inséré dans votre fichier manifeste DASH.

Requête HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.

custom_asset_key string

Identifiant personnalisé associé à cet événement dans Google Ad Manager.

Paramètres de requête

Paramètres
stream_id required string

ID du flux pour la session de l'utilisateur actuel. Cette valeur est renvoyée par une requête réussie au point de terminaison stream.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient un nouvel objet PodTemplateResponse.

Méthode : métadonnées de timing des séries d'annonces

Méthodes
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Récupère les métadonnées de timing du bloc d'annonces.

Requête HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Paramètres de chemin

Paramètres
network_code string

Code de réseau Google Ad Manager de l'éditeur.

custom_asset_key string

Identifiant personnalisé associé à cette diffusion en direct dans Google Ad Manager.

Paramètres de requête

Paramètres
stream_id Obligatoire string

ID de flux Ad Manager provenant de l'application de lecteur vidéo client.
ad_break_id required string

ID de la prochaine coupure publicitaire.

Les ID de coupure publicitaire sont fournis par le serveur Stitching ou le VTP. Ils doivent correspondre dans les notifications anticipées de coupure publicitaire, les demandes de métadonnées de timing de série d'annonces et les demandes de redirection de segment pour la même coupure publicitaire.

Les restrictions suivantes s'appliquent aux ID de points d'insertion publicitaire personnalisés :

  • Doit comporter entre 1 et 63 caractères
  • Ne doit contenir que des lettres minuscules, des chiffres et des traits d'union.
  • L'ID de coupure publicitaire preroll est réservé à la récupération de la série d'annonces pré-roll. Il ne peut pas être utilisé pour identifier un autre bloc d'annonces.
auth-token required string

Le auth-token se compose d'un jeton HMAC avec les paramètres suivants :

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout facultatif integer

Nombre de millisecondes pendant lesquelles l'insertion dynamique d'annonces peut bloquer cette requête pour attendre la décision concernant les annonces. Utilisez ce paramètre pour les demandes qui doivent renvoyer des annonces remplies lors de la première demande, comme les pauses publicitaires pré-roll.

Si le délai d'inactivité est dépassé, la requête renvoie l'état "En attente".

Si elle est incluse, la valeur du délai avant expiration doit être comprise entre 1 000 et 15 000 millisecondes. Si cette valeur est omise, les réponses ne sont pas retardées pour attendre la décision publicitaire.
final facultatif boolean

Définissez la valeur sur true pour indiquer à l'insertion dynamique d'annonces qu'il s'agit de la dernière requête que le VTP est prêt à envoyer pour cette série d'annonces. Si aucune décision publicitaire n'est disponible avant la fin du délai d'attente facultatif, DAI renvoie une ardoise de façon permanente pour cette demande.

La valeur par défaut est false.

Paramètres de décision publicitaire
pd facultatif integer

Durée de la coupure publicitaire (en millisecondes). Également appelée durée du bloc d'annonces.

Si vous utilisez EABN, la valeur pd doit correspondre à la durée indiquée dans votre notification de coupure publicitaire. Si les durées ne correspondent pas, la valeur EABN sera prioritaire.

cust_params facultatif string

Paramètres personnalisés pour le ciblage des pauses publicitaires, comme décrit dans le Centre d'aide Ad Manager.
scte35 facultatif string

Signal SCTE-35 encodé en base64.

Si le signal n'est pas valide, un message sera envoyé dans l'en-tête HTTP X-Ad-Manager-Dai-Warning de la réponse et la requête sera envoyée sans la valeur scte35 non valide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient un nouvel objet AdPodTimingMetadataResponse.

Méthode : validation des médias

Après avoir rencontré un identifiant de contenu multimédia d'annonce pendant la lecture, envoyez immédiatement une requête à l'aide de l'media_verification_url obtenue à partir du point de terminaison stream ci-dessus. Ces requêtes ne sont pas nécessaires pour les flux de balisage côté serveur, où le serveur lance la vérification du contenu multimédia.

Les requêtes adressées au point de terminaison media verification sont idempotentes.

Méthodes
media verification GET /{media_verification_url}/{ad_media_id}

Avertit l'API d'un événement de validation de contenu multimédia.

Requête HTTP

GET https://{media-verification-url}/{ad-media-id}

Corps de la réponse

media verification renvoie les réponses suivantes :

  • HTTP/1.1 204 No Content si la validation du contenu multimédia réussit et que tous les pings sont envoyés.
  • HTTP/1.1 404 Not Found si la demande ne peut pas valider le média en raison d'un format d'URL incorrect ou d'une expiration.
  • HTTP/1.1 404 Not Found si une demande de validation précédente pour cet ID a abouti.
  • HTTP/1.1 409 Conflict si une autre requête envoie déjà des pings à ce moment-là.

ID des éléments multimédias des annonces

Les identifiants des supports publicitaires seront encodés dans une piste de métadonnées distincte : métadonnées temporelles pour le flux de transport HLS ou emsg pour les fichiers MP4. Les identifiants de contenu publicitaire commenceront toujours par la chaîne google_.

L'intégralité du contenu textuel de l'entrée de métadonnées doit être ajoutée à l'URL de validation de l'annonce avant chaque demande de validation.

Méthode : metadata

Le point de terminaison des métadonnées à l'adresse metadata_url renvoie des informations utilisées pour créer une UI d'annonce. Le point de terminaison des métadonnées n'est pas disponible pour les flux de balises côté serveur, où le serveur est responsable du lancement de la vérification du support publicitaire.

Méthodes
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Récupère les informations sur les métadonnées des annonces.

Requête HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Corps de la réponse

Si la requête aboutit, la réponse renvoie une instance de PodMetadata.

Analyser les métadonnées

Les métadonnées comportent trois sections distinctes : tags, ads et breaks. Le point d'entrée dans les données est la section tags. À partir de là, parcourez les tags et recherchez la première entrée dont le nom est un préfixe de l'ID du contenu multimédia de l'annonce trouvé dans le flux vidéo. Par exemple, vous pouvez avoir un ID de support publicitaire qui ressemble à ceci :

google_1234567890

Vous trouverez ensuite un objet tag nommé google_12345. Dans ce cas, il correspond à l'ID du support publicitaire. Une fois que vous avez trouvé l'objet de préfixe de média d'annonce approprié, vous pouvez rechercher les ID d'annonce, les ID de coupure publicitaire et le type d'événement. Les ID d'annonces sont ensuite utilisés pour indexer les objets ads et les ID d'encarts publicitaires pour indexer les objets breaks.

Données de réponse

Flux

Stream permet d'afficher une liste de ressources pour un flux nouvellement créé au format JSON.
Représentation JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Champs
stream_id string

Identifiant de flux GAM.
media_verification_url string

URL de validation du contenu multimédia utilisée comme point de terminaison de base pour le suivi des événements de lecture.
metadata_url string

URL des métadonnées utilisée pour interroger périodiquement des informations sur les prochains événements publicitaires du flux.
session_update_url string

URL de mise à jour de la session utilisée pour mettre à jour les paramètres de ciblage de ce flux. Les valeurs d'origine des paramètres de ciblage sont capturées lors de la requête initiale de création du flux.
heartbeat_url string

L'URL de battement de cœur, utilisée pour maintenir le flux de balisage côté serveur actif, doit être pingée toutes les {PollingFrequency} secondes. Renseigné pour les flux de balisage côté serveur.
polling_frequency number

Fréquence de sondage, en secondes, lors de la demande de metadata_url ou heartbeat_url.
pod_manifest_url string

Le modèle d'URL du fichier manifeste de la série d'annonces est utilisé pour générer l'URL permettant de récupérer le fichier manifeste de la série d'annonces d'un flux, correspondant à l'URL de la playlist multivariante dans HLS ou du fichier MPD dans DASH. Renseigné pour les événements de diffusion en direct de type d'insertion dynamique d'annonces POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Le format du fichier manifeste est celui du fichier manifeste récupéré à partir de pod_manifest_url, qu'il s'agisse de dash ou de hls.

PodMetadata

PodMetadata contient des informations de métadonnées sur les annonces, les pauses publicitaires et les tags d'ID de contenu multimédia.
Représentation JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
Champs
tags map[string, object(TagSegment)]

Carte des segments de balise indexés par préfixe de balise.
ads map[string, object(Ad)]

Carte des annonces indexées par ID d'annonce.
ad_breaks map[string, object(AdBreak)]

Carte des coupures publicitaires indexées par ID de coupure publicitaire.

TagSegment

TagSegment contient une référence à une annonce, à sa coupure publicitaire et à son type d'événement. TagSegment avec type="progress" ne doit pas être envoyé au point de terminaison de validation du média publicitaire.
Représentation JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Champs
ad string

ID de l'annonce de ce tag.
ad_break_id string

ID de la coupure publicitaire de ce tag.
type string

Type d'événement de ce tag.

AdBreak

AdBreak décrit une seule coupure publicitaire dans le flux. Il contient une durée, un type (mid/pre/post) et le nombre d'annonces.
Représentation JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Champs
type string

Les types de pauses valides sont "pre", "mid" et "post".
duration number

Durée totale des annonces pour cette coupure publicitaire, en secondes.
expected_duration number

Durée attendue de la coupure publicitaire (en secondes), y compris toutes les annonces et le slate.
ads number

Nombre d'annonces dans la coupure publicitaire.
"Annonce" décrit une annonce dans le flux.
Représentation JSON
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Champs
ad_break_id string

ID de la coupure publicitaire de cette annonce.
position number

Position de cette annonce dans la coupure publicitaire, en commençant par 1.
duration number

Durée de l'annonce, en secondes.
title string

Titre facultatif de l'annonce.
description string

Description facultative de l'annonce.
advertiser string

Identifiant d'annonceur facultatif.
ad_system string

Système publicitaire facultatif.
ad_id string

Identifiant d'annonce facultatif.
creative_id string

ID de la création (facultatif).
creative_ad_id string

ID de création facultatif.
deal_id string

ID d'accord facultatif.
clickthrough_url string

URL de destination facultative.
click_tracking_urls string

URL de suivi des clics facultatives.
verifications [object(Verification)]

Entrées de vérification Open Measurement facultatives qui listent les ressources et les métadonnées requises pour exécuter le code de mesure tiers afin de vérifier la lecture de la création.
slate boolean

Booléen facultatif indiquant que l'entrée actuelle est une ardoise.
icons [object(Icon)]

Liste d'icônes, omise si elle est vide.
wrappers [object(Wrapper)]

Liste des wrappers, omise si elle est vide.
universal_ad_id object(UniversalAdID)

Identifiant d'annonce universel facultatif.
extensions string

Liste facultative de tous les nœuds <Extension> dans le VAST.
companions [object(Companion)]

Éléments associés facultatifs pouvant être affichés avec cette annonce.
interactive_file object(InteractiveFile)

Création interactive facultative (SIMID) à afficher pendant la lecture de l'annonce.

PodTemplateResponse

PodTemplateResponse représente la charge utile JSON renvoyée à un VTP pour l'assemblage de pods.
Représentation JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Champs
dash_period_template string

DashPeriodTemplate est le modèle XML pour la période à remplir avec les données appropriées avant l'assemblage.
segment_duration_ms int64

SegmentDurationMS correspond à la durée des segments de période en millisecondes.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse contient des informations sur l'emplacement publicitaire et sur la façon de créer des URL de segments pour celui-ci.
Représentation JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Champs
status string

État de la décision pour la série d'annonces.
ads [object(AdRendering)]

Tableau d'objets Ad décrivant comment afficher les URL des segments d'annonces, indexé à partir de 0.
slate object(SlateRendering)

Slate décrivant comment afficher les URL des segments de slate.
dash_representations map[string, object(DASHRepresentation)]

Liste des représentations DASH pour que cette série d'annonces soit affichée dans les fichiers manifestes DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Liste des ensembles d'adaptation DASH pour que cette série d'annonces soit affichée dans les fichiers manifestes DASH.

AdRendering

AdRendering décrit comment afficher une annonce pour laquelle une décision a été prise.
Représentation JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Champs
duration_ms number

Durée de l'annonce, en millisecondes (int).
variants map[string, object(VariantRendering)]

Dictionnaire des objets Variant (voir ci-dessous), indexé par l'ID de variante/profil, tel qu'il est configuré dans l'UI.

SlateRendering

SlateRendering décrit comment afficher le contenu Slate.
Représentation JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Champs
duration_ms number

Durée de la vidéo de présentation, en millisecondes (int).
variants map[string, object(VariantRendering)]

Dictionnaire des objets Variant, indexé par ID de variante/profil. Les ardoises doivent être mises en boucle jusqu'à ce que la durée requise soit atteinte, en insérant des discontinuités HLS entre les itérations ou en bouclant de nouvelles périodes pour MPEG-DASH.

VariantRendering

VariantRendering décrit une variante/un profil dans l'annonce/la slate.
Représentation JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Champs
segment_extension string

String, one of: ts, mp4, aac, ac3, ec3, m4a, m4v. Extension du nom de fichier faisant partie des URL de segment.
segment_durations object(SegmentDurations)

SegmentDurations. La durée de chaque segment peut être traduite en URL de segment.

SegmentDurations

SegmentDurations décrit la durée d'une séquence de segments, dans une unité de temps spécifiée.
Représentation JSON
{
  "timescale": number,
  "values": [],
}
Champs
timescale number

Timescale est le nombre d'unités par seconde (int) Doit être : 1000 pour HLS (millisecondes) 90000 pour la vidéo DASH (PTS) Fréquence d'échantillonnage audio pour l'audio DASH.
values number

Tableau des durées de segment int, en unités de durée.

DASHRepresentation

DASHRepresentation décrit les nœuds de représentation à afficher dans les fichiers manifestes DASH.
Représentation JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Champs
codecs string

Codecs de la représentation.
bandwidth number

Bande passante de la représentation.
width number

Largeur de la représentation.
height number

Hauteur de la représentation.
frame_rate string

Fréquence d'images de la représentation.
audio_sampling_rate number

Taux d'échantillonnage audio de la représentation.
audio_channel_config object(SchemeIDURIAndValue)

Configuration du canal audio de la représentation.

DASHAdaptationSet

DASHAdaptationSet décrit les nœuds AdaptationSet à afficher dans les fichiers manifeste DASH.
Représentation JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Champs
content_type string

Type de contenu de l'ensemble d'adaptation.
mime_type string

Type MIME de l'ensemble d'adaptation.
role object(SchemeIDURIAndValue)

Rôle de l'ensemble d'adaptation.
inband_event_stream object(SchemeIDURIAndValue)

Flux d'événements intégré de l'ensemble d'adaptation.
min_frame_rate string

Fréquence d'images minimale de l'ensemble d'adaptation.
max_frame_rate string

Fréquence d'images maximale de l'ensemble d'adaptation.
scan_type string

Type d'analyse de l'ensemble d'adaptation.
start_with_sap string

Commencez par SAP de l'ensemble d'adaptation.
segment_alignment boolean

Alignement des segments de l'ensemble d'adaptation.
representations string

Représentations de l'ensemble d'adaptation.

SchemeIDURIAndValue

SchemeIDURIAndValue est une paire composée d'un ID de schéma et de sa valeur.
Représentation JSON
{
  "scheme_id_uri": string,
  "value": string,
}
Champs
scheme_id_uri string

URI de l'ID du schéma de la valeur.
value string

Valeur de l'URI de l'ID du schéma.

Icône

Icon contient des informations sur une icône VAST.
Représentation JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Champs
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData contient des informations sur le clic sur une icône.
Représentation JSON
{
  "url": string,
}
Champs
url string

FallbackImage

FallbackImage contient des informations sur une image de remplacement VAST.
Représentation JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Champs
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Le wrapper contient des informations sur une annonce wrapper. Il n'inclut pas d'ID de transaction s'il n'existe pas.
Représentation JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Champs
system string

Identifiant du système publicitaire.
ad_id string

ID de l'annonce utilisée pour l'annonce wrapper.
creative_id string

ID de la création utilisée pour l'annonce wrapper.
creative_ad_id string

ID de l'annonce de création utilisé pour l'annonce wrapper.
deal_id string

ID de l'accord facultatif pour l'annonce wrapper.

Validation

La validation contient des informations pour Open Measurement, qui facilite la mesure de la visibilité et de la validation tierces. Actuellement, seuls les ressources JavaScript sont acceptées. Consultez https://iabtechlab.com/standards/open-measurement-sdk/.
Représentation JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Champs
vendor string

Fournisseur de services de vérification.
java_script_resources [object(JavaScriptResource)]

Liste des ressources JavaScript pour la validation.
tracking_events [object(TrackingEvent)]

Liste des événements de suivi pour la validation.
parameters string

Chaîne opaque transmise au code de validation du bootstrap.

JavaScriptResource

JavaScriptResource contient des informations pour la validation via JavaScript.
Représentation JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Champs
script_url string

URI de la charge utile JavaScript.
api_framework string

APIFramework est le nom du framework vidéo qui exécute le code de validation.
browser_optional boolean

Indique si ce script peut être exécuté en dehors d'un navigateur.

TrackingEvent

TrackingEvent contient des URL que le client doit pinguer dans certaines situations.
Représentation JSON
{
  "event": string,
  "uri": string,
}
Champs
event string

Type d'événement de suivi.
uri string

Événement de suivi à pinguer.

UniversalAdID

L'UniversalAdID permet de fournir un identifiant unique pour la création, qui est conservé dans tous les systèmes publicitaires.
Représentation JSON
{
  "id_value": string,
  "id_registry": string,
}
Champs
id_value string

Identifiant d'annonce universel de la création sélectionnée pour l'annonce.
id_registry string

Chaîne utilisée pour identifier l'URL du site Web du registre où l'ID universel de l'annonce de la création sélectionnée est catalogué.

Annonce associée

Companion contient des informations sur les annonces associées qui peuvent être diffusées avec l'annonce.
Représentation JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Champs
click_data object(ClickData)

Données sur les clics pour cette création associée.
creative_type string

Attribut CreativeType sur le nœud <StaticResource> dans VAST si c'est un companion de type statique.
height int32

Hauteur de ce companion en pixels.
width int32

Largeur de la bannière associée en pixels.
resource string

Pour les composants statiques et iFrame, il s'agit de l'URL à charger et à afficher. Pour les annonces associées HTML, il s'agit de l'extrait de code HTML à afficher en tant qu'annonce associée.
type string

Type de cette création associée. Elle peut être statique, iframe ou HTML.
ad_slot_id string

ID de l'emplacement de ce complément.
api_framework string

Framework d'API pour ce compagnon.
tracking_events [object(TrackingEvent)]

Liste des événements de suivi pour ce complément.

InteractiveFile

InteractiveFile contient des informations sur la création interactive (c'est-à-dire SIMID) qui doivent être affichées pendant la lecture de l'annonce.
Représentation JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Champs
resource string

URL de la création interactive.
type string

Type MIME du fichier fourni en tant que ressource.
variable_duration boolean

Indique si cette création peut demander à ce que sa durée soit prolongée.
ad_parameters string

Valeur du nœud <AdParameters> dans VAST.