REST Resource: adBreak.networks.assets.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. Może 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 kolejny 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.

BreakState

Stan przerwy na reklamę.

Wartości w polu enum
BREAK_STATE_UNSPECIFIED Stan przerwy na reklamę jest nieznany.
BREAK_STATE_DECISIONED Proces podejmowania decyzji dotyczących przerw na reklamy został rozpoczęty, ale nie został jeszcze dostarczony użytkownikom.
BREAK_STATE_COMPLETE Blok reklamowy został wyświetlony użytkownikom.
BREAK_STATE_SCHEDULED Przerwa na reklamę jest zaplanowana do podjęcia decyzji.
BREAK_STATE_EXPIRED Przerwa na reklamę wygasła i nie można jej użyć. Domyślnie przerwy na reklamę wygasają 30 minut po wartości expectedStartTime lub 30 minut po rozpoczęciu podejmowania decyzji o przerwie na reklamę, jeśli wartość expectedStartTime nie jest ustawiona. Czas wygaśnięcia można ustawić w polu expireDuration.

BreakParams

Parametry powiązane z przerwą na reklamę.

Zapis JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
Pola
macros[]

object (KeyValue)

Opcjonalnie. Wartości makr niestandardowych, które zastępują dowolny symbol zastępczy w tagu reklamy. W momencie żądania reklamy DAI rozwinie makra tagu reklamy w formacie %%DAI_PATTERN:[MACRO_KEY]%%, gdzie MACRO_KEY to klucz.

Jeśli są ustawione, te makra mają pierwszeństwo przed makrami ustawionymi w żądaniu wyświetlania poda.
adTagParams[]

object (KeyValue)

Opcjonalnie. Zastępuje parametry tagu reklamy w podstawowym żądaniu reklamy.

Są one używane do podejmowania decyzji, jeśli są wywoływane przed żądaniami obsługi zasobów z ustawionym parametrem cust_params.

Zwykle parametry zastępują parametr ciągu zapytania w głównym żądaniu reklamy w przerwie. W przypadku niektórych serwerów reklam z niestandardowymi formatami adresów URL parametry mogą zastępować określone miejsca w tagu reklamy, aby spełniać wymagania serwera reklam. Ustawienie wartości „mridx” w obiekcie AdBreak spowoduje zastąpienie pola breakSequence podaną wartością, jeśli jest ona prawidłową dodatnią liczbą całkowitą. Dotyczy to nawet serwerów reklam innych niż GAM.

Jeśli te parametry są ustawione, mają one pierwszeństwo przed parametrami ustawionymi w żądaniu wyświetlania bloku reklamowego.

KeyValue

Reprezentuje parę klucz-wartość.

Zapis JSON 
{
  "key": string,
  "value": string
}
Pola
key

string

Wymagane. Klucz tej pary klucz-wartość.
value

string

Wymagane. Wartość tej pary klucz-wartość.

MatchParams

Parametry, które mają pasować do wykrytej przerwy na reklamę w dynamicznym wstawianiu reklam.

Zapis JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
Pola
scte35Binary

string

Opcjonalnie. SCTE-35 binary. Aby dopasować to pole, przerwa na reklamę w pliku manifestu musi mieć ten sam ciąg binarny SCTE-35 (zakodowany w formacie base64). Jeśli jest puste, jest pomijane.
scte35Upid

string

Opcjonalnie. UPID SCTE-35 (unikalny identyfikator programu). Aby to pole było zgodne, przerwa na reklamę w pliku manifestu musi mieć ten sam identyfikator UPID SCTE-35. UPID to wartość analizowana z binarnego kodu SCTE-35. Jeśli jest puste, jest pomijane.
scte35EventId

integer (uint32 format)

Opcjonalnie. Identyfikator zdarzenia SCTE-35. Aby dopasować to pole, przerwa na reklamę w pliku manifestu musi mieć ten sam identyfikator zdarzenia (identyfikator zdarzenia łączenia lub identyfikator zdarzenia segmentacji). Identyfikator zdarzenia to wartość, która jest analizowana z binarnego kodu SCTE-35. Jeśli jest puste, jest pomijane.
breakDuration

boolean

Opcjonalnie. Czas trwania przerwy. Aby to pole było zgodne, przerwa na reklamę w pliku manifestu musi mieć taką samą długość jak wartość expectedDuration przerwy na reklamę z tolerancją 1 ms. Jeśli ma wartość „fałsz”, ten krok jest pomijany.

ServedBreak

Zawiera rzeczywiste informacje o wyświetlonej przerwie na reklamę.

Zapis JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
Pola
breakDetectTime

string (Timestamp format)

Tylko dane wyjściowe. Czas wykrycia pasującej przerwy na reklamę. W przypadku wyświetlania bloków reklamowych jest to czas, w którym wysyłane jest żądanie pierwszego segmentu lub manifestu bloku reklamowego. W przypadku szytego DAI jest to moment, w którym przerwa na reklamy została po raz pierwszy wykryta w manifeście.

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".
detectedDuration

string (Duration format)

Tylko dane wyjściowe. Wykryty czas trwania przekazany w pasującej przerwie na reklamę.

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

string

Tylko dane wyjściowe. Wykryta wiadomość SCTE-35 zakodowana w formacie base64 przekazana w odpowiedniej przerwie na reklamę.

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.