Dinamik Reklam Ekleme kapsül yayınlama VOD API'si

Dinamik Reklam Ekleme API'si, DAI isteğe bağlı 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 metni

İstek gövdesi application/json türündedir ve CreateStreamRequest nesnesi içermelidir.

Yanıt metni

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 akışı kaydeder. Böylece, istemci uygulamasının reklamları izlemesi ve kullanıcı arayüzü öğelerini görüntülemesi için gereken tüm kaynaklar döndürülü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 metni

İstek gövdesi application/json türündedir ve StreamRegistrationRequest nesnesi içermelidir.

Yanıt metni

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 metni

İstek gövdesi application/json türündedir ve AdPodDecisionRequest nesnesi içermelidir.

Yanıt metni

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üllerinin meta verilerini alın. Bu URL, StreamRegistrationResponse metadata_url özelliğinde döndürülür.

HTTP isteği

GET: /ondemand/pods/api/v1/network/.../metadata

Yanıt metni

Başarılı olursa yanıt gövdesi, Ad pods metadata nesnesini 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 eklenmiş reklam arası haritası.
polling_frequency number

Önerilen meta veri URL'si yoklama sıklığı (saniye cinsinden). Seç-izle karar verme özelliği kullanılarak VOD yayınları için doldurulur.

TagSegment

TagSegment, bir reklama, reklam arasına ve etkinlik türüne referans içerir. TagSegment with type="progress" (TagSegment with type="progress") türündeki TagSegment, reklam medyası doğrulama uç noktasına pinglenmemelidir.
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, 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 string

Geçerli sayfa/sütun sonu türleri şunlardır: pre, mid ve post.
duration number

Bu reklam arası için toplam reklam süresi (saniye).
expected_duration number

Tüm reklamlar ve seçenek listesi dahil olmak üzere reklam arasının beklenen süresi (saniye).
ads number

Reklam arasındaki reklam sayısı.
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 string

Bu reklamın reklam arasının kimliği.
position number

Bu reklamın reklam arasındaki konumu (1'den başlar).
duration number

Reklamın süresi (saniye).
title string

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

İsteğe bağlı reklam açıklaması.
advertiser string

İsteğe bağlı reklamveren kimliği.
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ı Open Measurement doğrulama girişleri. Bu girişler, reklam öğesi oynatmayı doğrulamak için kullanılır.
slate boolean

Mevcut girişin slate olup olmadığını belirten isteğe bağlı boole değeri.
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 string

VAST'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 oynatma sırasında 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. Oluşturulan yayın, VTP'nin birleştireceği karar verilmiş reklam kapsülleriyle sonuçlanır. Bu, bir akışı kaydeden ve birden fazla istekte reklam kapsülleri için karar veren StreamRegistrationRequest+AdPodDecisionRequest akışının aksine bir durumdur.
JSON gösterimi
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "dai_options": object(CreateStreamOptions),
}
Alanlar
encoding_profiles [object(EncodingProfile)]

Kodlama profillerinin listesi. Zorunlu.
ad_tag string

Karar verme için temel reklam etiketi. Zorunlu.
cuepoints number

Saniye cinsinden ipucu noktalarının listesi. Reklam etiketinin yanıtında konumsal zaman farkları kullanıldığında gereklidir.
manifest_type string

Geçerli manifest türleri şunlardır: hls ve dash. Varsayılan: hls. İsteğe bağlıdır.
targeting_parameters string

Ek Ad Manager hedefleme parametreleri. İsteğe bağlıdır.
content_duration_seconds number

ContentDurationSeconds, içeriğin saniye cinsinden süresidir. Reklam etiketinin yanıtında zaman farkı yüzdeleri kullanıldığında gereklidir.
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 string

Kullanılacak MPEG-DASH profili: "live" (canlı) veya "on-demand" (isteğe bağlı).
match_options object(MatchOpts)

data_sharing_policy_code string

Yayıncıların, ağın varsayılan veri paylaşımı politikasını geçersiz kılmasına olanak tanır.
sam_id string

sam_id, oturumun SAM hata ayıklama anahtarıdır (isteğe bağlı).
session_title string

session_title, akışın SAM oturum başlığıdır ve isteğe bağlıdır.
dash_inband_event_stream boolean

