API VOD d'insertion dynamique de séries d'annonces

L'API d'insertion dynamique d'annonce vous permet de demander et de suivre les flux à la demande d'insertion dynamique d'annonce.

Service : dai.google.com

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

Méthode : create stream

Cette méthode crée un flux directement à partir de l'appareil, en renvoyant toutes les ressources nécessaires à l'application cliente pour lire et suivre les annonces, et afficher les éléments d'interface utilisateur.

Méthodes
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Créez une session VOD d'insertion dynamique de séries d'annonces.

Requête HTTP

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

Paramètres de chemin

Paramètres
network_code string

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

Corps de la requête

Le corps de la requête est de type application/json et doit contenir un objet CreateStreamRequest.

Corps de la réponse

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

Méthode : enregistrer le flux

Cette méthode enregistre un flux sur le backend Google DAI à partir de l'appareil, en renvoyant toutes les ressources nécessaires à l'application cliente pour suivre les annonces et afficher les éléments d'interface utilisateur. Contrairement à la méthode create stream, celle-ci ne renvoie pas de fichier manifeste d'annonces jouables. Cette action est plutôt effectuée dans un appel de serveur distinct : decision ad pods.

Méthodes
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Enregistre une session VOD d'insertion dynamique de séries d'annonces.

Requête HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Paramètres de chemin

Paramètres
network_code string

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

Corps de la requête

Le corps de la requête est de type application/json et doit contenir un objet StreamRegistrationRequest.

Corps de la réponse

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

Méthode : récupérer les séries d'annonces

Cette méthode fait suite à un appel register stream depuis un appareil et est nécessaire pour récupérer les manifestes d'annonces lisibles à insérer dans les manifestes de contenu.

Méthodes
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Prendre des décisions concernant les séries d'annonces pour une session VOD d'insertion dynamique de séries d'annonces

Requête HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Paramètres de chemin

Paramètres
network_code string

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

stream_id string

Identifiant stream_id reçu d'un appel stream_registration.

Corps de la requête

Le corps de la requête est de type application/json et doit contenir un objet AdPodDecisionRequest.

Corps de la réponse

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

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

Cette méthode renvoie toutes les informations nécessaires à l'application cliente pour suivre les annonces et afficher correctement les éléments d'interface utilisateur appropriés.

Méthodes
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Récupérez les métadonnées des pods d'annonces pour une session spécifique. Cette URL est renvoyée dans l'attribut StreamRegistrationResponse metadata_url.

Requête HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

Corps de la réponse

En cas de succès, le corps de la réponse contient un objet Ad pods metadata.

Objets API

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)],
  "polling_frequency": number,
}
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.
polling_frequency number

Fréquence recommandée d'interrogation de l'URL des métadonnées, en secondes. Rempli pour les flux VOD utilisant la prise de décision à la demande.

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 fichier VAST.
companions [object(Companion)]

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

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

MatchOpts

MatchOpts spécifie des exigences strictes de correspondance des contenus multimédias pour un flux.
Représentation JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Champs
audio_channels boolean

Faites correspondre les canaux audio entre le contenu et les annonces.
audio_sample_rate boolean

Assurez-vous que le taux d'échantillonnage audio est le même pour le contenu et les annonces.

CreateStreamRequest

CreateStreamRequest décrit les informations contenues dans les requêtes HTTP adressées à l'API de diffusion de pods VOD. La création du flux est initiée par le partenaire technologique vidéo (VTP, video tech partner), au nom du SDK et de l'éditeur, pour chaque utilisateur. Le flux créé génère des séries d'annonces sélectionnées que le VTP doit insérer. Cela contraste avec le flux StreamRegistrationRequest+AdPodDecisionRequest qui enregistre un flux et des adpods dans plusieurs requêtes.
Représentation JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Champs
encoding_profiles [object(EncodingProfile)]

Liste des profils d'encodage. Obligatoire.
ad_tag string

Tag d'emplacement publicitaire de base pour la prise de décision. Obligatoire.
cuepoints number

Liste des points de repère, en secondes. Obligatoire lorsque la réponse de la balise publicitaire utilise des décalages temporels positionnels.
manifest_type string

Les types de fichiers manifestes valides sont : hls et dash. Valeur par défaut : hls. (facultatif).
enable_hls_asset_list boolean

Indique si les interstitiels de la liste d'éléments HLS sont activés. Lorsqu'elle est activée, l'IAI renvoie les URL de la liste des composants pour chaque emplacement publicitaire, qui peuvent être utilisées pour les interstitiels HLS.
targeting_parameters string

Paramètres de ciblage Ad Manager supplémentaires. (facultatif).
content_duration_seconds number

