API Dynamic Ad Insertion VOD

L'API Dynamic Ad Insertion vous permet de demander et de suivre des flux de vidéo à la demande (VOD) pour l'insertion dynamique d'annonce. 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 nouveau Stream. Pour les flux de balisage côté serveur, ce champ Stream ne contient que les champs stream_id et stream_manifest.

Open Measurement

Le champ Verifications contient des informations pour la validation Open Measurement des flux de balisage côté serveur. Verifications contient un ou plusieurs éléments Verification qui répertorient les ressources et les métadonnées dont vous avez besoin pour vérifier la lecture des créations à l'aide d'un code de mesure tiers. Seule la valeur JavaScriptResource est acceptée. Pour en savoir plus, consultez l'IAB Tech Lab et les spécifications VAST 4.1.

Méthode: vérification multimédia

Lorsque vous rencontrez un identifiant de support publicitaire 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 requêtes de validation multimédia ne sont pas nécessaires pour les flux de balisage côté serveur, pour lesquels le serveur lance la validation du mé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 multimédia aboutit et que tous les pings sont envoyés.
• HTTP/1.1 404 Not Found si la requête ne peut pas valider le contenu multimédia en raison d'un format d'URL incorrect ou d'un délai d'expiration.
• HTTP/1.1 404 Not Found si une précédente demande de validation pour cette pièce d'identité a abouti.
• HTTP/1.1 409 Conflict si une autre requête envoie déjà des pings à ce moment-là.

ID de support publicitaire (HLS)

Les identifiants de support publicitaire sont 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 de la trame ne sera pas chiffré et commencera toujours par le texte "google_".

L'intégralité du contenu du cadre doit être ajoutée à la fin de media_verification_url pour chaque demande de validation d'annonce.

ID d'éléments multimédias de l'annonce (DASH)

Les identifiants de support publicitaire seront insérés dans le fichier manifeste via l'élément EventStream de DASH.

Chaque EventStream aura un URI d'ID de schéma de urn:google:dai:2018. Ils contiendront des événements dont l'attribut messageData contient un ID d'élément multimédia de l'annonce 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 des annonces.

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),
}

Événement

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

Sous-titre

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

Icon

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

InteractiveFile

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