Dinamik Reklam Ekleme API'si, DAI seç-izle akışlarını istemenize ve izlemenize olanak tanır.
Hizmet: dai.google.com
Tüm URI'ler https://dai.google.com ile ilgilidir.
Yöntem: akış oluşturma
Bu yöntem, doğrudan cihazdan bir yayın oluşturur. Böylece, istemci uygulamasının reklamları oynatıp izlemesi ve kullanıcı arayüzü öğelerini göstermesi için gereken tüm kaynaklar döndürülür.
| Yöntemler | |
|---|---|
create stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream
DAI kapsül yayınlama VOD oturumu oluşturun. |
HTTP isteği
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream
Yol parametreleri
| Parametreler | |
|---|---|
network_code |
string
Yayıncının Google Ad Manager ağ kodu. |
İstek içeriği
İstek metni application/json türündedir ve bir CreateStreamRequest nesnesi içermelidir.
Yanıt gövdesi
Başarılı olursa yanıt gövdesi yeni bir CreateStreamResponse nesnesi içerir.
Yöntem: akışı kaydetme
Bu yöntem, cihazdan Google DAI arka ucunda bir yayın kaydeder. Bu yayın, istemci uygulamasının reklamları izlemesi ve kullanıcı arayüzü öğelerini göstermesi için gereken tüm kaynakları döndürür. create stream yönteminin aksine,
bu yöntem oynatılabilir reklam manifesti döndürmez. Bunun yerine bu işlem, ayrı bir sunucu çağrısıyla gerçekleştirilir: decision ad pods.
| Yöntemler | |
|---|---|
register stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration
Bir DAI kapsül yayınlama VOD oturumu kaydeder. |
HTTP isteği
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration
Yol parametreleri
| Parametreler | |
|---|---|
network_code |
string
Yayıncının Google Ad Manager ağ kodu. |
İstek içeriği
İstek metni application/json türündedir ve bir StreamRegistrationRequest nesnesi içermelidir.
Yanıt gövdesi
Başarılı olursa yanıt gövdesi yeni bir StreamRegistrationResponse nesnesi içerir.
Yöntem: reklam kapsüllerini alma
Bu yöntem, bir cihazdan gelen register stream çağrısını izler ve içerik manifestlerine eklemek için oynatılabilir reklam manifestlerini almak gerekir.
| Yöntemler | |
|---|---|
decision ad pods |
POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
DAI kapsül yayınlama VOD oturumu için reklam kapsüllerine karar verin. |
HTTP isteği
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
Yol parametreleri
| Parametreler | |
|---|---|
network_code |
string
Yayıncının Google Ad Manager ağ kodu. |
stream_id |
string
Bir stream_registration çağrısından alınan stream_id. |
İstek içeriği
İstek metni application/json türündedir ve bir AdPodDecisionRequest nesnesi içermelidir.
Yanıt gövdesi
Başarılı olursa yanıt gövdesi yeni bir AdPodDecisionResponse nesnesi içerir.
Yöntem: reklam kapsülü meta verileri
Bu yöntem, istemci uygulamasının reklamları izlemesi ve uygun kullanıcı arayüzü öğelerini doğru şekilde oluşturması için gereken tüm bilgileri döndürür.
| Yöntemler | |
|---|---|
ad pods metadata |
GET: /ondemand/pods/api/v1/network/.../metadata
Belirli bir oturum için reklam kapsülü meta verilerini alın. Bu URL, |
HTTP isteği
GET: /ondemand/pods/api/v1/network/.../metadata
Yanıt gövdesi
Başarılı olursa yanıt gövdesi, bir Ad pods metadata nesnesi içerir.
API Nesneleri
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)],
"polling_frequency": number,
} |
| Alanlar | |
|---|---|
tags |
map[string, object(TagSegment)]Etiket ön ekine göre dizine eklenmiş 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ı. |
polling_frequency |
numberÖnerilen meta veri URL'si anket sıklığı (saniye cinsinden). Talebe bağlı karar verme kullanılarak VOD akışları için doldurulur. |
TagSegment
TagSegment, bir reklama, reklam arasını ve etkinlik türüne referans içerir. TagSegment with type="progress" (tür="progress" olan TagSegment) reklam medyası doğrulama uç noktasına pinglenmemelidir.| JSON gösterimi |
|---|
{ "ad": string, "ad_break_id": string, "type": string, } |
| Alanlar | |
|---|---|
ad |
stringBu etiketin reklamının kimliği. |
ad_break_id |
stringBu etiketin reklam arasının kimliği. |
type |
stringBu etiketin etkinlik türü. |
AdBreak
AdBreak, akıştaki tek bir reklam arasını tanımlar. Süre, tür (orta/ön/son) ve reklam sayısı bilgilerini içerir.| JSON gösterimi |
|---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
| Alanlar | |
|---|---|
type |
stringGeçerli ara türleri şunlardır: pre, mid ve post. |
duration |
numberBu reklam arası için toplam reklam süresi (saniye). |
expected_duration |
numberTüm reklamlar ve seçenek listesi dahil olmak üzere reklam arasının beklenen süresi (saniye cinsinden). |
ads |
numberReklam arasındaki reklam sayısı. |
Reklam
Reklam, akıştaki bir reklamı tanımlar.| 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 |
stringBu reklamın reklam arasının kimliği. |
position |
numberBu reklamın reklam arasındaki konumu (1'den başlar). |
duration |
numberReklamın saniye cinsinden süresi. |
title |
stringReklamın isteğe bağlı başlığı. |
description |
stringReklamı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)]Üçüncü taraf ölçüm kodunu yürütmek için gereken kaynakları ve meta verileri listeleyen isteğe bağlı Açık Ölçüm doğrulama girişleri reklam öğesi oynatmayı doğrulamak için. |
slate |
booleanGeçerli girişin slate olduğunu belirten isteğe bağlı boole. |
icons |
[object(Icon)]Boşsa atlanan simge listesi. |
wrappers |
[object(Wrapper)]Boşsa atlanan sarmalayıcıların listesi. |
universal_ad_id |
object(UniversalAdID)İsteğe bağlı evrensel reklam kimliği. |
extensions |
stringVAST'taki tüm <Extension> düğümlerinin isteğe bağlı listesi. |
companions |
[object(Companion)]Bu reklamla birlikte gösterilebilecek isteğe bağlı tamamlayıcılar. |
interactive_file |
object(InteractiveFile)Reklam oynatılırken gösterilmesi gereken isteğe bağlı etkileşimli reklam öğesi (SIMID). |
MatchOpts
MatchOpts, bir akış için katı medya eşleştirme koşullarını belirtir.| JSON gösterimi |
|---|
{
"audio_channels": boolean,
"audio_sample_rate": boolean,
} |
| Alanlar | |
|---|---|
audio_channels |
booleanİçerik ve reklamlar arasındaki ses kanallarını eşleştirin. |
audio_sample_rate |
booleanİçerik ve reklam arasındaki ses örnek hızını eşleştirin. |
CreateStreamRequest
CreateStreamRequest, VOD pod serving API'ye yapılan HTTP isteklerinde bulunan bilgileri açıklar. Akış oluşturma, her kullanıcı için SDK ve yayıncı adına VTP (video teknolojisi iş ortağı) tarafından başlatılır. Akış, VTP'nin birleştireceği karar verilmiş reklam kapsülleriyle sonuçlanır. Bu, bir akışı kaydeden ve birden fazla istekte reklam kapsüllerine karar veren StreamRegistrationRequest+AdPodDecisionRequest akışının aksine bir durumdur.| JSON gösterimi |
|---|
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(CreateStreamOptions), } |
| Alanlar | |
|---|---|
encoding_profiles |
[object(EncodingProfile)]Kodlama profillerinin listesi. Zorunlu. |
ad_tag |
stringKarar verme için temel reklam etiketi. Zorunlu. |
cuepoints |
numberSaniye cinsinden ipucu noktalarının listesi. Reklam etiketi yanıtında konumsal zaman farkları kullanıldığında gereklidir. |
manifest_type |
stringGeçerli manifest türleri şunlardır: hls ve dash. Varsayılan: hls. İsteğe bağlıdır. |
enable_hls_asset_list |
booleanHLS öğe listesi geçiş reklamlarının etkin olup olmadığını gösterir. Etkinleştirildiğinde DAI, her reklam arası için öğe listesi URL'leri döndürür. Bu URL'ler HLS geçiş reklamları için kullanılabilir. |
targeting_parameters |
stringEk Ad Manager hedefleme parametreleri. İsteğe bağlıdır. |
content_duration_seconds |
numberContentDurationSeconds, içeriğin saniye cinsinden süresidir. Reklam etiketinin yanıtında zaman farkı yüzdeleri kullanıldığında gereklidir. |
decision_timing_options |
object(DecisionTimingOptions)Reklam kapsüllerinin ne zaman karara bağlanması gerektiğini gösterir. |
enable_inline_manifests |
booleanAra manifestlerinin JSON yanıtına satır içi olarak eklenip eklenmeyeceğini gösterir. |
dai_options |
object(CreateStreamOptions)Akış oluşturmayla ilgili DAIOptions. |
CreateStreamOptions
CreateStreamOptions, tek adımlı akış oluşturma iş akışında kullanılabilen seçenekleri temsil eder.| JSON gösterimi |
|---|
{
"dash_profile": string,
"match_options": object(MatchOpts),
"data_sharing_policy_code": string,
"sam_id": string,
"session_title": string,
"dash_inband_event_stream": boolean,
"distinct_ad_profiles": boolean,
"tracking_mode": string,
"emsg_version": uint32,
} |
| Alanlar | |
|---|---|
dash_profile |
stringKullanılacak MPEG-DASH profili: "live" (canlı) veya "on-demand" (isteğe bağlı). |
match_options |
object(MatchOpts) |
data_sharing_policy_code |
stringYayıncıların, ağın varsayılan veri paylaşımı politikasını geçersiz kılmasına olanak tanır. |
sam_id |
stringsam_id, oturumun SAM hata ayıklama anahtarıdır ve isteğe bağlıdır. |
session_title |
stringsession_title, akış için SAM oturum başlığıdır ve isteğe bağlıdır. |
dash_inband_event_stream |
booleandash_inband_event_stream, DAI'nin ID3 mesajlarını EventStream öğeleri (manifest içinde) olarak değil, InbandEventStream öğesini kullanarak bant içi etkinlikler (medya içinde) olarak eklediğini gösterir. |
distinct_ad_profiles |
booleanDoğru olarak ayarlanırsa sunucunun, istenen kodlama profilleriyle eşleştirme yaparken mevcut reklam profillerini en fazla bir kez kullanacağını belirtir. |
tracking_mode |
stringtracking_mode, akış için kullanılacak reklam izleme türüdür (isteğe bağlı). Geçerli değerler: "ad_media", "server", "client". |
emsg_version |
uint32emsg_version, medya içi ID3'ler için belirli bir emsg sürümünün kullanılmasını zorunlu kılar. Yalnızca dash_inband_event_stream doğru olduğunda desteklenir. |
StreamRegistrationRequest
StreamRegistrationRequest, gelecekteki reklam kapsülü kararları için cihazdan bir yayın kaydeder. Bu, tek bir istekte akış oluşturan ve reklam kapsüllerine karar veren CreateStreamRequest'in aksine bir durumdur.| JSON gösterimi |
|---|
{
"targeting_parameters": map[string, string],
"dai_options": object(StreamRegistrationOptions),
} |
| Alanlar | |
|---|---|
targeting_parameters |
stringEk Ad Manager hedefleme parametreleri. İsteğe bağlıdır. |
dai_options |
object(StreamRegistrationOptions)Akış kaydı için DAIOptions. |
StreamRegistrationOptions
StreamRegistrationOptions, akış oluşturma için kullanılabilen seçenekleri listeler.| JSON gösterimi |
|---|
{
"sam_id": string,
"tracking_mode": string,
"emsg_version": uint32,
"skippable_ads_supported": boolean,
} |
| Alanlar | |
|---|---|
sam_id |
stringsam_id, oturumun SAM hata ayıklama anahtarıdır ve isteğe bağlıdır. |
tracking_mode |
stringtracking_mode, akış için kullanılacak reklam izleme türüdür (isteğe bağlı). Geçerli değerler: "ad_media", "server", "client". |
emsg_version |
uint32emsg_version, medya içi ID3'ler için belirli bir emsg sürümünün kullanılmasını zorunlu kılar. Yalnızca dash_inband_event_stream doğru olduğunda desteklenir. |
skippable_ads_supported |
booleanAtlanabilir reklamların desteklenip desteklenmediğini gösterir. |
StreamRegistrationResponse
StreamRegistrationResponse, StreamRegistrationRequest'e yanıt olarak istemciye geri gönderilen JSON yanıtını temsil eder. Yayın kimliği ve cihazın ihtiyaç duyacağı tüm URL'ler bu dosyada yer alır. Akış kimliğine sonraki bir reklam grubu kararı isteğinde referans verilebilir. Bu, aynı anda akış oluşturma ve reklam kapsülleri için karar verme yanıtını temsil eden bir CreateStreamResponse ile çelişir.| JSON gösterimi |
|---|
{
"stream_id": string,
"media_verification_url": string,
"valid_for": string,
"valid_until": string,
"metadata_url": string,
} |
| Alanlar | |
|---|---|
stream_id |
stringStreamID, bu izleyicinin mevcut akışının benzersiz tanımlayıcısıdır. |
media_verification_url |
stringMediaVerificationURL, aşağıda açıklanan reklam medyası doğrulama isteklerinde kullanılacak URL ön ekidir. İstemci taraflı işaretleme akışlarında yoktur. |
valid_for |
stringValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder. |
valid_until |
stringValidUntil, bu akışın geçerli olduğu tarih ve saattir. |
metadata_url |
stringMetadataURL, adpod meta verilerini istemek için kullanılacak meta veri URL'sidir. |
DecisionTimingOptions
DecisionTimingOptions, akış için reklam aralarına karar verme zamanlaması seçeneklerini açıklar.| JSON gösterimi |
|---|
{ "type": string, "on_create_breaks": [], } |
| Alanlar | |
|---|---|
type |
stringTür, akış için reklam kapsüllerine ne zaman karar verildiğini açıklar. Geçerli türler şunlardır: on_create (varsayılan), on_demand. Tür on_demand olduğunda, belirli bir ara için manifest istendiğinde reklamlar geç karar verilir. Tür on_create olduğunda, akış oluşturulurken tüm reklamlara karar verilir. |
on_create_breaks |
stringOnCreateBreaks, akış oluşturma sırasında karar verilmesi gereken büyük/küçük harfe duyarlı VMAP breakID'lerinin listesidir. Bu alana yalnızca tür on_demand ise izin verilir. "Preroll" ve "postroll" özel reklam arası tanımlayıcıları, videodan önce veya sonra gösterilen reklam arasının akış oluşturma zamanında kararlaştırılması gerektiğini belirtmek için kullanılabilir. |
EncodingProfile
EncodingProfile, tek bir içerik varyantının kodlamasını açıklar. Yalnızca video ayarları, yalnızca ses ayarları (medya türü söz konusu olduğunda), hem video hem de ses ayarları veya altyazılar söz konusu olduğunda hiçbir ayar içermeyebilir.| JSON gösterimi |
|---|
{ "profile_name": string, "type": string, "container_type": string, "video_settings": object(VideoSettings), "audio_settings": object(AudioSettings), "subtitle_settings": object(SubtitleSettings), } |
| Alanlar | |
|---|---|
profile_name |
stringProfil için yayıncı tarafından sağlanan ad. Her akış için benzersizdir. Zorunlu. |
type |
stringGeçerli türler: medya, iframe, altyazılar. Zorunlu. |
container_type |
stringGeçerli türler: mpeg2ts, fmp4cmaf ve hls_packed_audio. Type medya ve iframe için gereklidir. |
video_settings |
object(VideoSettings)Kapsayıcı türü iFrame ise video ayarları gereklidir. Aksi takdirde, yalnızca profilde video varsa gösterilirler. |
audio_settings |
object(AudioSettings)Profil ses içeriyorsa ses ayarları bulunur. Ses ayarlarına yalnızca kapsayıcı türü medya ise izin verilir. |
subtitle_settings |
object(SubtitleSettings)Altyazı ayarları, altyazı türü için gereklidir. |
VideoSettings
VideoSettings, bir kodlama profilinin videosunu tanımlar. Bir video ayarı varsa diğer tüm video ayarları da olmalıdır.| JSON gösterimi |
|---|
{
"codec": string,
"bitrate": int32,
"frames_per_second": number,
"resolution": object(Resolution),
} |
| Alanlar | |
|---|---|
codec |
stringVideonun RFC6381 codec dizesi. |
bitrate |
int32Kodlama profilinin maksimum video bit hızı. |
frames_per_second |
numberVideonun saniyedeki kare sayısı. |
resolution |
object(Resolution)Videonun genişlik x yükseklik çözünürlüğü. |
AudioSettings
AudioSettings, kodlama profilinin sesini açıklar. Bir ses ayarı varsa tüm ses ayarları olmalıdır.| JSON gösterimi |
|---|
{
"codec": string,
"bitrate": int32,
"channels": int32,
"sample_rate": int64,
} |
| Alanlar | |
|---|---|
codec |
stringSesin RFC6381 codec dizesi. |
bitrate |
int32Kodlama profilinin maksimum ses bit hızı. |
channels |
int32Düşük frekanslı kanallar dahil olmak üzere ses kanallarının sayısı. |
sample_rate |
int64Sesin örnekleme hızı (hertz). |
SubtitleSettings
SubtitleSettings, kodlama profillerinin altyazılarını açıklar.| JSON gösterimi |
|---|
{
"format": string,
"language": string,
} |
| Alanlar | |
|---|---|
format |
stringAltyazı biçimi: HLS için webvtt, DASH için webvtt veya ttml. |
language |
stringManifest dosyasına eklenecek dil. |
Çözünürlük
Çözünürlük, bir videonun genişliğini ve yüksekliğini ifade eder.| JSON gösterimi |
|---|
{
"width": int32,
"height": int32,
} |
| Alanlar | |
|---|---|
width |
int32Videonun piksel cinsinden genişliği. Zorunlu. |
height |
int32Videonun piksel cinsinden yüksekliği. Zorunlu. |
AdPodDecisionRequest
AdPodDecisionRequest, daha önce kaydedilmiş bir akış için reklam kapsüllerine karar verme isteğini temsil eder.| JSON gösterimi |
|---|
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(AdPodDecisionOptions), } |
| Alanlar | |
|---|---|
encoding_profiles |
[object(EncodingProfile)]Kodlama profillerinin listesi. Zorunlu. |
ad_tag |
stringKarar verme için temel reklam etiketi. Zorunlu. |
cuepoints |
numberSaniye cinsinden ipucu noktalarının listesi. Reklam etiketi yanıtında konumsal zaman farkları kullanıldığında gereklidir. |
manifest_type |
stringGeçerli manifest türleri şunlardır: hls ve dash. Varsayılan: hls. İsteğe bağlıdır. |
enable_hls_asset_list |
booleanHLS öğe listesi geçiş reklamlarının etkin olup olmadığını gösterir. Etkinleştirildiğinde DAI, her reklam arası için öğe listesi URL'leri döndürür. Bu URL'ler HLS geçiş reklamları için kullanılabilir. |
targeting_parameters |
stringEk Ad Manager hedefleme parametreleri. İsteğe bağlıdır. |
content_duration_seconds |
numberContentDurationSeconds, içeriğin saniye cinsinden süresidir. Reklam etiketinin yanıtında zaman farkı yüzdeleri kullanıldığında gereklidir. |
decision_timing_options |
object(DecisionTimingOptions)Reklam kapsüllerinin ne zaman karara bağlanması gerektiğini gösterir. |
enable_inline_manifests |
booleanAra manifestlerinin JSON yanıtına satır içi olarak eklenip eklenmeyeceğini gösterir. |
dai_options |
object(AdPodDecisionOptions)Reklam kapsülü kararı için DAIOptions. |
AdPodDecisionResponse
AdPodDecisionResponse, daha önce kaydedilmiş bir akış için reklam kapsülü kararlarına verilen yanıtı temsil eder. Bu akış için kararı verilen reklam kapsüllerinin listesini içerir.| JSON gösterimi |
|---|
{
"valid_for": string,
"valid_until": string,
"ad_pods": [object(AdPod)],
} |
| Alanlar | |
|---|---|
valid_for |
stringValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder. |
valid_until |
stringValidUntil, bu akışın geçerli olduğu tarih ve saattir. |
ad_pods |
[object(AdPod)]Kampanya siparişine göre sıralanmış reklam kapsülü listesi. |
CreateStreamResponse
CreateStreamResponse, CreateStreamRequest'e yanıt olarak istemciye geri gönderilen JSON yanıtını temsil eder.| JSON gösterimi |
|---|
{
"valid_for": string,
"valid_until": string,
"ad_pods": [object(AdPod)],
"stream_id": string,
"media_verification_url": string,
"pod_metadata": object(PodMetadata),
"metadata_url": string,
} |
| Alanlar | |
|---|---|
valid_for |
stringValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder. |
valid_until |
stringValidUntil, bu akışın geçerli olduğu tarih ve saattir. |
ad_pods |
[object(AdPod)]Kampanya siparişine göre sıralanmış reklam kapsülü listesi. |
stream_id |
stringStreamID, bu izleyicinin mevcut akışının benzersiz tanımlayıcısıdır. |
media_verification_url |
stringMediaVerificationURL, aşağıda açıklanan reklam medyası doğrulama isteklerinde kullanılacak URL ön ekidir. İstemci taraflı işaretleme akışlarında yoktur. |
pod_metadata |
object(PodMetadata)PodMetadata, kapsülün cihazda oluşturulması ve doğrulamanın tetiklenmesi için gereken ek bilgileri içerir. Dinamik Reklam Ekleme Doğrusal API belgelerinde açıklandığı gibi. Yalnızca istemci tarafı işaretleme akışları için dahil edilir. |
metadata_url |
stringMetadataURL, adpod meta verilerini istemek için kullanılacak meta veri URL'sidir. |
AdPod
AdPod, oynatmaya hazır, karar verilmiş bir reklam arasını temsil eder.| JSON gösterimi |
|---|
{ "manifest_uris": map[string, string], "multivariant_uri": string, "mpd_uri": string, "manifests": map[string, string], "multivariant_manifest": string, "mpd_manifest": string, "asset_list_uri": string, "start": number, "duration": number, "type": string, "midroll_index": number, } |
| Alanlar | |
|---|---|
manifest_uris |
stringManifestURIs, HLS içeriği için kodlama profili adından HLS varyantı manifest_uris'e giden bir haritadır. |
multivariant_uri |
stringMultivariantURI, HLS içeriği için çok değişkenli manifest'in URI'sidir. |
mpd_uri |
stringMPDURI, DASH içeriği için MPD'nin URI'sidir. |
manifests |
stringManifests, kodlama profili adının HLS varyantı manifestiyle eşlendiği bir haritadır. Yalnızca akışta enable_inline_manifests doğru olarak ayarlanmışsa doldurulur. |
multivariant_manifest |
stringMultivariantManifest, HLS içeriği için çok değişkenli manifesttir. Yalnızca akışta enable_inline_manifests doğru olarak ayarlanmışsa doldurulur. |
mpd_manifest |
stringMPDManifest, DASH içeriği için MPD manifestidir. Yalnızca akışta enable_inline_manifests doğru olarak ayarlanmışsa doldurulur. |
asset_list_uri |
stringAssetListURI, HLS içeriği için HLS geçiş reklamı öğesi listesinin URI'sidir. Yalnızca akışta HLS öğe listesi reklamları etkinse doldurulur. |
start |
numberÖnceki reklam kapsülleri hariç olmak üzere, öğe zaman çizelgesinde reklam kapsülünün başlangıç zamanı (kayan noktalı saniye cinsinden). |
duration |
numberReklam kapsülünün kayan noktalı saniye cinsinden süresi. |
type |
stringReklam arası türü. |
midroll_index |
numberVMAP reklam arası kimliğine göre bir akıştaki videonun ortasında gösterilen reklamların 1 tabanlı dizini. Videodan önce ve sonra gösterilen reklamlar için atlanır. |
AdPodDecisionOptions
AdPodDecisionOptions, akış için ek seçenekleri temsil eder.| JSON gösterimi |
|---|
{
"dash_profile": string,
"match_options": object(MatchOpts),
"data_sharing_policy_code": string,
"sam_id": string,
"session_title": string,
"dash_inband_event_stream": boolean,
"distinct_ad_profiles": boolean,
} |
| Alanlar | |
|---|---|
dash_profile |
stringKullanılacak MPEG-DASH profili: "live" (canlı) veya "on-demand" (isteğe bağlı). |
match_options |
object(MatchOpts) |
data_sharing_policy_code |
stringYayıncıların, ağın varsayılan veri paylaşımı politikasını geçersiz kılmasına olanak tanır. |
sam_id |
stringsam_id, oturumun SAM hata ayıklama anahtarıdır ve isteğe bağlıdır. |
session_title |
stringsession_title, akış için SAM oturum başlığıdır ve isteğe bağlıdır. |
dash_inband_event_stream |
booleandash_inband_event_stream, DAI'nin ID3 mesajlarını EventStream öğeleri (manifest içinde) olarak değil, InbandEventStream öğesini kullanarak bant içi etkinlikler (medya içinde) olarak eklediğini gösterir. |
distinct_ad_profiles |
booleanDoğru olarak ayarlanırsa sunucunun, istenen kodlama profilleriyle eşleştirme yaparken mevcut reklam profillerini en fazla bir kez kullanacağını belirtir. |
Akış
Akış, yeni oluşturulan bir akışla ilgili tüm kaynakların listesini JSON biçiminde oluşturmak için kullanılır .| JSON gösterimi |
|---|
{
"stream_id": string,
"valid_for": string,
"valid_until": string,
"media_verification_url": string,
} |
| Alanlar | |
|---|---|
stream_id |
stringAkış tanımlayıcısı. |
valid_for |
stringSüre akışı, "00s00dk00sn" biçiminde geçerlidir. |
valid_until |
stringAkışın geçerli olduğu tarih (RFC 3339 biçiminde). |
media_verification_url |
stringMedya doğrulama URL'si. |
Simge
Simge, VAST simgesiyle ilgili bilgiler içerir.| 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 bilgileri içerir.| JSON gösterimi |
|---|
{
"url": string,
} |
| Alanlar | |
|---|---|
url |
string |
FallbackImage
FallbackImage, VAST yedek resmiyle ilgili bilgileri 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ı, sarmalayıcı reklamla ilgili bilgiler içerir. Yoksa anlaşma kimliği içermez.| JSON gösterimi |
|---|
{
"system": string,
"ad_id": string,
"creative_id": string,
"creative_ad_id": string,
"deal_id": string,
} |
| Alanlar | |
|---|---|
system |
stringReklam sistemi tanımlayıcısı. |
ad_id |
stringSarmalayıcı reklam için kullanılan reklam kimliği. |
creative_id |
stringSarmalayıcı reklam için kullanılan reklam öğesi kimliği. |
creative_ad_id |
stringSarmalayıcı reklam için kullanılan reklam öğesi reklam kimliği. |
deal_id |
stringSarmalayıcı reklam için isteğe bağlı anlaşma kimliği. |
Doğrulama
Doğrulama, üçüncü taraf görüntülenebilirlik ve doğrulama ölçümünü kolaylaştıran Open Measurement ile ilgili bilgileri içerir. Şu anda yalnızca JavaScript kaynakları desteklenmektedir. https://iabtechlab.com/standards/open-measurement-sdk/ adresine göz atın.| JSON gösterimi |
|---|
{
"vendor": string,
"java_script_resources": [object(JavaScriptResource)],
"tracking_events": [object(TrackingEvent)],
"parameters": string,
} |
| Alanlar | |
|---|---|
vendor |
stringDoğrulama tedarikçisi. |
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 |
stringBootstrap doğrulama koduna iletilen opak dize. |
JavaScriptResource
JavaScriptResource, JavaScript aracılığıyla doğrulama için bilgi içerir.| JSON gösterimi |
|---|
{
"script_url": string,
"api_framework": string,
"browser_optional": boolean,
} |
| Alanlar | |
|---|---|
script_url |
stringJavaScript yükü için URI. |
api_framework |
stringAPIFramework, doğrulama kodunu kullanan video çerçevesinin adıdır. |
browser_optional |
booleanBu komut dosyasının tarayıcı dışında çalıştırılıp çalıştırılamayacağı. |
TrackingEvent
TrackingEvent, belirli durumlarda istemci tarafından ping gönderilmesi gereken URL'ler içerir.| JSON gösterimi |
|---|
{
"event": string,
"uri": string,
} |
| Alanlar | |
|---|---|
event |
stringİzleme etkinliğinin türü. |
uri |
stringPing gönderilecek izleme etkinliği. |
UniversalAdID
UniversalAdID, reklam sistemlerinde korunan benzersiz bir reklam öğesi tanımlayıcısı sağlamak için kullanılır.| JSON gösterimi |
|---|
{ "id_value": string, "id_registry": string, } |
| Alanlar | |
|---|---|
id_value |
stringReklam için seçilen reklam öğesinin Evrensel Reklam Kimliği. |
id_registry |
stringSeçilen reklam öğesinin evrensel reklam kimliğinin kataloglandığı kayıt kuruluşu web sitesinin URL'sini tanımlamak için kullanılan dize. |
Tamamlayıcı
Companion, reklamla birlikte gösterilebilecek tamamlayıcı reklamlarla ilgili bilgileri içerir.| 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ı reklam öğesinin tıklama verileri. |
creative_type |
stringBu, statik türde bir tamamlayıcı ise VAST'taki <StaticResource> düğümünde CreativeType özelliği. |
height |
int32Bu tamamlayıcı öğenin piksel cinsinden yüksekliği. |
width |
int32Bu tamamlayıcının piksel cinsinden genişliği. |
resource |
stringStatik ve iframe eşlikçiler için bu, yüklenecek ve gösterilecek URL'dir. HTML tamamlayıcılar için bu, tamamlayıcı olarak gösterilmesi gereken HTML snippet'idir. |
type |
stringBu tamamlayıcının türü. Statik, iFrame veya HTML olabilir. |
ad_slot_id |
stringBu eşlik eden öğenin yuva kimliği. |
api_framework |
stringBu eşlikçi için API çerçevesi. |
tracking_events |
[object(TrackingEvent)]Bu eşlikçiyle ilgili izleme etkinliklerinin listesi. |
InteractiveFile
InteractiveFile, reklam oynatma sırasında gösterilmesi gereken etkileşimli reklam öğesi (ör. SIMID) bilgilerini içerir.| JSON gösterimi |
|---|
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, } |
| Alanlar | |
|---|---|
resource |
stringEtkileşimli reklam öğesinin URL'si. |
type |
stringKaynak olarak sağlanan dosyanın MIME türü. |
variable_duration |
booleanBu reklam öğesinin sürenin uzatılmasını isteyip istemediği. |
ad_parameters |
stringVAST'taki <AdParameters> düğümünün değeri. |