ContentDurationSeconds correspond à la durée du contenu en secondes. Obligatoire lorsque la réponse de la balise d'annonce utilise des décalages temporels en pourcentage.
decision_timing_options object(DecisionTimingOptions)

Indique quand les adpods doivent être choisis.
enable_inline_manifests boolean

Indique si les fichiers manifeste de points d'arrêt doivent être intégrés à la réponse JSON.
dai_options object(CreateStreamOptions)

DAIOptions pour la création de flux.

CreateStreamOptions

CreateStreamOptions représente les options disponibles dans le workflow de création de flux en une étape.
Représentation JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Champs
dash_profile string

Profil MPEG-DASH à utiliser : "live" (en direct) ou "on-demand" (à la demande).
match_options object(MatchOpts)

data_sharing_policy_code string

Permet aux éditeurs de remplacer la règle de partage des données par défaut du réseau.
sam_id string

sam_id est la clé de débogage SAM pour la session (facultatif).
session_title string

session_title est le titre de la session SAM pour le flux (facultatif).
dash_inband_event_stream boolean

dash_inband_event_stream indique que l'insertion dynamique d'annonces insère des messages ID3 en tant qu'événements intégrés (dans le contenu multimédia) à l'aide de l'élément InbandEventStream, plutôt qu'en tant qu'éléments EventStream (dans le fichier manifeste).
distinct_ad_profiles boolean

Si la valeur est définie sur "true", cela indique que le serveur utilisera au maximum une fois tout profil d'annonce disponible lors de la mise en correspondance des profils d'encodage demandés.
tracking_mode string

tracking_mode est le type de suivi des annonces à utiliser pour le flux (facultatif). Les valeurs valides sont "ad_media", "server" et "client".
emsg_version uint32

emsg_version force l'utilisation d'une version emsg spécifique pour les ID3 dans le média. Disponible uniquement lorsque dash_inband_event_stream est défini sur "true".

StreamRegistrationRequest

StreamRegistrationRequest enregistre un flux depuis l'appareil pour la prise de décision future concernant les blocs d'annonces. Cela contraste avec une CreateStreamRequest qui crée un flux et des adpods de décision dans une seule requête.
Représentation JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Champs
targeting_parameters string

Paramètres de ciblage Ad Manager supplémentaires. (facultatif).
dai_options object(StreamRegistrationOptions)

DAIOptions pour l'enregistrement du flux.

StreamRegistrationOptions

StreamRegistrationOptions liste les options disponibles pour la création de flux.
Représentation JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Champs
sam_id string

sam_id est la clé de débogage SAM pour la session (facultatif).
tracking_mode string

tracking_mode est le type de suivi des annonces à utiliser pour le flux (facultatif). Les valeurs valides sont "ad_media", "server" et "client".
emsg_version uint32

emsg_version force l'utilisation d'une version emsg spécifique pour les ID3 dans le média. Disponible uniquement lorsque dash_inband_event_stream est défini sur "true".
skippable_ads_supported boolean

Indique si les annonces désactivables sont acceptées.

StreamRegistrationResponse

StreamRegistrationResponse représente la réponse JSON renvoyée au client en réponse à une StreamRegistrationRequest. Il inclut l'ID du flux et toutes les URL dont l'appareil aura besoin. L'ID de flux peut être référencé dans une demande de décision d'adpod ultérieure. Cela contraste avec une CreateStreamResponse qui représente une réponse pour la création d'un flux et la prise de décision concernant les adpods en même temps.
Représentation JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Champs
stream_id string

StreamID est l'identifiant unique du flux actuel de ce spectateur.
media_verification_url string

MediaVerificationURL est le préfixe d'URL à utiliser dans les demandes de validation des supports publicitaires décrites ci-dessous. Absent pour les flux de balisage côté client.
valid_for string

ValidFor correspond à la durée de validité de ce flux, au format "00h00m00s".
valid_until string

ValidUntil est la date et l'heure jusqu'à laquelle ce flux est valide.
metadata_url string

MetadataURL est l'URL des métadonnées à utiliser pour demander les métadonnées du bloc d'annonces.

DecisionTimingOptions

DecisionTimingOptions décrit les options de timing pour les blocs d'annonces de décision pour le flux.
Représentation JSON
{
  "type": string,
  "on_create_breaks": [],
}
Champs
type string

Type décrit le moment où les adpods sont choisis pour le flux. Les types valides sont les suivants : "on_create" (par défaut) et "on_demand". Lorsque le type est "on_demand", les annonces sont décidées de manière différée lorsque le fichier manifeste est demandé pour une coupure spécifique. Lorsque le type est "on_create", toutes les annonces sont sélectionnées lorsque le flux est créé.
on_create_breaks string