dash_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 boolean

Doğru olarak ayarlanırsa sunucunun, istenen kodlama profillerini eşleştirirken mevcut reklam profillerini en fazla bir kez kullanacağını belirtir.
tracking_mode string

tracking_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 uint32

emsg_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, bir akış oluşturan ve tek bir istekte 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 string

Ek 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 string

sam_id, oturumun SAM hata ayıklama anahtarıdır (isteğe bağlı).
tracking_mode string

tracking_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 uint32

emsg_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 boolean

Atlanabilir 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 pakete dahildir. Akış kimliğine sonraki bir reklam grubu kararı isteğinde referans verilebilir. Bu, aynı anda bir akış oluşturma ve reklam kapsülleri için karar verme yanıtını temsil eden 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 string

StreamID, bu izleyicinin mevcut akışının benzersiz tanımlayıcısıdır.
media_verification_url string

MediaVerificationURL, aşağıda açıklanan reklam medyası doğrulama isteklerinde kullanılacak URL önekidir. İstemci tarafı işaretleme akışlarında yoktur.
valid_for string

ValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder.
valid_until string

ValidUntil, bu akışın geçerli olduğu tarih ve saattir.
metadata_url string

MetadataURL, 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,
}
Alanlar
type string

Tür, yayın için ne zaman reklam kapsüllerine karar verileceğ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 reklamlar için karar verilir.

EncodingProfile

EncodingProfile, tek bir içerik varyantının kodlamasını açıklar. Yalnızca video ayarlarını, yalnızca ses ayarlarını (medya türü söz konusu olduğunda), hem video hem de ses ayarlarını veya altyazılar söz konusu olduğunda hiçbirini 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 string

Profile yayıncı tarafından sağlanan ad. Her akış için benzersizdir. Zorunlu.
type string

Geçerli türler: media, iframe, subtitles. Zorunlu.
container_type string

Geç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, bu bölümler yalnızca profilde video varsa gösterilir.
audio_settings object(AudioSettings)

Profilde ses varsa ses ayarları gösterilir. Ses ayarlarına yalnızca kapsayıcı türü medya ise izin verilir.
subtitle_settings object(SubtitleSettings)

Yazarak altyazı oluşturmak için altyazı ayarları gereklidir.

VideoSettings

VideoSettings, bir kodlama profilinin videosunu açıklar. 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 string

Videonun RFC6381 codec dizesi.
bitrate int32

Kodlama profilinin maksimum video bit hızı.
frames_per_second number

Videonun 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 string

Sesin RFC6381 codec dizesi.
bitrate int32

Kodlama profilinin maksimum ses bit hızı.
channels int32

Ses kanallarının sayısı (düşük frekanslı kanallar dahil).
sample_rate int64

Sesin örnekleme hızı (hertz cinsinden).

SubtitleSettings

SubtitleSettings, kodlama profillerinin altyazılarını açıklar.
JSON gösterimi
{
  "format": string,
  "language": string,
}
Alanlar
format string

Altyazı biçimi: hls için webvtt, dash için webvtt veya ttml.
language string

Manifeste eklenecek dil.

Çözünürlük

Çözünürlük, videonun genişlik x yüksekliğini ifade eder.
JSON gösterimi
{
  "width": int32,
  "height": int32,
}
Alanlar
width int32

Videonun piksel cinsinden genişliği. Zorunlu.
height int32

Videonun piksel cinsinden yüksekliği. Zorunlu.

AdPodDecisionRequest

AdPodDecisionRequest, daha önce kaydedilmiş bir yayın 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,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "dai_options": object(AdPodDecisionOptions),
}
Alanlar
encoding_profiles [object(EncodingProfile)]

Kodlama profillerinin listesi. Zorunlu.
ad_tag string

Karar verme için temel reklam etiketi. Zorunlu.
cuepoints number

Saniye cinsinden ipucu noktalarının listesi. Reklam etiketinin yanıtında konumsal zaman farkları kullanıldığında gereklidir.
manifest_type string

Geçerli manifest türleri şunlardır: hls ve dash. Varsayılan: hls. İsteğe bağlıdır.
targeting_parameters string

Ek Ad Manager hedefleme parametreleri. İsteğe bağlıdır.
content_duration_seconds number

