Package google.ads.drx.video.v1

Indeks

AdBreakNotificationService

Usługa interfejsu API, która umożliwia wydawcom tworzenie przerw na reklamy w transmisji na żywo.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

interfejs API do tworzenia przerw na reklamę w transmisji na żywo;

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

VideoContentIngestionService

Usługa interfejsu API do przetwarzania treści, która umożliwia tworzenie i aktualizowanie treści wideo oraz powiązanych z nimi metadanych w Google Ad Managerze.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

interfejsu API do tworzenia nowych treści lub aktualizowania ich metadanych, jeśli treści znajdują się już w usłudze Ad Manager. Zwraca treść w przypadku powodzenia lub google.rpc.Code w przypadku niepowodzenia.

Przykładowe żądanie:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.

AdBreak

Metadane przerwy na reklamę używane do podejmowania decyzji o reklamach w trakcie przerwy na reklamę w zdarzeniu wideo na żywo.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu przerwy na reklamę. Pole będzie mieć format „networks//assets//adBreaks/”.

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

asset_key jest kluczem zdarzenia z transmisji na żywo w Zarządzaniu reklamami w Google, w ramach którego została utworzona przerwa na reklamę.

ad_break_id to klucz przerwy na reklamę. TYLKO DANE WYJŚCIOWE.
expected_duration

Duration

Wymagane. Oczekiwany czas przerwy.
custom_params

string

Pary klucz-wartość, które mają być uwzględniane w żądaniach reklamy w ramach tej przerwy na potrzeby kierowania według kryteriów niestandardowych w usłudze Ad Manager. Przykład: 'klucz1=wartość&klucz2=wartość2,wartość22'
scte_35_cue_out

string

Dane zakodowane w standardzie Base64 z sygnału SCTE35. Mogą zawierać polecenie splice_insert() lub time_signal(). Przykłady: – z time_signal(): „/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” – z splice_insert(): „/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
pod_template_name

string

Nazwa szablonu bloku reklamowego w Google Ad Managerze.
break_state

BreakState

Bieżący stan przerwy na reklamę.

BreakState

Stan przerwy na reklamę.

Wartości w polu enum
BREAK_STATE_UNSPECIFIED Stan przerwy na reklamę jest nieznany.
BREAK_STATE_DECISIONED Rozpoczęto podejmowanie decyzji dotyczących przerw na reklamę, ale nie zostały one jeszcze dostarczone użytkownikom.
BREAK_STATE_COMPLETE przerwa na reklamę została wyświetlona użytkownikom.

ClosedCaptionFormat

Formaty plików z napisami.

Wartości w polu enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Nie podano formatu napisów.
TTML application/ttaf+xml
WEB_VTT tekst/vtt

ClosedCaptionUrlInfo

Metadane jednego pliku z napisami.

Pola
language_code

string

Kod języka IETF BCP-47 reprezentujący język, w którym zapisano plik napisów.
closed_caption_format

ClosedCaptionFormat

Format pliku z napisami.
url

string

Adres URL pliku z napisami.

CreateAdBreakRequest

Prośba dotycząca: AdBreakNotificationService.CreateAdBreak.

Pola
parent

string

To pole wskazuje zdarzenie LiveStreamEvent, z którym przerwa na reklamę powinna być powiązana za pomocą klucza pliku transmisji na żywo. Musi mieć format "networks/{kod_sieci}/assets/{kod_zasobu}"
custom_parent

string

To pole określa zdarzenie LiveStreamEvent, z którym ma być powiązana ta przerwa na reklamę za pomocą niestandardowego klucza pliku. Musi mieć format „networks/{network_code}/customAssets/{asset_code}”.
content

string

Jest to alternatywny sposób identyfikowania zdarzenia LiveStreamEvent, jeśli jest ono powiązane z treścią w GAM. Musi mieć format „sieci/{kod_sieci}/źródła/{identyfikator_źródła_treści}/content/{identyfikator_treści_systemu}
ad_break

AdBreak

Wymagane. Rzeczywista przerwa na reklamę.
ad_break_id

string

Jest to identyfikator przerwy reklamowej, który użytkownicy mogą podać w żądaniu.

DynamicAdInsertionInfo

Informacje dotyczące dynamicznego wstawiania reklam.

Pola
video_ingest_url_info

VideoIngestUrlInfo

Link do pliku mastera m3u8, który jest używany do warunkowania i generowania playlisty.
media_update_time

Timestamp

Czas ostatniej modyfikacji pliku wideo wskazanego w video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

Adres URL pliku z napisami.
fw_caid

string

Identyfikator zasobu niestandardowego FreeWheel używany do kierowania reklamy.

GracenoteMetadata

Metadane Gracenote dotyczące treści.

Pola
gracenote_id

string

Wymagane. Odnosi się do identyfikatora Gracenote dla treści. Musi mieć jeden z następujących prawidłowych prefiksów: 1. „EP” – odcinek serialu. Teledysk – film 3. „SP” – wydarzenie sportowe
gracenote_series_id

string

Opcjonalnie: To pole odnosi się do identyfikatora serii Gracenote. Musi mieć prefiks „SH”.

ListAdBreaksRequest

Prośba dotycząca: AdBreakNotificationService.ListAdBreaks.

Pola
parent

string

Opcjonalnie: To pole wskazuje zdarzenie LiveStreamEvent, z którym przerwa na reklamę powinna być powiązana za pomocą klucza pliku transmisji na żywo. Musi mieć format "networks/{kod_sieci}/assets/{kod_zasobu}"
custom_parent

string

Opcjonalnie: To pole identyfikuje zdarzenie LiveStreamEvent, które powinno być powiązane z tą przerwą na reklamę za pomocą niestandardowego klucza zasobu. Musi mieć format "networks/{kod_sieci}/customAssets/{kod_zasobu}
content

