Dinamik Reklam Ekleme Doğrusal API'si

Dinamik Reklam Ekleme API'si, DAI doğrusal (CANLI) yayınlarını istemenize ve izlemenize olanak tanır.

Hizmet: dai.google.com

Tüm URI'ler https://dai.google.com ile ilgilidir.

Yöntem: stream

HTTP isteği

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

İstek başlığı

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

Yol parametreleri

İstek metni

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

Yanıt metni

Başarılı olursa yanıt gövdesi yeni bir Stream içerir. Sunucu tarafı sinyal gönderimi yapılan yayınlarda bu Stream yalnızca stream_id ve stream_manifest alanlarını içerir.

Open Measurement

DAI API'si, Verifications alanında Open Measurement doğrulamasıyla ilgili bilgiler içerir. Bu alan, reklam öğesi oynatmayı doğrulamak için üçüncü taraf ölçüm kodunu yürütmek üzere gereken 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 ve VAST 4.1 spesifikasyonunu inceleyin.

Yöntem: medya doğrulaması

Oynatma sırasında bir reklam medyası tanımlayıcısıyla karşılaştıktan sonra stream uç noktasından alınan media_verification_url kullanılarak hemen bir istekte bulunun. Bu istekler, sunucunun medya doğrulaması başlattığı sunucu tarafı sinyal akışları için gerekli değildir.

media verification uç noktasına yapılan istekler idempotent'tır.

HTTP isteği

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

Yanıt metni

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 süresi dolması nedeniyle medyayı doğrulayamıyorsa HTTP/1.1 404 Not Found.
• HTTP/1.1 404 Not Found Bu kimlik için önceki bir doğrulama isteği başarılı olduysa
• HTTP/1.1 409 Conflict Şu anda başka bir istek zaten ping gönderiyorsa

Reklam medyası kimlikleri (HLS)

Reklam medyası tanımlayıcıları, "kullanıcı tanımlı metin bilgisi" çerçeveleri için ayrılmış olan TXXX anahtarı kullanılarak HLS Zamanlanmış Meta Verileri'nde kodlanır. Çerçevenin içeriği şifrelenmez ve her zaman "google_" metniyle başlar.

Çerçevenin tüm metin içerikleri, her reklam doğrulama isteği yapılmadan önce reklam doğrulama URL'sine eklenmelidir.

Yöntem: metadata

metadata_url adresindeki meta veri uç noktası, reklam kullanıcı arayüzü oluşturmak için kullanılan bilgileri döndürür. Meta veri uç noktası, sunucunun reklam medyası doğrulamasını başlatmaktan sorumlu olduğu sunucu tarafı sinyal yayınlama akışlarında kullanılamaz.

HTTP isteği

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Sorgu parametreleri

Yanıt metni

Başarılı olursa yanıt, PodMetadata öğesinin bir örneğini döndürür.

Meta Verilerle Çalışma

Meta veriler üç ayrı bölümden oluşur: tags, ads ve breaks. Verilere giriş noktası tags bölümüdür. Buradan etiketler arasında ilerleyin ve adının video akışında bulunan reklam medyası kimliğinin öneki olduğu ilk girişi bulun. Örneğin, reklam medyası kimliğiniz şu şekilde olabilir:

google_1234567890

Ardından, google_12345 adlı bir etiket nesnesi bulursunuz. Bu durumda, reklam medya kimliğinizle eşleşir. Doğru reklam medyası önek nesnesini bulduktan sonra reklam kimliklerini, reklam arası kimliklerini ve etkinlik türünü arayabilirsiniz. Reklam kimlikleri daha sonra ads nesnelerini dizine eklemek için, reklam arası kimlikleri ise breaks nesnelerini dizine eklemek için kullanılır.

Yanıt verileri

Akış

{
  "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)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}

TagSegment

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

AdBreak

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

Reklam

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

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

Tamamlayıcı

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