ContentDurationSeconds, içeriğin saniye cinsinden süresidir. Reklam etiketinin yanıtında zaman farkı yüzdeleri kullanıldığında gereklidir.
dai_options object(AdPodDecisionOptions)

Reklam kapsülü kararı için DAIOptions.

AdPodDecisionResponse

AdPodDecisionResponse, daha önce kaydedilmiş bir yayın için reklam kapsülü kararlarına verilen yanıtı temsil eder. Bu akış için belirlenen reklam kapsüllerinin listesini içerir.
JSON gösterimi
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Alanlar
valid_for string

ValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder.
valid_until string

ValidUntil, 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 string

ValidFor, bu akışın geçerli olduğu süreyi "00h00m00s" biçiminde ifade eder.
valid_until string

ValidUntil, 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 string

StreamID, bu izleyicinin mevcut akışının benzersiz tanımlayıcısıdır.
media_verification_url string

MediaVerificationURL, aşağıda açıklanan reklam medyası doğrulama isteklerinde kullanılacak URL önekidir. İstemci tarafı işaretleme akışlarında yoktur.
pod_metadata object(PodMetadata)

PodMetadata, pod'un 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 string

MetadataURL, 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],
  "mpd_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Alanlar
manifest_uris string

ManifestURIs, HLS içeriği için kodlama profili adının HLS varyantı manifest_uris ile eşlendiği bir haritadır.
mpd_uri string

MPDURI, DASH içeriği için MPD'nin URI'sidir.
start number

Kayan noktalı saniye cinsinden, öğe zaman çizelgesindeki reklam kapsülünün başlangıç zamanı (önceki reklam kapsülleri hariç).
duration number

Reklam kapsülünün kayan noktalı saniye cinsinden süresi.
type string

Reklam arası türü.
midroll_index number

VMAP ara kimliğine göre, 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 string

Kullanılacak MPEG-DASH profili: "live" (canlı) veya "on-demand" (isteğe bağlı).
match_options object(MatchOpts)

data_sharing_policy_code string

Yayıncıların, ağın varsayılan veri paylaşımı politikasını geçersiz kılmasına olanak tanır.
sam_id string

sam_id, oturumun SAM hata ayıklama anahtarıdır (isteğe bağlı).
session_title string

session_title, akışın SAM oturum başlığıdır ve isteğe bağlıdır.
dash_inband_event_stream boolean

dash_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 boolean

Doğru olarak ayarlanırsa sunucunun, istenen kodlama profillerini eşleştirirken mevcut reklam profillerini en fazla bir kez kullanacağını belirtir.

Akış

Stream, 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 string

Akış tanımlayıcısı.
valid_for string

Süre akışı, "00h00m00s" biçiminde geçerlidir.
valid_until string

Akışın geçerli olduğu tarih (RFC 3339 biçiminde).
media_verification_url string

Medya doğrulama URL'si.

Simge

Icon, VAST simgesiyle ilgili bilgileri 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, bir 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 bilgileri içerir. Mevcut değilse 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 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, üçü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 string

Doğ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 string

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

JavaScriptResource

JavaScriptResource, JavaScript aracılığıyla doğrulama için 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, doğrulama kodunu kullanan video çerçevesinin adıdır.
browser_optional boolean

Bu 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 string

Ping 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 string

Reklam için seçilen reklam öğesinin Evrensel Reklam Kimliği.
id_registry string

Seçilen reklam öğesinin Evrensel Reklam Kimliğinin kataloglandığı kayıt otoritesi web sitesinin url'sini tanımlamak için kullanılan dize.

Tamamlayıcı

Tamamlayıcı, reklamla birlikte görüntülenebilecek 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 string

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

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

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

Statik ve iframe eşlikçiler için bu, yüklenecek ve görüntülenecek URL'dir. HTML tamamlayıcılar için bu, tamamlayıcı olarak gösterilmesi gereken HTML snippet'idir.
type string

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

Bu eşlik eden öğenin yer kimliği.
api_framework string

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

Bu eşlikçiyle ilgili izleme etkinliklerinin listesi.

InteractiveFile

InteractiveFile, reklam oynatımı 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 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 istemediği.
ad_parameters string

VAST'taki <AdParameters> düğümünün değeri.