API Dynamic Ad Insertion Linear

L'API Dynamic Ad Insertion vous permet de demander et de suivre des flux linéaires pour l'insertion dynamique d'annonce (EN DIRECT).

Service: dai.google.com

Tous les URI ci-dessous sont liés à 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 du 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

L'API d'insertion dynamique d'annonce contient des informations pour la validation Open Measurement dans le champ Verifications. Ce champ contient un ou plusieurs éléments Verification qui répertorient 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. Seul JavaScriptResource est accepté. Pour en savoir plus, consultez l'IAB Tech Lab et la spécification VAST 4.1.

Méthode: vérification du média

Si vous rencontrez un identifiant de support publicitaire pendant la lecture, envoyez immédiatement une requête à l'aide de l'URL media_verification_url obtenue à partir du point de terminaison stream, ci-dessus. Ces requêtes ne sont pas nécessaires pour les flux de balisage côté serveur, pour lesquels le serveur lance la vérification multimé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 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'une mise en forme d'URL incorrecte ou d'un délai d'expiration.
• HTTP/1.1 404 Not Found si une demande de validation précédente pour cette pièce d'identité a abouti.
• HTTP/1.1 409 Conflict si une autre requête envoie déjà des pings pour le moment.

ID de supports publicitaires (HLS)

Les identifiants de supports publicitaires sont encodés dans des métadonnées HLS temporelles à l'aide de la clé TXXX, réservée aux frames de type "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 à l'URL de validation des annonces avant chaque demande de validation d'annonce.

Méthode: métadonnées

Le point de terminaison des métadonnées à l'adresse metadata_url renvoie les informations utilisées pour créer une UI d'annonce. 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 validation 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 les métadonnées

Les métadonnées comportent trois sections distinctes: tags, ads et breaks de l'annonce. Le point d'entrée dans les données est la section tags. Parcourez ensuite les tags et recherchez la première entrée dont le nom est un préfixe de l'ID d'élément multimédia de l'annonce trouvé dans le flux vidéo. Par exemple, l'ID d'élément multimédia de l'annonce peut se présenter comme suit:

google_1234567890

Vous trouvez ensuite un objet tag nommé google_12345. Dans ce cas, il correspond à votre ID de support publicitaire. Une fois que vous avez trouvé l'objet "Préfixe du support publicitaire", vous pouvez rechercher les identifiants des annonces, les ID 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 pour indexer les objets breaks.

Données des réponses

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

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,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

InteractiveFile

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