Dinamik Reklam Ekleme VOD API'si

Dinamik Reklam Ekleme API'si, DAI seç-izle video (VOD) akışlarını istemenizi ve izlemenizi sağlar. HLS ve DASH akışları desteklenir.

Hizmet: dai.google.com

stream yönteminin yolu https://dai.google.com'a görelidir

Yöntem: stream

HTTP isteği

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

İstek başlığı

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

Yol parametreleri

İstek içeriği

İstek metni application/x-www-form-urlencoded türündedir ve aşağıdaki parametreleri içerir:

Yanıt gövdesi

Başarılı olursa yanıt metni yeni bir Stream içerir. Sunucu tarafı işaretçi akışları için bu Stream yalnızca stream_id ve stream_manifest alanlarını içerir.

Open Measurement

Verifications alanı, sunucu tarafı işaretçi olmayan akışlar için Open Measurement doğrulamasıyla ilgili bilgileri içerir. Verifications, reklam öğesi oynatmayı üçüncü taraf ölçüm koduyla doğrulamak için ihtiyaç duyduğunuz kaynakları ve meta verileri listeleyen bir veya daha fazla Verification öğesi içerir. Yalnızca JavaScriptResource desteklenir. Daha fazla bilgi için IAB Tech Lab'e ve VAST 4.1 spesifikasyonuna göz atın.

Yöntem: medya doğrulaması

Oynatma sırasında bir reklam medya tanımlayıcısı ile karşılaştıktan sonra hemen stream uç noktasından media_verification_url kullanarak istek gönderin. media_verification_url mutlak bir yoldur. Sunucunun medya doğrulamasını başlattığı sunucu tarafı işaretçi akışları için medya doğrulama istekleri gerekli değildir.

media verification uç noktasına gönderilen istekler idempotent'tir.

HTTP isteği

GET {media-verification-url}/{ad-media-id}

Yanıt gövdesi

media verification aşağıdaki yanıtları döndürür:

• HTTP/1.1 204 No Content medya doğrulaması başarılı olursa ve tüm ping'ler gönderilirse.
• İstek, yanlış URL biçimlendirmesi veya geçerlilik süresi sona ermesi nedeniyle medyayı doğrulayamazsa HTTP/1.1 404 Not Found.
• HTTP/1.1 404 Not Found değerini döndürür.
• HTTP/1.1 409 Conflict ise başka bir istek şu anda ping gönderiyor demektir.

Reklam medya kimlikleri (HLS)

Reklam medya tanımlayıcıları, "kullanıcı tanımlı metin bilgileri" çerçeveleri için ayrılmış TXXX anahtarı kullanılarak HLS Zamanlanmış Meta Verileri'ne kodlanır. Çerçevenin içeriği şifresi çözülecek ve her zaman "google_" metniyle başlayacaktır.

Çerçevenin metin içeriğinin tamamı, her reklam doğrulama isteği için media_verification_url'ye eklenmelidir.

Reklam medya kimlikleri (DASH)

Reklam medya tanımlayıcıları, DASH'in EventStream öğesi kullanılarak manifest'e eklenir.

Her EventStream, urn:google:dai:2018 Scheme ID URI'sine sahip olacaktır. Bu raporlar, “google_” ile başlayan bir reklam medya kimliği içeren messageData özelliğine sahip etkinlikleri içerir. messageData özelliğinin içeriğinin tamamı, her reklam doğrulama isteği için media_verification_url'ye eklenmelidir.

Yanıt verileri

Akış

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

Reklam

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

Etkinlik

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

Alt başlık

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

SkipMetadata

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

Simge

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

Doğrulama

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

Companion

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