REST Resource: adBreak.networks.assets.adBreaks

Kaynak: AdBreak

Canlı video etkinliğindeki bir reklam arası için reklam kararı vermek üzere kullanılan reklam arası meta verileri.

JSON gösterimi 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
Alanlar
name

string

Yalnızca çıkış. Reklam arasının kaynak adı. Bu alan "networks//assets//adBreaks/" biçiminde olur.

network_code, bu içeriğin ait olduğu Google Ad Manager'daki ağ kodudur.

asset_key, Google Ad Manager'da reklam arasının oluşturulduğu Canlı Yayın Etkinliği'nin anahtarıdır.

adBreakId, reklam arasının anahtarıdır. YALNIZCA ÇIKIŞ.
createTime

string (Timestamp format)

Yalnızca çıkış. Reklam arasının oluşturulma zamanı.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Zorunlu. Beklenen mola süresi.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
customParams
(deprecated)

string

İsteğe bağlı. Ad Manager'daki özel ölçüt hedefleme için bu arayla ilgili reklam isteklerine dahil edilecek anahtar/değer çiftleri. Örnek: "key1=value&key2=value2,value22" Desteği sonlandırıldı: Lütfen "cust_params" anahtarını kullanarak cust_params'ı breakParams.ad_tag_params içinde ayarlayın.
scte35CueOut

string

İsteğe bağlı. Base64 kodlu scte35 işaret çıkışı verileri. splice_insert() veya time_signal() komutunu içerebilir. Örnekler: - time_signal() ile: "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - splice_insert() ile: "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

İsteğe bağlı. Google Ad Manager kapsül şablonu adı. Desteği sonlandırıldı: Lütfen "ptpln" anahtarını kullanarak breakParams.ad_tag_params içinde cust_params'i ayarlayın.
breakState

enum (BreakState)

Yalnızca çıkış. Reklam arasının mevcut durumu.
expectedStartTime

string (Timestamp format)

İsteğe bağlı. Reklam arasının beklenen başlangıç zamanı.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

İsteğe bağlı. Reklam arasının süresini expectedStartTime + expireDuration'da sona erdirir. expectedStartTime ayarlanmamışsa reklam arası, karar verme işlemi başladıktan sonra expireDuration süresi dolduğunda sona erer. Varsayılan: 30 dakika Minimum: 5 dakika Maksimum: 6 saat

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
breakSequence

string (int64 format)

Yalnızca çıkış. Reklam arasının videonun ortasında gösterilen reklam sırası kimliği. breakParams.ad_tag_params aracılığıyla mridx anahtarıyla açıkça belirtilmişse birden fazla reklam arası aynı breakSequence'e sahip olabilir. Bu işlem, iki GAM reklam arasını etkili bir şekilde bağlar.
breakParams

object (BreakParams)

İsteğe bağlı. Bu arayla ilgili reklam isteklerine eklenecek ara parametreleri.
matchParams

object (MatchParams)

İsteğe bağlı. API aracılığıyla oluşturulan bir reklam arasının, manifestteki bir reklam arasıyla nasıl eşleştirileceğini belirlemek için Stitched DAI'de kullanılır. Yeni bir ara algılandığında, bir etkinliğin SCHEDULED veya DECISIONED breakState'ine sahip tüm reklam aralarıyla eşleşme işlevi çalıştırılarak bir reklam arasının matchParams'indeki tüm ayarlanmış parametrelerin algılanan ara ile eşleşip eşleşmediği kontrol edilir. Aşağıdaki koşullardan biri karşılanırsa eşleşme gerçekleşir: 1. Reklam arasında bir matchParams alanı var ve bu alanda ayarlanan tüm parametreler yeni arayla eşleşiyor. 2. Reklam arası DECISIONED ve matchParams alanı yok.

Yanlışlıkla "tümüyle eşleşme" davranışını (boş ancak mevcut bir matchParams ile oluşur) önlemek için, ayarlanmışsa matchParams boş olamaz. Alan bir istekte varsa kendi alanlarından en az biri ayarlanmalıdır.

Reklam araları şu sırayla kontrol edilir: 1. matchParams ile, artan expectedStartTime ve artan createTime'a göre sıralanır. Burada, sıralandığında expectedStartTime'ı olmayan reklam aralarına öncelik verilir. 2. matchParams olmadan, artan expectedStartTime ve artan createTime'a göre sıralanır. Burada, sıralandığında expectedStartTime'ı olmayan reklam aralarına öncelik verilir.

Bekleyen tüm EABN'ler eşleşmezse DAI, bir sonraki kullanılabilir orta rulo dizinini kullanarak JIT karar verme davranışına geri döner.
servedBreak

object (ServedBreak)

Yalnızca çıkış. Bu, yayınlanan reklam arasının gerçek bilgilerini yansıtır. Yalnızca COMPLETE breakState içeren reklam araları için ayarlanır.

BreakState

Reklam arasının durumu.

