Dinamik Reklam Ekleme VOD API'si

Dinamik Reklam Ekleme API'si, DAI için istekte bulunmanıza ve bu verileri izlemenize olanak tanır seç-izle video (VOD) hizmeti HLS ve DASH akışları desteklenir.

Hizmet: dai.google.com

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

Yöntem: akış

Yöntemler
stream POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

Belirtilen içerik kaynağı ve video kimliği için HLS DAI akışı oluşturur.

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

Belirtilen içerik kaynağı ve video kimliği için DASH DAI akışı oluşturur.

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ığı

Parametreler
api‑key string

Akış oluştururken sağlanan API anahtarı yayıncının ağı için geçerli olmalıdır.

API anahtarı, istek gövdesinde sağlamak yerine Şu biçime sahip HTTP Yetkilendirmesi başlığı:

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

Yol parametreleri

Parametreler
content-source string

Akışın İYS kimliği.

video-id string

Akışın video kimliği.

İstek içeriği

İstek gövdesi application/x-www-form-urlencoded türündedir ve şu parametrelere sahiptir:

Parametreler
dai-ssb İsteğe bağlı

Sunucu tarafı işaretleme akışı oluşturmak için true olarak ayarlayın. Varsayılan olarak false değerine ayarlanır. Varsayılan akışın izlemesi tarafından başlatılır ve sunucu tarafında pinglenir.

DFP Hedefleme Parametreleri İsteğe bağlı Ek hedefleme parametreleri.
Akış Parametrelerini Geçersiz Kıl İsteğe bağlı Akış oluşturma parametresinin varsayılan değerlerini geçersiz kılın.
HMAC Kimlik Doğrulaması İsteğe bağlı HMAC tabanlı bir jeton kullanarak kimlik doğrulayın.

Yanıt gövdesi

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

Open Measurement

Verifications alanı, "Açık" seçeneğinin bilgilerini içerir Sunucu tarafı işaretlemeyen akışlar için ölçüm doğrulaması. Verifications, kaynakların listelendiği bir veya daha fazla Verification öğesi içeriyor üçüncü taraf ölçüm koduyla reklam öğesi oynatmayı doğrulamak için ihtiyacınız olan verileri ve meta verileri içerir. Yalnızca JavaScriptResource desteklenir. Daha fazla bilgi için daha fazla bilgi için IAB Tech Lab ve VAST 4.1 spesifikasyonu kullanıyor.

Yöntem: Medya doğrulaması

Oynatma sırasında bir reklam medyası tanımlayıcısıyla karşılaştığınızda, bunu hemen stream içinden media_verification_url öğesini kullanarak istekte bulunun uç nokta. media_verification_url, mutlak bir yoldur. Sunucu tarafı işaretleme akışları için medya doğrulama istekleri gerekli değildir. Burada sunucu medya doğrulamasını başlatır.

media verification uç noktasına yapılan istekler idempotenttir.

Yöntemler
media verification GET {media_verification_url}/{ad_media_id}

API'ye bir medya doğrulama etkinliği bildirir.

HTTP isteği

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

Yanıt gövdesi

media verification. şu yanıtları döndürür:

  • Medya doğrulaması başarılı olursa ve tüm ping'ler gönderilirse HTTP/1.1 204 No Content.
  • İstek, yanlış URL biçimlendirmesi veya geçerlilik süresi nedeniyle medyayı doğrulayamıyorsa HTTP/1.1 404 Not Found.
  • Bu kimlik için önceki doğrulama isteği başarılı olduysa HTTP/1.1 404 Not Found.
  • Şu anda başka bir istek zaten ping gönderiyorsa HTTP/1.1 409 Conflict.

Reklam medyası kimlikleri (HLS)

Reklam medyası tanımlayıcıları, TXXX anahtarı kullanılarak HLS Zamanlı Meta Veri'de kodlanır. "kullanıcı tanımlı metin bilgileri" için ayrıldı çerçeveler. Çerçevenin içeriği şifrelenmez ve her zaman "google_" metniyle başlar.

Çerçevedeki tüm metin içerikleri media_verification_url parametresini kullanın.

Reklam medyası kimlikleri (DASH)

Reklam medyası tanımlayıcıları, DASH'in EventStream öğesi.

Her EventStream, urn:google:dai:2018 Şema Kimliği URI'sine sahip olur. Bunlar, messageData özelliğine sahip etkinlikler içerir: “google_” ile başlayan reklam medyası kimliği. messageData içeriğinin tamamı özelliği, her reklam için media_verification_url öğesine eklenmelidir. doğrulama isteği gönderin.

Yanıt verileri

Akış

Akış, yeni oluşturulan bir kaynak için tüm kaynakların listesini oluşturmak amacıyla kullanılır akışı JSON biçiminde olur .
JSON gösterimi
{
  "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)],
}
Alanlar
stream_id string

Akış tanımlayıcısı.
total_duration number

Saniye cinsinden canlı yayın süresi.
content_duration number

İçeriğin reklam olmadan saniye cinsinden süresi.
valid_for string

Geçerlilik süresi: "00 sa. 00 dk. 0 sn." biçiminde olur.
valid_until string