OnCreateBreaks est une liste de breakIDs VMAP sensibles à la casse qui doivent être décidés lors de la création du flux. Ce champ n'est autorisé que si le type est "on_demand". Les identifiants spéciaux de coupure publicitaire "preroll" et "postroll" peuvent être utilisés pour indiquer que la coupure pré-roll ou post-roll doit être décidée au moment de la création du flux.

EncodingProfile

EncodingProfile décrit l'encodage d'une seule variante de contenu. Il peut contenir uniquement des paramètres vidéo, uniquement des paramètres audio (dans le cas du type de support), à la fois des paramètres vidéo et audio, ou aucun dans le cas des sous-titres.
Représentation JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Champs
profile_name string

Nom du profil fourni par l'éditeur. Unique par flux. Obligatoire.
type string

Les types valides sont les suivants : media, iframe, subtitles. Obligatoire.
container_type string

Les types valides sont les suivants : mpeg2ts, fmp4cmaf et hls_packed_audio. Obligatoire pour les types "media" et "iframe".
video_settings object(VideoSettings)

Les paramètres vidéo sont obligatoires si le type de conteneur est "iframe". Sinon, elles ne sont présentes que si le profil contient des vidéos.
audio_settings object(AudioSettings)

Les paramètres audio sont présents si le profil contient de l'audio. Les paramètres audio ne sont autorisés que si le type de conteneur est "media".
subtitle_settings object(SubtitleSettings)

Les paramètres des sous-titres sont obligatoires pour le type de sous-titres.

VideoSettings

VideoSettings décrit la vidéo d'un profil d'encodage. Si un paramètre vidéo est présent, tous doivent l'être.
Représentation JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Champs
codec string

Chaîne de codec RFC6381 de la vidéo.
bitrate int32

Débit vidéo maximal du profil d'encodage.
frames_per_second number

Nombre d'images par seconde de la vidéo.
resolution object(Resolution)

Résolution de la vidéo (largeur x hauteur).

AudioSettings

AudioSettings décrit l'audio d'un profil d'encodage. Si un paramètre audio est présent, tous doivent l'être.
Représentation JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Champs
codec string

Chaîne de codec RFC6381 de l'audio.
bitrate int32

Débit audio maximal du profil d'encodage.
channels int32

Nombre de canaux audio (y compris les canaux basse fréquence).
sample_rate int64

Taux d'échantillonnage de l'audio, en hertz.

SubtitleSettings

SubtitleSettings décrit les sous-titres d'un profil d'encodage.
Représentation JSON
{
  "format": string,
  "language": string,
}
Champs
format string

Format des sous-titres : webvtt pour HLS, webvtt ou ttml pour DASH.
language string

Langue à insérer dans le fichier manifeste.

Solution

La résolution décrit la largeur x hauteur d'une vidéo.
Représentation JSON
{
  "width": int32,
  "height": int32,
}
Champs
width int32

Largeur de la vidéo, en pixels. Obligatoire.
height int32

Hauteur de la vidéo, en pixels. Obligatoire.

AdPodDecisionRequest

AdPodDecisionRequest représente une demande de décision concernant les séries d'annonces pour un flux précédemment enregistré.
Représentation JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Champs
encoding_profiles [object(EncodingProfile)]

Liste des profils d'encodage. Obligatoire.
ad_tag string

Tag d'emplacement publicitaire de base pour la prise de décision. Obligatoire.
cuepoints number

Liste des points de repère, en secondes. Obligatoire lorsque la réponse de la balise publicitaire utilise des décalages temporels positionnels.
manifest_type string

Les types de fichiers manifestes valides sont : hls et dash. Valeur par défaut : hls. (facultatif).
enable_hls_asset_list boolean

Indique si les interstitiels de la liste d'éléments HLS sont activés. Lorsqu'elle est activée, l'IAI renvoie les URL de la liste des composants pour chaque emplacement publicitaire, qui peuvent être utilisées pour les interstitiels HLS.
targeting_parameters string

Paramètres de ciblage Ad Manager supplémentaires. (facultatif).
content_duration_seconds number

ContentDurationSeconds correspond à la durée du contenu en secondes. Obligatoire lorsque la réponse de la balise d'annonce utilise des décalages temporels en pourcentage.
decision_timing_options object(DecisionTimingOptions)

Indique quand les adpods doivent être choisis.
enable_inline_manifests boolean

Indique si les fichiers manifeste de points d'arrêt doivent être intégrés à la réponse JSON.
dai_options object(AdPodDecisionOptions)

DAIOptions pour la décision concernant la série d'annonces.

AdPodDecisionResponse

AdPodDecisionResponse représente une réponse aux séries d'annonces de décision pour un flux précédemment enregistré. Il contient la liste des séries d'annonces décidées pour ce flux.
Représentation JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Champs
valid_for string