string

Opcjonalnie: Jest to alternatywny sposób identyfikowania zdarzenia LiveStreamEvent, jeśli jest ono powiązane z treściami w GAM. Musi mieć format „sieci/{kod_sieci}/źródła/{identyfikator_źródła_treści}/content/{identyfikator_treści_systemu}
page_size

int32

Opcjonalnie: Maksymalna liczba przerw na reklamę do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 przerw na reklamę. Maksymalna wartość to 100. wartości powyżej 100 zostaną zmienione na 100.
page_token

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji ListAdBreaks. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji ListAdBreaks muszą być zgodne z wywołaniem, które dostarczyło token strony.

ListAdBreaksResponse

Odpowiedź na pytanie „AdBreakNotificationService.ListAdBreaks”.

Pola
ad_breaks[]

AdBreak

Tylko dane wyjściowe. Lista przerw na reklamę, które pasują do żądanego zdarzenia LiveStreamEvent.
next_page_token

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Metadane

niestandardowe metadane treści;

Pola
key_values

map<string, Value>

Określa niestandardowe metadane treści w postaci pary klucz-wartość. Jako wartości akceptowane są tylko ciągi tekstowe lub listy ciągów tekstowych.

SyndicatedVideoContentNames

Lista nazw wszystkich rozpowszechnianych treści.

Pola
syndicated_video_content[]

string

Powtórzone pole nazwy treści rozpowszechnianych. Muszą mieć format "sieci/{kod_sieci}/źródła/{identyfikator_źródła_treści}/content/{identyfikator_treści_systemu_cms} i muszą należeć do tej samej sieci co treść zawierająca to pole.

UpdateVideoContentRequest

Żądanie [VideoContentIngestionService.UpdateVideoContentRequest][].

Pola
video_content

VideoContent

Wymagane. Metadane treści.

Treść wideo

Metadane treści.

Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu treści wideo. To pole ma format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}”.

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

content_source_id to identyfikator źródła treści w Google Ad Manager, do którego powinna należeć treść.

cms_content_id to identyfikator treści CMS w Google Ad Managerze, utworzony jako część żądania reklamy w celu wskazywania reklam, które Ad Manager może wyświetlać w danym filmie. Ta wartość może być liczbowa lub alfanumeryczna.
status

VideoContentStatus

Stan treści. Jeśli nie podasz tej opcji, będzie aktywna wartość domyślna.
title

string

Wymagane. Tytuł treści.
update_time

Timestamp

Wymagane. Czas ostatniej modyfikacji treści.
publish_time

Timestamp

Czas opublikowania treści. To pole jest wymagane, jeśli film ma być uwzględniany w regułach reklamowych, które określają czas rozpoczęcia i zakończenia.
duration

Duration

Czas trwania treści. Czas trwania jest obsługiwany z dokładnością do milisekundy.
cue_points[]

Duration

Określa punkty wstawienia reklamy. Punkty wstawienia reklamy to momenty w filmie, w których można wstawić reklamę. Punkty wstawienia reklamy są obsługiwane z dokładnością do milisekundy. To pole jest wymagane, jeśli film zawiera przerwy na reklamy w trakcie filmu.
thumbnail_url

string

Adres URL miniatury materiału.
metadata

Metadata

Identyfikuje niestandardowe metadane treści.
gracenote_metadata

GracenoteMetadata

Metadane Gracenote dotyczące treści.
syndication_metadata

VideoContentSyndicationInfo

Metadane dotyczące dystrybucji treści.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadane treści związane z dynamicznym wstawianiem reklam.

VideoContentStatus

Opcje stanu umożliwiające wyświetlanie kierowanych reklam w przypadku treści.

Wartości w polu enum
ACTIVE Reklamy kierowane na sieć reklamową będą się wyświetlać.
BLOCKED Jeśli stan to „BLOCKED” (zablokowane), reklamy nie będą się wyświetlać w przypadku tych treści.
DELETED Treści zostaną zarchiwizowane w usłudze Ad Manager. Jeśli Ad Manager otrzyma żądanie reklamy dotyczące treści oznaczonych jako USUNIĘTE, reklamy własne lub reklamy kierowane na jednostki zasobów reklamowych lub inne kryteria kierowania mogą się nadal wyświetlać. Aby zablokować reklamy, ustaw stan na ZABLOKOWANA.

VideoContentSyndicationInfo

Metadane służące do określania relacji między treściami kanonicznymi a treściami powielanymi.

Pola
Pole sumy syndication. VideoContentSyndiationMetadata może zawierać tylko jeden z tych elementów. syndication może mieć tylko jedną z tych wartości:
canonical_video_content

string

Nazwa treści kanonicznej. Musi mieć format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}” i należeć do tej samej sieci co treści zawierające to pole.
syndicated_video_content_names

SyndicatedVideoContentNames

Kolekcja materiałów redystrybuowanych

VideoFormat

Formaty, w których można kodować treści wideo.

Wartości w polu enum
VIDEO_FORMAT_UNSPECIFIED Nie określono formatu filmu.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Metadane określające link do pliku m3u8, który jest używany do warunkowania i generowania playlisty.

Pola
video_format

VideoFormat

Format filmu.
video_preconditioned

VideoPreconditioned

Wskazuje, czy treści są już uwarunkowane do wyświetlania reklam w trakcie filmu, co oznacza, że segmenty są już podzielone na segmenty, by określić przerwy na reklamę.
url

string

Link do pliku m3u8.

VideoPreconditioned

Stan warunkowania treści wideo.

Wartości w polu enum
NO Jeszcze nie uwarunkowane.
YES Film został podzielony.