API Dynamic Ad Insertion Linear

L'API d'insertion dynamique d'annonce vous permet de demander l'insertion dynamique d'annonce et d'en effectuer le suivi les flux linéaires (EN DIRECT).

Service: dai.google.com

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

Méthode: stream

Requête HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/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

L'API d'insertion dynamique d'annonce contient des informations pour la validation Open Measurement dans le Verifications. Ce champ contient un ou plusieurs Des éléments Verification qui listent les ressources et les métadonnées requises pour l'exécution un code de mesure tiers afin de vérifier la lecture de la création. Uniquement JavaScriptResource est pris en charge. Pour en savoir plus, consultez les IAB Tech Lab et le 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 à l'aide de l'élément media_verification_url obtenu dans le flux stream point de terminaison, comme indiqué ci-dessus. Ces requêtes ne sont pas nécessaires pour le balisage côté serveur flux, où 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 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 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. La contenu du frame n’est pas crypté et commence toujours par le texte "google_"

L'intégralité du contenu textuel du frame doit être ajouté à la page de vérification de l'annonce. URL avant d'effectuer chaque demande de validation d'annonce.

Méthode: metadata

Le point de terminaison des métadonnées à metadata_url renvoie les informations utilisées pour créer une annonce UI. Le point de terminaison des métadonnées n'est pas disponible pour les flux de balisage côté serveur. où le serveur est chargé de lancer la vérification du média publicitaire.

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

Utiliser des métadonnées

Les métadonnées comportent trois sections distinctes: tags, ads et l'annonce breaks. L'entrée point dans les données est la section tags. À partir de là, itérez les balises et rechercher la première entrée dont le nom est un préfixe identifiant du contenu multimédia de l'annonce détecté dans le flux vidéo. Par exemple : peut avoir un ID de média publicitaire semblable à celui-ci:

google_1234567890

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

Données de réponse

Flux

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

Annonce

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

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