Sıralamalar
BREAK_STATE_UNSPECIFIED Reklam arası durumu bilinmiyor.
BREAK_STATE_DECISIONED Reklam arası kararı verilmeye başlandı ancak henüz kullanıcılara sunulmadı.
BREAK_STATE_COMPLETE Reklam arası kullanıcılara sunuldu.
BREAK_STATE_SCHEDULED Reklam arası, karar verme için planlanmıştır.
BREAK_STATE_EXPIRED Reklam arasının süresi dolmuş ve kullanılamıyor. Varsayılan olarak, reklam aralarının süresi expectedStartTime'dan 30 dakika sonra veya expectedStartTime ayarlanmamışsa reklam arası karar verme işlemi başladıktan 30 dakika sonra dolar. expireDuration alanı kullanılarak geçerlilik süresi açıkça ayarlanabilir.

BreakParams

Reklam arasıyla ilişkili parametreler.

JSON gösterimi 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Alanlar
macros[]

object (KeyValue)

İsteğe bağlı. Reklam etiketindeki rastgele bir yer tutucunun yerine geçen özel makro değerleri. DAI, reklam isteği sırasında %%DAI_PATTERN:[MACRO_KEY]%% biçimindeki reklam etiketi makrolarını genişletir. Burada MACRO_KEY anahtardır.

Bu makrolar ayarlanırsa Pod Serving isteğinde ayarlanan makrolara göre öncelikli olur.
adTagParams[]

object (KeyValue)

İsteğe bağlı. Birincil reklam isteğindeki reklam etiketi parametrelerini geçersiz kılar.

Bunlar, cust_params ayarlanmış pod yayınlama isteklerinden önce tetiklenirse karar verme için kullanılır.

Genellikle parametreler, araya ekleme için birincil reklam isteğindeki sorgu dizesi parametresini geçersiz kılar. Özel URL biçimlerine sahip bazı reklam sunucularında, parametreler reklam sunucusu koşullarına uymak için reklam etiketindeki belirli yerleri geçersiz kılabilir. AdBreak'te "mridx" değerinin ayarlanması, geçerli bir pozitif tam sayı olması durumunda breakSequence alanını sağlanan değerle geçersiz kılar. Bu durum, GAM dışı reklam sunucuları için de geçerlidir.

Ayarlanırsa bu parametreler, bir pod yayınlama isteğinde ayarlanan parametrelere göre öncelikli olur.

KeyValue

Anahtar/değer çiftini temsil eder.

JSON gösterimi 
{
  "key": string,
  "value": string
}
Alanlar
key

string

Zorunlu. Bu anahtar/değer çiftinin anahtarı.
value

string

Zorunlu. Bu anahtar/değer çiftinin değeri.

MatchParams

Algılanan bir birleştirilmiş DAI reklam arasıyla eşleşecek parametreler.

JSON gösterimi 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Alanlar
scte35Binary

string

İsteğe bağlı. SCTE-35 ikili. Bu alanla eşleşmesi için manifest içi reklam arasının aynı SCTE-35 ikili dizesine (base64 kodlu) sahip olması gerekir. Boşsa bu adım atlanır.
scte35Upid

string

İsteğe bağlı. SCTE-35 UPID (Benzersiz Program Tanımlayıcısı). Bu alanla eşleşmesi için manifestteki reklam arasının aynı SCTE-35 UPID'ye sahip olması gerekir. UPID, SCTE-35 ikili programından ayrıştırılan bir değerdir. Boşsa bu adım atlanır.
scte35EventId

integer (uint32 format)

İsteğe bağlı. SCTE-35 etkinlik kimliği. Bu alanın eşleştirilmesi için manifest içi reklam arasına aynı etkinlik kimliği (birleştirme etkinliği kimliği/segmentasyon etkinliği kimliği) atanmış olmalıdır. Etkinlik kimliği, SCTE-35 ikilisinden ayrıştırılan bir değerdir. Boşsa bu adım atlanır.
breakDuration

boolean

İsteğe bağlı. Ara süresi. Bu alanın eşleşmesi için manifest içi reklam arası, reklam arasının expectedDuration'ı ile aynı ara süresine sahip olmalı ve 1 ms tolerans göstermelidir. Yanlışsa bu adım atlanır.

ServedBreak

Yayınlanan reklam arasıyla ilgili gerçek bilgileri gösterir.

JSON gösterimi 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Alanlar
breakDetectTime

string (Timestamp format)

Yalnızca çıkış. Eşleşen reklam arasının algılandığı zaman. Kapsül yayınlama için bu, reklam kapsülünün ilk segmentinin/manifestinin istendiği zamandır. Birleştirilmiş DAI için bu, reklam arasının manifestte ilk kez algılandığı zamandır.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

Yalnızca çıkış. Eşleşen reklam arasında algılanan süre.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".
scte35CueOut

string

Yalnızca çıkış. Eşleşen reklam arasında iletilen, base64 ile kodlanmış SCTE-35 mesajı algılandı.

Yöntemler

create

 Canlı yayın içinde reklam arası oluşturmak için kullanılan API.

delete

 Canlı yayındaki reklam arasını silmek için kullanılan API.

get

 Canlı yayında reklam arası almak için kullanılan API.

list

 Canlı yayın içindeki reklam aralarını listeleyen API.

patch

 Canlı yayındaki bir reklam arasını güncellemek için kullanılan API.