ValidFor correspond à la durée de validité de ce flux, au format "00h00m00s".
valid_until string

ValidUntil est la date et l'heure jusqu'à laquelle ce flux est valide.
ad_pods [object(AdPod)]

Liste de séries d'annonces classées par ordre d'insertion.

CreateStreamResponse

CreateStreamResponse représente la réponse JSON renvoyée au client en réponse à une CreateStreamRequest.
Représentation JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Champs
valid_for string

ValidFor correspond à la durée de validité de ce flux, au format "00h00m00s".
valid_until string

ValidUntil est la date et l'heure jusqu'à laquelle ce flux est valide.
ad_pods [object(AdPod)]

Liste de séries d'annonces classées par ordre d'insertion.
stream_id string

StreamID est l'identifiant unique du flux actuel de ce spectateur.
media_verification_url string

MediaVerificationURL est le préfixe d'URL à utiliser dans les demandes de validation des supports publicitaires décrites ci-dessous. Absent pour les flux de balisage côté client.
pod_metadata object(PodMetadata)

PodMetadata contient les informations supplémentaires requises pour afficher le pod sur l'appareil et déclencher la validation. Comme décrit dans la documentation de l'API Linear d'insertion dynamique d'annonces. Inclus uniquement pour les flux de balisage côté client.
metadata_url string

MetadataURL est l'URL des métadonnées à utiliser pour demander les métadonnées du bloc d'annonces.

AdPod

AdPod représente une coupure publicitaire sélectionnée et prête à être lue.
Représentation JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Champs
manifest_uris string

ManifestURIs est une carte du nom du profil d'encodage vers les manifest_uris de la variante HLS pour le contenu HLS.
multivariant_uri string

MultivariantURI est l'URI du fichier manifeste multivariant pour le contenu HLS.
mpd_uri string

MPDURI est l'URI du fichier MPD pour le contenu DASH.
manifests string

Manifests est une carte du nom du profil d'encodage au fichier manifeste de variante HLS. Renseigné uniquement si le flux a la valeur "true" pour enable_inline_manifests.
multivariant_manifest string

MultivariantManifest est le fichier manifeste multivariant pour le contenu HLS. Renseigné uniquement si le flux a la valeur "true" pour enable_inline_manifests.
mpd_manifest string

MPDManifest est le fichier manifeste MPD pour le contenu DASH. Renseigné uniquement si le flux a la valeur "true" pour enable_inline_manifests.
asset_list_uri string

AssetListURI est l'URI de la liste d'assets d'interstitiels HLS pour le contenu HLS. Renseigné uniquement si les interstitiels de liste d'éléments HLS sont activés pour le flux.
start number

Heure de début de la série d'annonces dans la timeline de l'asset (sans inclure les séries d'annonces précédentes) en secondes flottantes.
duration number

Durée de la série d'annonces en secondes (nombre à virgule flottante).
type string

Type de coupure publicitaire.
midroll_index number

Index des mid-rolls dans un flux (basé sur l'ID de coupure VMAP). Omis pour les pré-rolls et les post-rolls.

AdPodDecisionOptions

AdPodDecisionOptions représente des options supplémentaires pour le flux.
Représentation JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Champs
dash_profile string

Profil MPEG-DASH à utiliser : "live" (en direct) ou "on-demand" (à la demande).
match_options object(MatchOpts)

data_sharing_policy_code string

Permet aux éditeurs de remplacer la règle de partage des données par défaut du réseau.
sam_id string

sam_id est la clé de débogage SAM pour la session (facultatif).
session_title string

session_title est le titre de la session SAM pour le flux (facultatif).
dash_inband_event_stream boolean

dash_inband_event_stream indique que l'insertion dynamique d'annonces insère des messages ID3 en tant qu'événements intégrés (dans le contenu multimédia) à l'aide de l'élément InbandEventStream, plutôt qu'en tant qu'éléments EventStream (dans le fichier manifeste).
distinct_ad_profiles boolean

Si la valeur est définie sur "true", cela indique que le serveur utilisera au maximum une fois tout profil d'annonce disponible lors de la mise en correspondance des profils d'encodage demandés.

Flux

Le flux est utilisé pour afficher la liste de toutes les ressources d'un flux nouvellement créé au format JSON .
Représentation JSON
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Champs
stream_id string

Identifiant du flux.
valid_for string

Durée de validité du flux, au format "00h00m00s".
valid_until string

Date jusqu'à laquelle le flux est valide, au format RFC 3339.
media_verification_url string

URL de validation du contenu multimédia.

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 ce companion en pixels.
resource string

Pour les bannières associées 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 création associée. Elle peut être statique, iframe ou HTML.
ad_slot_id string

ID de l'emplacement de ce composant.
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.