RFC 3339 biçiminde, akışın geçerli olduğu tarih.
subtitles [object(Subtitle)]

Altyazı listesi. Boşsa atlanır. Yalnızca HLS.
hls_master_playlist string

(KULLANIMDAN KALDIRILDI) HLS ana oynatma listesi URL'si. Stream_manifest'i kullanın. Yalnızca HLS.
stream_manifest string

Akışın manifest dosyası. HLS'deki ana oynatma listesine ve DASH'teki MPD'ye karşılık gelir. "stream_id" dışındaki tek alandır söz konusu olduğunda bir sunucu tarafı işaretleme akışı oluşturur.
media_verification_url string

Medya doğrulama URL'si.
apple_tv object(AppleTV)

AppleTV cihazlarına özel isteğe bağlı bilgiler. Yalnızca HLS.
ad_breaks [object(AdBreak)]

Reklam aralarının listesi. Boşsa atlanır.

AppleTV

AppleTV, Apple TV cihazlarına özel bilgileri içerir.
JSON gösterimi
{
  "interstitials_url": string,
}
Alanlar
interstitials_url string

Geçiş reklamı URL'si.

AdBreak

AdBreak, yayındaki tek bir reklam arasını tanımlar. Bir konum, süre, tür (orta/ön/yayın) ve reklam listesi.
JSON gösterimi
{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}
Alanlar
type string

Geçerli ara türleri şunlardır: orta, öncesi ve sonrası.
start number

Akışta aranın başladığı konum (saniye cinsinden).
duration number

Reklam arasının saniye cinsinden süresi.
ads [object(Ad)]

Reklam listesi. Boşsa atlanır.
Reklam, akıştaki bir reklamı açıklar. Reklamın arasını, reklamın süresini ve isteğe bağlı bazı meta verileri içerir.
JSON gösterimi
{
  "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),
}
Alanlar
seq number

Reklamın aradaki konumu.
start number

Reklamın akışta başladığı saniye cinsinden konum.
duration number

Reklamın saniye cinsinden süresi.
title string

Reklamın isteğe bağlı başlığı.
description string

Reklamın isteğe bağlı açıklaması.
advertiser string

İsteğe bağlı reklamveren tanımlayıcısı.
ad_system string

İsteğe bağlı reklam sistemi.
ad_id string

İsteğe bağlı reklam kimliği.
creative_id string

İsteğe bağlı reklam öğesi kimliği.
creative_ad_id string

İsteğe bağlı reklam öğesi reklam kimliği.
deal_id string

İsteğe bağlı anlaşma kimliği.
clickthrough_url string

İsteğe bağlı tıklama URL'si.
icons [object(Icon)]

Boşsa atlanan simgelerin listesi.
wrappers [object(Wrapper)]

Sarmalayıcıların listesi. Boşsa atlanır.
events [object(Event)]

Reklamdaki etkinliklerin listesi.
verifications [object(Verification)]

Kaynakların listelendiği isteğe bağlı Open Measurement doğrulama girişleri Doğrulama amacıyla üçüncü taraf ölçüm kodunu yürütmek için gereken meta veriler reklam öğesi oynatma
universal_ad_id object(UniversalAdID)

İsteğe bağlı evrensel reklam kimliği.
companions [object(Companion)]

Bu reklamla birlikte gösterilebilecek isteğe bağlı tamamlayıcılar.
interactive_file object(InteractiveFile)

Reklam oynatma sırasında görüntülenmesi gereken isteğe bağlı etkileşimli reklam öğesi (SIMID).
skip_metadata object(SkipMetadata)

Atlanabilir reklamlar için isteğe bağlı meta veriler. Ayarlanırsa bu, reklamı gösterir atlanabilirdir ve atlama kullanıcı arayüzünün nasıl kullanılacağına ilişkin talimatlar içerir bir izleme etkinliğidir.

Etkinlik

Etkinlik, bir etkinlik türünü ve etkinliğin sunu zamanını içerir.
JSON gösterimi
{
  "time": number,
  "type": string,
}
Alanlar
time number

Bu etkinliğin sunu zamanı.
type string

Bu etkinliğin türü.

Alt başlık

Alt başlık, video akışı için bir yardımcı altyazı parçasını açıklar. Depolar TTML ve WebVTT olmak üzere iki altyazı biçimini kullanır. TTMLPath özelliği, ekler ve WebVTTPath özelliği benzer şekilde bir URL içerir. olarak değiştirin.
JSON gösterimi
{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}
Alanlar
language string

"en" gibi bir dil kodu belirtin.
language_name string

Dilin açıklayıcı adı. İş Listesi’ndeki belirli bir Aynı dil için birden fazla grup varsa altyazı
ttml string

TTML yardımcı dosyası dosyasının isteğe bağlı URL'si.
webvtt string

WebVTT yardımcı dosyası dosyasının isteğe bağlı URL'si.

SkipMetadata

SkipMetadata, müşterilerin atlanabilir reklamlar için atlama etkinliklerini işlemesi için gereken bilgileri sağlar.
JSON gösterimi
{
  "offset": number,
  "tracking_url": string,
}
Alanlar
offset number

