API Dynamic Ad Insertion VOD

L'API Dynamic Ad Insertion vous permet de demander et de suivre les flux de vidéo à la demande (VOD) avec insertion dynamique d'annonces. Les flux HLS et DASH sont acceptés.

Service : dai.google.com

Le chemin d'accès de la méthode stream est relatif à https://dai.google.com.

Méthode : stream

Requête HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

En-tête de requête

Authorization: DCLKDAI key="<api-key>"

Paramètres de chemin d'accès

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 :

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient un nouvel Stream. Pour les flux de balises côté serveur, ce Stream ne contient que les champs stream_id et stream_manifest.

Open Measurement

Le champ Verifications contient des informations sur la validation Open Measurement pour les flux de balises non côté serveur. Verifications contient un ou plusieurs éléments Verification qui listent les ressources et les métadonnées dont vous avez besoin pour vérifier la lecture des créations avec un code de mesure tiers. Seule la région JavaScriptResource est compatible. Pour en savoir plus, consultez l'IAB Tech Lab et la spécification VAST 4.1.

Méthode : validation du média

Lorsque vous rencontrez un identifiant média d'annonce pendant la lecture, envoyez immédiatement une requête à l'aide de media_verification_url à partir du point de terminaison stream. media_verification_url est un chemin absolu. Les demandes de validation du contenu multimédia ne sont pas nécessaires pour les flux de balises côté serveur, où le serveur lance la validation du contenu multimédia.

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

Requête HTTP

GET {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 (HLS)

Les identifiants de contenu multimédia des annonces seront encodés dans les métadonnées temporelles HLS à l'aide de la clé TXXX, réservée aux frames "informations textuelles définies par l'utilisateur". Le contenu du frame ne sera pas chiffré et commencera toujours par le texte "google_".

L'intégralité du contenu textuel du frame doit être ajoutée à l'URL media_verification_url pour chaque demande de validation d'annonce.

ID des éléments multimédias des annonces (DASH)

Les identifiants de contenu multimédia des annonces seront insérés dans le fichier manifeste à l'aide de l'élément EventStream de DASH.

Chaque EventStream aura un URI d'ID de schéma urn:google:dai:2018. Ils contiendront des événements dont l'attribut messageData contient un ID de support publicitaire commençant par "google_". L'intégralité du contenu de l'attribut messageData doit être ajoutée à media_verification_url pour chaque demande de validation d'annonce.

Données de réponse

Flux

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Annonce

{
  "seq": number,
  "start": 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,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Événement

{
  "time": number,
  "type": string,
}

Sous-titre

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

Icône

{
  "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

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Validation

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Annonce associée

{
  "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)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}