REST Resource: adBreak.networks.customAssets.adBreaks

Zasób: AdBreak

Metadane przerwy na reklamę używane do podejmowania decyzji o reklamach w przerwie podczas wydarzenia wideo na żywo.

Zapis JSON 
{
  "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)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu przerwy na reklamę. To pole będzie miało format „networks//assets//adBreaks/”.

network_code to kod sieci w Google Ad Managerze, do której należą te treści.

asset_key to klucz wydarzenia transmisji na żywo w Google Ad Manager, w ramach którego utworzono przerwę na reklamę.

adBreakId to klucz przerwy na reklamę. TYLKO DANE WYJŚCIOWE.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia przerwy na reklamę.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

Wymagane. Oczekiwany czas trwania przerwy.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
customParams
(deprecated)

string

Opcjonalnie. Pary klucz-wartość, które mają być uwzględniane w żądaniach reklamy na potrzeby tej przerwy, używane w ramach kierowania według niestandardowych kryteriów w usłudze Ad Manager. Przykład: „key1=value&key2=value2,value22” Wycofano: ustaw parametr cust_params w breakParams.ad_tag_params za pomocą klucza „cust_params”.
scte35CueOut

string

Opcjonalnie. Dane zakodowane w formacie Base64 z sygnału SCTE-35. Mogą zawierać polecenie splice_insert() lub time_signal(). Przykłady: – z time_signal(): „/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” – z splice_insert(): „/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

Opcjonalnie. Nazwa szablonu bloku reklamowego Google Ad Managera. Wycofano: ustaw parametr cust_params w parametrze breakParams.ad_tag_params za pomocą klucza „ptpln”.
breakState

enum (BreakState)

Tylko dane wyjściowe. Bieżący stan przerwy na reklamę.
expectedStartTime

string (Timestamp format)

Opcjonalnie. Oczekiwany czas rozpoczęcia przerwy na reklamę.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

Opcjonalnie. Wygasza przerwę na reklamę w momencie expectedStartTime + expireDuration. Jeśli wartość expectedStartTime nie jest ustawiona, przerwa na reklamę wygaśnie po upływie czasu expireDuration od rozpoczęcia procesu decyzyjnego. Domyślnie: 30 minut. Minimum: 5 minut. Maksimum: 6 godzin.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „s”. Przykład: "3.5s".
breakSequence

string (int64 format)

Tylko dane wyjściowe. Identyfikator sekwencji reklamy w trakcie filmu w przerwie na reklamę. Wiele przerw na reklamę może mieć ten sam numer breakSequence, jeśli zostanie to wyraźnie określone w parametrze breakParams.ad_tag_params za pomocą klucza mridx. W ten sposób połączysz 2 przerwy na reklamy w GAM.
breakParams

object (BreakParams)

Opcjonalnie. Parametry przerwy, które mają być uwzględniane w żądaniach reklamy dotyczących tej przerwy.
matchParams

object (MatchParams)

Opcjonalnie. Używany w przypadku DAI z zszywaniem do określania, jak przerwa na reklamę utworzona za pomocą interfejsu API jest dopasowywana do przerwy na reklamę w pliku manifestu. Gdy zostanie wykryta nowa przerwa, funkcja dopasowania zostanie uruchomiona w przypadku wszystkich przerw na reklamę w wydarzeniu, które mają stan przerwy SCHEDULED lub DECISIONED, aby sprawdzić, czy wszystkie parametry ustawione w parametrach dopasowania przerwy na reklamę pasują do wykrytej przerwy. Dopasowanie następuje, gdy spełniony jest jeden z tych warunków: Przerwa na reklamę ma pole matchParams, a wszystkie ustawione w nim parametry pasują do nowej przerwy. 2. Przerwa na reklamę to DECISIONED i nie ma pola matchParams.

Aby zapobiec przypadkowemu zachowaniu „dopasuj wszystko” (które wystąpiłoby w przypadku pustego, ale obecnego parametru matchParams), parametr matchParams nie może być pusty, jeśli jest ustawiony. Jeśli pole występuje w żądaniu, musi być ustawione co najmniej jedno z jego pól.

Przerwy na reklamy są sprawdzane w tej kolejności: 1. z parametrem matchParams, uporządkowane według rosnącej wartości expectedStartTime i rosnącej wartości createTime, przy czym przerwy na reklamy bez parametru expectedStartTime są traktowane priorytetowo podczas sortowania; 2. bez parametru matchParams, uporządkowane według rosnącej wartości expectedStartTime i rosnącej wartości createTime, przy czym przerwy na reklamy bez parametru expectedStartTime są traktowane priorytetowo podczas sortowania.

Jeśli wszystkie oczekujące EABN nie pasują, DAI powróci do zachowania związanego z podejmowaniem decyzji w czasie rzeczywistym, wykorzystując następny dostępny indeks reklamy w trakcie filmu.
servedBreak

object (ServedBreak)

Tylko dane wyjściowe. Odzwierciedla to rzeczywiste informacje o wyświetlonej przerwie na reklamę. Ustawiaj tylko w przypadku przerw na reklamy ze stanem COMPLETE breakState.

Metody

create

 Interfejs API do tworzenia przerwy na reklamę w transmisji na żywo.

delete

 Interfejs API do usuwania przerwy na reklamę w transmisji na żywo.

get

 Interfejs API do pobierania przerwy na reklamę w transmisji na żywo.

list

 API do wyświetlania przerw na reklamy w transmisji na żywo.

patch

 Interfejs API do aktualizowania przerwy na reklamę w transmisji na żywo.