API Dynamic Ad Insertion VOD

L'API d'insertion dynamique d'annonce vous permet de demander l'insertion dynamique d'annonce et d'en effectuer le suivi les flux de vidéo à la demande (VOD). 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 le les paramètres suivants:

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle Stream Pour les flux de balisage côté serveur, ce Stream contient uniquement les champs stream_id et stream_manifest.

Open Measurement

Le champ Verifications contient des informations pour Open Validation des mesures pour les flux de balisage non côté serveur Verifications contient un ou plusieurs éléments Verification qui listent les ressources et les métadonnées, vous devez vérifier la lecture des créations à l'aide d'un code de mesure tiers. Seul JavaScriptResource est accepté. Pour plus d'informations, consultez l'IAB Tech Lab et les spécifications VAST 4.1.

Méthode: vérification des supports

Lorsqu'un identifiant de support publicitaire s'affiche pendant la lecture, effectuez immédiatement une requête à l'aide du media_verification_url de stream point de terminaison unique. media_verification_url est un chemin d'accès absolu. Les requêtes de validation de médias ne sont pas nécessaires pour les flux de balisage côté serveur. où le serveur lance la vérification 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 réussit 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'une expiration.
• HTTP/1.1 404 Not Found si une précédente demande de validation a abouti pour cet ID.
• HTTP/1.1 409 Conflict si une autre requête envoie déjà des pings pour le moment.

ID des supports publicitaires (HLS)

Les identifiants de supports publicitaires seront encodés dans des métadonnées minutées HLS à l'aide de la clé TXXX. réservé aux "informations textuelles définies par l'utilisateur" cadres. Le contenu du cadre ne sera pas chiffré et commencera toujours par le texte "google_".

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

ID d'élément multimédia d'annonce (DASH)

Les identifiants de supports publicitaires seront insérés dans le fichier manifeste à l'aide de l'attribut Élément EventStream de DASH.

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

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

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