Ofset, oynatıcının reklama gireceği süreyi saniye cinsinden gösterir atlama düğmesini oluşturmak için beklemelidir. VAST'ta sağlanmazsa atlanır.
tracking_url string

TrackingURL, atlama etkinliğinde pinglenmesi gereken bir URL içeriyor.

Simge

Simge, VAST simgesi hakkında bilgiler içeriyor.
JSON gösterimi
{
  "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,
}
Alanlar
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

ClickData, bir simge tıklamasıyla ilgili bilgiler içerir.
JSON gösterimi
{
  "url": string,
}
Alanlar
url string

FallbackImage

FallbackImage, VAST yedek resmiyle ilgili bilgiler içerir.
JSON gösterimi
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Alanlar
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Sarmalayıcı, bir sarmalayıcı reklamla ilgili bilgileri içerir. Güncelleme Anlaşma kimliği yoksa.
JSON gösterimi
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Alanlar
system string

Reklam sistemi tanımlayıcısı.
ad_id string

Sarmalayıcı reklam için kullanılan reklam kimliği.
creative_id string

Sarmalayıcı reklam için kullanılan reklam öğesi kimliği.
creative_ad_id string

Sarmalayıcı reklam için kullanılan reklam öğesi reklam kimliği.
deal_id string

Sarmalayıcı reklam için isteğe bağlı anlaşma kimliği.

Doğrulama

Doğrulama, Open Measurement için bilgileri içerir ve üçüncü taraf görüntülenebilirlik ve doğrulama ölçümü. Şu anda yalnızca JavaScript kaynakları desteklenmektedir. https://iabtechlab.com/standards/open-measurement-sdk/ sayfasını inceleyin.
JSON gösterimi
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Alanlar
vendor string

Doğrulama tedarikçi firması.
java_script_resources [object(JavaScriptResource)]

Doğrulama için JavaScript kaynaklarının listesi.
tracking_events [object(TrackingEvent)]

Doğrulama için izleme etkinliklerinin listesi.
parameters string

Önyükleme doğrulama koduna iletilen opak bir dize.

JavaScriptResource

JavaScriptResource, JavaScript aracılığıyla doğrulama yapmaya yönelik bilgiler içerir.
JSON gösterimi
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Alanlar
script_url string

JavaScript yükü için URI.
api_framework string

APIFramework, API'yi kullanan video çerçevesinin adıdır. doğrulama kodunu girmeniz gerekir.
browser_optional boolean

Bu komut dosyasının girin.

TrackingEvent

İzleme Etkinliği, istemci tarafından belirli durumlardan birine sahip olmaları halinde başlatabilirler.
JSON gösterimi
{
  "event": string,
  "uri": string,
}
Alanlar
event string

İzleme etkinliğinin türü.
uri string

Pinglenecek izleme etkinliği.

UniversalAdID

UniversalAdID, benzersiz bir reklam öğesi tanımlayıcısı sağlamak için kullanılır. bakımını yapmanız gerekir.
JSON gösterimi
{
  "id_value": string,
  "id_registry": string,
}
Alanlar
id_value string

Reklam için seçilen reklam öğesinin evrensel reklam kimliği.
id_registry string

Kayıt otoritesi web sitesinin URL'sini tanımlamak için kullanılan bir dize seçilen reklam öğesinin Evrensel Reklam Kimliği kataloga alınır.

Tamamlayıcı

Tamamlayıcı, görüntülenebilecek tamamlayıcı reklamlarla ilgili bilgiler içerir girin.
JSON gösterimi
{
  "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)],
}
Alanlar
click_data object(ClickData)

Bu tamamlayıcının tıklama verileri.
creative_type string

<StaticResource> öğesindeki CreativeType özelliği VAST'taki düğümün Bu, statik türünde bir tamamlayıcıdır.
height int32

Bu tamamlayıcının piksel cinsinden yüksekliği.
width int32

Bu tamamlayıcının piksel cinsinden genişliği.
resource string

Statik ve iframe tamamlayıcılar için bu, yüklenecek URL olacaktır. görüntülenir. HTML tamamlayıcıları için bu, gösterilmesi gereken HTML snippet'i tamamlayıcı olarak gösterilir.
type string

Bu tamamlayıcının türü. Statik, iframe veya HTML olabilir.
ad_slot_id string

Bu tamamlayıcının alan kimliği.
api_framework string

Bu tamamlayıcı için API çerçevesi.
tracking_events [object(TrackingEvent)]

Bu tamamlayıcı için izleme etkinliklerinin listesi.

InteractiveFile

InteractiveFile, etkileşimli reklam öğesiyle (ör. SIMID) ilgili bilgileri içerir reklam oynatımı sırasında görüntülenmesi gerekir.
JSON gösterimi
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Alanlar
resource string

Etkileşimli reklam öğesinin URL'si.
type string

Kaynak olarak sağlanan dosyanın MIME türü.
variable_duration boolean

Bu reklam öğesinin sürenin uzatılmasını isteyip isteymeyeceği.
ad_parameters string

<AdParameters> öğesinin değeri düğümünü kontrol edin.