DAI API, beta sürümünde olduğundan ağınızda kullanılamayabilir. Daha fazla bilgi için hesap yöneticinize başvurun. IMA SDK, kullanılabildiği platformlar için önerilir.

Bu sayfa, Cloud Translation API ile çevrilmiştir.

Dinamik Reklam Ekleme Doğrusal API'si

Dinamik Reklam Ekleme API'si, DAI için istekte bulunmanıza ve bu verileri izlemenize olanak tanır doğrusal (CANLI) akışlar.

Hizmet: dai.google.com

Aşağıdaki tüm URI'ler https://dai.google.com ile ilgilidir

Yöntem: akış

Yöntemler
`stream`	`POST /linear/v1/hls/event/{assetKey}/stream` Belirtilen etkinlik kimliği için bir DAI akışı oluşturur.

HTTP isteği

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

İstek başlığı

Parametreler

Parametreler
`api‑key`	`string` Akış oluştururken sağlanan API anahtarı yayıncının ağı için geçerli olmalıdır. İstek gövdesinde bunu sağlamak yerine API anahtarı, değerini HTTP Yetkilendirme başlığında kullanabilirsiniz. Authorization: DCLKDAI key="<api-key>"

api‑key

string

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

İstek gövdesinde bunu sağlamak yerine API anahtarı, değerini HTTP Yetkilendirme başlığında kullanabilirsiniz.

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

Yol parametreleri

Parametreler
`assetKey`	`string` Akışın etkinlik kimliği. . Not: Akış öğesi anahtarı, şurada da bulunabilen bir tanımlayıcıdır: Ad Manager kullanıcı arayüzü.

İ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

DAI API'si, Open Measurement doğrulamasına ilişkin bilgileri Verifications alanına giriş yapın. Bu alan bir veya daha fazla öğe içeriyor Yürütülmek için gereken kaynakları ve meta verileri listeleyen Verification öğeleri üçüncü taraf ölçüm kodunu kontrol edin. Yalnızca JavaScriptResource desteklenir. Daha fazla bilgi için lütfen IAB Tech Lab ve VAST 4.1 spesifikasyonu.

Yöntem: Medya doğrulaması

Oynatma sırasında bir reklam medya tanımlayıcısıyla karşılaştıktan sonra, bunu hemen akıştan elde edilen media_verification_url'yi kullanarak istekte bulunma uç nokta ekleyin. Bu istekler, sunucu tarafı işaretleme için gerekli değildir Akışta yer alan sunuculardan birinin medya doğrulamasını başlattığını unutmayın.

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 https://{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, "kullanıcı tanımlı metin bilgileri" için ayrıldı çerçeveler. İlgili içeriği oluşturmak için kullanılan çerçevenin içeriği şifrelenmez ve her zaman "google_"

Çerçevedeki metin içeriğinin tamamı reklam doğrulamasına eklenmelidir. URL'sini eklemeniz gerekir.

Yöntem: meta veriler

metadata_url adresindeki meta veri uç noktası, reklam oluşturmak için kullanılan bilgileri döndürür Kullanıcı arayüzü. Meta veri uç noktası, sunucu tarafı işaretleme akışlarda kullanılamaz. Burada sunucu reklam medyası doğrulamasını başlatmaktan sorumlu olur.

Yöntemler
`metadata`	`GET /{metadata_url}/{ad-media-id}` `GET /{metadata_url}` Reklam meta veri bilgilerini alır.

HTTP isteği

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

GET https://{metadata_url}

Yanıt gövdesi

Başarılı olursa yanıt şu örneği döndürür: PodMetadata.

Meta verilerle çalışma

Meta veriler üç ayrı bölümden oluşur: tags, ads ve reklam breaks. Giriş tags bölümüdür. Ardından etiketleri yineleyin ve adı reklam medyası kimliği bulunmalıdır. Örneğin, aşağıdaki gibi bir reklam medyası kimliğine sahip olabilir:

google_1234567890

Daha sonra google_12345 adlı bir etiket nesnesi bulursunuz. Bu durumda, reklam medyası kimliği. Doğru reklam medyası öneki nesnesini bulduktan sonra, reklam kimlikleri, reklam arası kimlikleri ve etkinlik türü. Reklam kimlikleri daha sonra breaks nesneleri dizine eklemek için ads nesneleri ve reklam arası kimlikleri kullanılır.

