Canlı API sunan Dinamik Reklam Ekleme kapsülü

Dinamik Reklam Ekleme API'si, DAI canlı yayınları için istekte bulunmanıza ve bu canlı yayınları izlemenize olanak tanır.

Hizmet: dai.google.com

Tüm URI'ler https://dai.google.com ile ilişkilidir.

Yöntem: akış

Yöntemler
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Canlı yayın oturumu sunan bir DAI DAI kapsülü kaydeder.

HTTP isteği

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Yol parametreleri

Parametreler
network_code string

Yayıncının Google Ad Manager ağ kodu.

custom_asset_key string

Google Ad Manager'da bu etkinlikle ilişkili özel tanımlayıcı.

İstek içeriği

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

Parametreler
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 nesnesi 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: kapsül segmenti

Yöntemler
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/pod/{pod_id}/profile/{profile_name}/{segment_number}.{segment_format}

Belirtilen etkinlik kimliği için bir DAI akışı oluşturur.

HTTP isteği

GET https://dai.google.com//linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/pod/{pod_id}/profile/{profile_name}/{segment_number}.{segment_format}

Yol parametreleri

Parametreler
network_code string

Yayıncının Google Ad Manager ağ kodu.

custom_asset_key string

Google Ad Manager'da bu etkinlikle ilişkili özel tanımlayıcı.

pod_id integer

Geçerli reklam arasının sayısal tanımlayıcısı. Reklam kapsülü kimlikleri: 1'den başlayarak aşamalı olarak atanır.
profile_name string

İlgili içeriği oluşturmak için kullanılan ad istenen Google Ad Manager DAI kodlama profili. Kodlama profili, etkinliği tıklayın.

segment_number integer

Geçerli reklam kapsülündeki istenen segmentin dizinidir. sıfır.
segment_format string

İstenen segment biçimiyle ilişkili dosya uzantısı. Kabul edilen uzantılar şunlardır: ts, mp4, vtt, aac, ac3 veya eac3.

Sorgu parametreleri

Parametreler
stream_id zorunlu string

Geçerli kullanıcının oturumunun akış kimliği. Bu değer, stream uç noktasına başarılı bir istek gönderir.
sd required1 integer

İstenen segmentin milisaniye cinsinden süresi.
so isteğe bağlı

İstenen segmentin reklam kapsülü içindeki ofseti (milisaniye cinsinden). so parametresini çıkarırsanız parametre şu şekilde hesaplanır: ve segment süresi segment numarasıyla çarpılır.
pd zorunlu2 integer

Reklam kapsülünün milisaniye cinsinden süresi.
auth-token zorunlu string

İmzalanmış, url kodlamalı bir HMAC jetonu seçmeniz gerekir.
last isteğe bağlı boolean

Reklam arasındaki son segmenti belirtir. Bu parametreyi tümü için atlayın segment'e göz atın.
scte35 isteğe bağlı string

Bu reklam arası için Base64 kodlu SCTE-35signal.
cust_params isteğe bağlı string

Ad Manager kampanya hedeflemesi için kullanılan bir anahtar/değer çiftleri grubu. Bu çiftleri, URL kodlamalı sorgu dizesi olarak temsil edilmelidir.

Örnek:
Parametreler
  • section = sports
  • sayfa = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Dipnotlar

  1. Başlatma segmentleri için sd gerekli değildir. ↩
  2. Süresiz reklam içeren etkinlikler için pd gerekli değildir aralar etkinleştirildi. ↩

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, biçimi ve istekte belirtilen parametreleri içerir.

Yöntem: DASH kapsül dönemi şablonu

Yöntemler
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Google Ad Manager'dan DASH dönem şablonu ister. Bu şablon akış parametrelerinizle doldurmanız gereken makrolar içeriyorsa. Bir kez bu makrolar doldurulur, şablon reklam arası süreniz olur ve DASH manifestinize entegre edilebilir.

HTTP isteği

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Yol parametreleri

Parametreler
network_code string

Yayıncının Google Ad Manager ağ kodu.

custom_asset_key string

Google Ad Manager'da bu etkinlikle ilişkili özel tanımlayıcı.

Sorgu parametreleri

Parametreler
stream_id zorunlu string

Geçerli kullanıcının oturumunun akış kimliği. Bu değer, stream uç noktasına başarılı bir istek gönderir.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, yeni bir PodTemplateResponse nesnesini tanımlayın.

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 başarılı olursa HTTP/1.1 204 No Content gönderilir.
  • İstek, aşağıdaki nedenlerden dolayı medyayı doğrulayamazsa HTTP/1.1 404 Not Found hatalı URL biçimlendirmesi veya geçerlilik süresi.
  • Bu kimlik için daha önce gönderilen bir doğrulama isteğiyse HTTP/1.1 404 Not Found başarılı oldu.
  • Başka bir istek bu aşamada ping gönderiyorsa HTTP/1.1 409 Conflict gerekir.

Reklam medyası kimlikleri

Reklam medyası tanımlayıcıları, ayrı bir meta veri kanalında (zamanlanmış) kodlanır. HLS aktarım akışı için meta veriler veya mp4 dosyaları için emsg. Reklam medyası tanımlayıcıları her zaman google_ dizesiyle başlar.

Meta veri girişinin tüm metin içeriği reklama eklenmelidir doğrulama 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 Verileri Ayrıştırma

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,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Alanlar
stream_id string

GAM akış tanımlayıcısı.
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.
heartbeat_url string

Sunucu tarafı işaretleme akışı canlı tutmak için kullanılan sinyal URL'si, her {PollingFrequency} saniyede bir pinglenmesi gerekir. Sunucu tarafı işaretleme akışları için doldurulur.
polling_frequency number

Metadata_url veya streetbeat_url istenirken kullanılan yoklama sıklığı (saniye cinsinden).
pod_manifest_url string

Kapsül manifest URL şablonu, bir akışın kapsül manifestini almak üzere URL'yi oluşturmak için kullanılır. HLS'deki çok değişkenli oynatma listesinin veya DASH'deki MPD'nin URL'sine karşılık gelir. POD_SERVING_MANIFEST türündeki Dinamik Reklam Ekleme türündeki canlı yayın etkinlikleri için doldurulur. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Manifest biçimi, pod_manifest_url parametresinden alınan manifestin biçimidir. tire veya hls girin.

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

PodTemplateResponse

PodTemplateResponse, kapsül birleştirme için bir VTP'ye döndürülen JSON yükünü temsil eder.
JSON gösterimi
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Alanlar
dash_period_template string

DashPeriodTemplate, birleştirme işleminden önce uygun verilerle doldurulması gereken dönemin xml şablonudur.
segment_duration_ms int64

SegmentDurationMS, dönem segmentlerinin milisaniye cinsinden süresidir.

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.