Yanıt verileri

Akış

Akış, yeni oluşturulan bir akışın kaynak listesini oluşturmak için kullanılır JSON biçimi.

JSON gösterimi
{ "stream_id": string, "stream_manifest": string, "hls_master_playlist": string, "media_verification_url": string, "metadata_url": string, "session_update_url": string, "polling_frequency": number, }

Alanlar
`stream_id`	`string` GAM akış tanımlayıcısı.
`stream_manifest`	`string` HLS'de çok değişkenli oynatma listesini almak için kullanılan manifest URL'si veya DASH'te MPD.
`hls_master_playlist`	`string` (KULLANIMDAN KALDIRILDI) HLS çok değişkenli oynatma listesi URL'si. "stream_manifest" ifadesini kullanma .
`media_verification_url`	`string` Oynatma etkinliklerini izlemek için temel uç nokta olarak kullanılan medya doğrulama URL'si.
`metadata_url`	`string` Yaklaşan yayın reklam etkinlikleri hakkında düzenli bilgi anketleri yapmak için kullanılan meta veri URL'si.
`session_update_url`	`string` Oturumun güncelleme URL'si, bu akışın hedefleme parametrelerini güncellemek için kullanılır. Hedefleme parametrelerinin orijinal değerleri, ilk akış oluşturma isteği sırasında yakalanır.
`polling_frequency`	`number` Metadata_url veya streetbeat_url istenirken kullanılan yoklama sıklığı (saniye cinsinden).

PodMetadata

PodMetadata; reklamlar, reklam araları ve medya kimliği etiketleriyle ilgili meta veri bilgilerini içerir.

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

Alanlar
`tags`	`map[string, object(TagSegment)]` Etiket ön ekine göre dizine eklenen etiket segmentlerinin haritası.
`ads`	`map[string, object(Ad)]` Reklam kimliğine göre dizine eklenen reklamların haritası.
`ad_breaks`	`map[string, object(AdBreak)]` Reklam arası kimliğine göre dizine eklenen reklam aralarının haritası.

TagSegment

TagSegment bir reklama, reklama ait reklam arası ve etkinlik türü için referans içeriyor. type="progress" ile TagSegment reklam medyasına pinglenmemelidir doğrulama uç noktası.

JSON gösterimi
{ "ad": string, "ad_break_id": string, "type": string, }

Alanlar
`ad`	`string` Bu etiketin reklamının kimliği.
`ad_break_id`	`string` Bu etiketin reklam arasının kimliği.
`type`	`string` Bu etiketin etkinlik türü.

AdBreak

AdBreak, yayındaki tek bir reklam arasını tanımlar. Bir süre, reklam sayısını (orta/ön/yayın) ve reklam sayısını belirtmelidir.

JSON gösterimi
{ "type": string, "duration": number, "expected_duration": number, "ads": number, }

Alanlar
`type`	`string` Geçerli ara türleri şunlardır: öncesi, ortası ve sonrası.
`duration`	`number` Bu reklam arası için saniye cinsinden toplam reklam süresi.
`expected_duration`	`number` Tüm reklamlar ve seçenek listesi dahil olmak üzere reklam arasının beklenen süresi (saniye cinsinden).
`ads`	`number` Reklam arasındaki reklam sayısı.

Reklam

Reklam, akıştaki bir reklamı açıklar.

JSON gösterimi
{ "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), }

JSON gösterimi

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

Alanlar
`ad_break_id`	`string` Bu reklamın reklam arasının kimliği.
`position`	`number` Bu reklamın 1'den itibaren reklam arasındaki konumu.
`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.
`click_tracking_urls`	`string` İsteğe bağlı tıklama izleme URL'leri.
`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
`slate`	`boolean` Geçerli girişin seçenek listesi olduğunu belirten isteğe bağlı bool.
`icons`	`[object(Icon)]` Boşsa atlanan simgelerin listesi.
`wrappers`	`[object(Wrapper)]` Boşsa atlanan Sarmalayıcılar listesi.
`universal_ad_id`	`object(UniversalAdID)` İsteğe bağlı evrensel reklam kimliği.
`extensions`	`string` Tüm <Extension> öğelerinin isteğe bağlı listesi düğümleri arasındaki konumu değiştirebilir.
`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).

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

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

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.