Package google.ads.drx.video.v1

Index

AdBreakNotificationService

Ein API-Dienst, mit dem Publisher in einem Livestream Werbeunterbrechungen erstellen können.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API zum Erstellen einer Werbeunterbrechung im Livestream

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

Die API zum Auflisten von Werbeunterbrechungen im Livestream.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

VideoContentIngestionService

Ein API-Dienst für die Contentaufnahme, mit dem Videocontent und die zugehörigen Metadaten in Google Ad Manager erstellt oder aktualisiert werden können.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API verwenden, um neuen Content zu erstellen oder seine Metadaten zu aktualisieren, wenn der Content bereits in Ad Manager vorhanden ist. Gibt bei Erfolg den Inhalt zurück oder bei einem Fehler google.rpc.Code.

Eine Beispielanfrage sieht so aus:

{
   "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"],
       }
   }
}
Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

AdBreak

Metadaten für Werbeunterbrechungen, die bei der Entscheidung für Anzeigen für eine Werbeunterbrechung in einem Live-Videoereignis verwendet werden.

Felder
name

string

Nur Ausgabe. Der Ressourcenname der Werbeunterbrechung. Dieses Feld hat das Format "networks//assets//adBreaks/".

network_code ist der Netzwerkcode in Google Ad Manager, zu dem dieser Content gehört.

asset_key ist der Schlüssel des Livestream-Ereignisses in Google Anzeigenverwaltung, unter dem die Werbeunterbrechung erstellt wurde.

„ad_break_id“ ist der Schlüssel der Werbeunterbrechung. NUR AUSGABE.
expected_duration

Duration

Erforderlich. Erwartete Unterbrechungsdauer.
custom_params

string

Schlüssel/Wert-Paare, die in Anzeigenanfragen für diese Werbeunterbrechung für das Targeting nach benutzerdefinierten Kriterien in Ad Manager aufgenommen werden sollen. Beispiel: „Schlüssel1=Wert&Schlüssel2=Wert2,Wert22“
scte_35_cue_out

string

Base64-codierte Daten aus dem scte35-Cue-out. Kann den Befehl splice_insert() oder time_signal() enthalten. Beispiele: - mit time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - mit splice_insert(): "/DAvAAAAAAAA///wFAVINAACPfbow/JACAAAAAAA1n
pod_template_name

string

Name der Google Ad Manager-Pod-Vorlage.
break_state

BreakState

Der aktuelle Status der Werbeunterbrechung.

BreakState

Der Status einer Werbeunterbrechung.

Enums
BREAK_STATE_UNSPECIFIED Der Status der Werbeunterbrechung ist unbekannt.
BREAK_STATE_DECISIONED Die Entscheidung über Werbeunterbrechungen hat begonnen, den Nutzern aber noch nicht zugestellt.
BREAK_STATE_COMPLETE Die Werbeunterbrechung wurde Nutzern bereitgestellt.

ClosedCaptionFormat

Die Formate, in denen die Untertiteldateien vorliegen können.

Enums
CLOSED_CAPTION_FORMAT_UNSPECIFIED Das Untertitelformat wurde nicht angegeben.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

Metadaten für eine Untertiteldatei.

Felder
language_code

string

Der IETF BCP-47-Sprachcode für die Sprache der Untertiteldatei.
closed_caption_format

ClosedCaptionFormat

Das Format der Untertiteldatei.
url

string

Die URL zur Untertiteldatei.

CreateAdBreakRequest

Anfrage in Höhe von AdBreakNotificationService.CreateAdBreak.

Felder
parent

string

In diesem Feld wird das LiveStreamEvent angegeben, dem diese Werbeunterbrechung mit dem Schlüssel für das Livestream-Asset zugeordnet werden soll. Es muss das Format „networks/{network_code}/assets/{asset_code}“ haben
custom_parent

string

In diesem Feld wird das LiveStreamEvent angegeben, dem diese Werbeunterbrechung mithilfe des benutzerdefinierten Assetschlüssels zugeordnet werden soll. Es muss das Format „networks/{network_code}/customAssets/{asset_code}“ haben.
content

string

Dies ist eine alternative Möglichkeit, das LiveStreamEvent zu identifizieren, wenn es mit einem Inhalt in GAM verknüpft ist. Sie muss das Format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}“ haben.
ad_break

AdBreak

Erforderlich. Die eigentliche Werbeunterbrechung
ad_break_id

string

Dies ist die „ad_break_id“, die Nutzer in der Anfrage angeben können.

DynamicAdInsertionInfo

Informationen zur dynamischen Anzeigenbereitstellung.

Felder
video_ingest_url_info

VideoIngestUrlInfo

Ein Link zur m3u8-Masterdatei, die zum Konditionieren und Erstellen von Playlists verwendet wird.
media_update_time

Timestamp

Der Zeitpunkt, zu dem die Videodatei, auf die in video_ingest_url_info verwiesen wird, zuletzt geändert wurde.
closed_caption_url_info[]

ClosedCaptionUrlInfo

Die URL zur Untertiteldatei.
fw_caid

string

Die benutzerdefinierte Asset-ID von FreeWheel, die für die Anzeigenausrichtung verwendet wird.

GracenoteMetadata

Die Gracenote-Metadaten für den Inhalt.

Felder
gracenote_id

string

Erforderlich. Bezieht sich auf die Gracenote-ID für den Inhalt. Muss eines der folgenden gültigen Präfixe haben: 1. „EP“ - Folge von Serie 2. „MV“ – Film 3. „SP“ - Sportveranstaltung
gracenote_series_id

string

Optional. Dieses Feld bezieht sich auf die Gracenote-Serien-ID. Muss das Präfix „SH“ haben.

ListAdBreaksRequest

Anfrage in Höhe von AdBreakNotificationService.ListAdBreaks.

Felder
parent

string

Optional. In diesem Feld wird das LiveStreamEvent angegeben, dem diese Werbeunterbrechung mit dem Schlüssel für das Livestream-Asset zugeordnet werden soll. Es muss das Format „networks/{network_code}/assets/{asset_code}“ haben
custom_parent

string

Optional. In diesem Feld wird das LiveStreamEvent angegeben, dem diese Werbeunterbrechung mithilfe des benutzerdefinierten Assetschlüssels zugeordnet werden soll. Es muss das Format „networks/{network_code}/customAssets/{asset_code}“ haben.
content

string

Optional. Dies ist eine alternative Möglichkeit, das LiveStreamEvent zu identifizieren, wenn es mit einem Inhalt in GAM verknüpft ist. Sie muss das Format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}“ haben.
page_size

int32

Optional. Die maximale Anzahl von Werbeunterbrechungen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn keine Angabe gemacht wird, werden maximal 10 Werbeunterbrechungen zurückgegeben. Der Höchstwert ist 100. werden Werte über 100 in 100 umgewandelt.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListAdBreaks-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListAdBreaks bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListAdBreaksResponse

Antwort für AdBreakNotificationService.ListAdBreaks.

Felder
ad_breaks[]

AdBreak

Nur Ausgabe. Eine Liste der Werbeunterbrechungen, die dem angeforderten LiveStreamEvent entsprechen.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Metadaten

Benutzerdefinierte Metadaten des Inhalts.

Felder
key_values

map<string, Value>

Kennzeichnet die benutzerdefinierten Metadaten des Contents als Schlüssel/Wert-Paar. Als Werte sind nur Strings oder eine Liste von Strings zulässig.

SyndicatedVideoContentNames

Die Liste der Namen aller syndizierten Inhalte.

Felder
syndicated_video_content[]

string

Wiederkehrendes Feld mit dem Namen des syndizierten Inhalts. Sie müssen das Format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}“ haben. und muss zum selben Werbenetzwerk gehören wie der Content, der dieses Feld enthält.

UpdateVideoContentRequest

Anfrage für [VideoContentIngestionService.UpdateVideoContentRequest][]

Felder
video_content

VideoContent

Erforderlich. Die Metadaten der Inhalte.

VideoContent

Die Metadaten der Inhalte.

Felder
name

string

Nur Ausgabe. Der Ressourcenname des Videoinhalts. Dieses Feld hat das Format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}“.

network_code ist der Netzwerkcode in Google Ad Manager, zu dem dieser Content gehört.

„content_source_id“ ist die ID der Contentquelle in Google Ad Manager, zu der dieser Content gehören soll.

„cms_content_id“ ist die CMS-Content-ID in Google Ad Manager. Sie wird in der Anzeigenanfrage gebildet und bestimmt, welche Anzeigen in Ad Manager für das entsprechende Video ausgeliefert werden können. Dieser Wert kann numerisch oder alphanumerisch sein.
status

VideoContentStatus

Der Status des Inhalts. Ohne Angabe ist der Standardwert aktiv.
title

string

Erforderlich. Der Titel des Inhalts.
update_time

Timestamp

Erforderlich. Der Zeitpunkt der letzten Änderung des Inhalts.
publish_time

Timestamp

Der Veröffentlichungszeitpunkt des Inhalts. Dies ist ein Pflichtfeld, wenn das Video in Anzeigenregeln mit Start- und Endzeit enthalten sein soll.
duration

Duration

Dauer des Inhalts Die Dauer wird bis auf die Millisekunde genau unterstützt.
cue_points[]

Duration

Kennzeichnet die Cue-Punkte. Cue-Punkte geben die Zeitpunkte an, zu denen eine Anzeige in das Video eingefügt werden kann. Cue-Punkte werden bis auf die Millisekunde genau unterstützt. Dies ist ein Pflichtfeld, wenn das Video Mid-Roll-Werbeunterbrechungen enthält.
thumbnail_url

string

URL der Miniaturansicht des Inhalts.
metadata

Metadata

Gibt die benutzerdefinierten Metadaten des Inhalts an.
gracenote_metadata

GracenoteMetadata

Gracenote-bezogene Metadaten des Inhalts.
syndication_metadata

VideoContentSyndicationInfo

Syndikationsbezogene Metadaten der Inhalte.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Für die dynamische Anzeigenbereitstellung relevante Metadaten des Contents.

VideoContentStatus

Statusoptionen für die Auslieferung von Anzeigen mit Targeting für einen Content.

Enums
ACTIVE Inhaltsbezogene Anzeigen werden geliefert.
BLOCKED Wenn der Status BLOCKIERT ist, werden für diesen Inhalt keine Anzeigen geschaltet.
DELETED Der Content wird in Ad Manager archiviert. Wenn in Ad Manager eine Anzeigenanfrage für einen Content eingeht, der als GELÖSCHT gekennzeichnet ist, können weiterhin hausinterne Anzeigen oder Anzeigen ausgeliefert werden, die auf Inventareinheiten oder andere Targeting-Kriterien ausgerichtet sind. Wenn Sie Anzeigen blockieren möchten, setzen Sie den Status auf BLOCKIERT.

VideoContentSyndicationInfo

Die Metadaten zur Angabe von Beziehungen zwischen kanonischen Inhalten und syndizierten Inhalten.

Felder
Union-Feld syndication. VideoContentSyndiationMetadata darf nur eines der folgenden Elemente enthalten. Für syndication ist nur einer der folgenden Werte zulässig:
canonical_video_content

string

Der Name des kanonischen Inhalts. Sie muss das Format „networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}“ haben. und muss zum selben Werbenetzwerk gehören wie der Content, der dieses Feld enthält.
syndicated_video_content_names

SyndicatedVideoContentNames

Eine Sammlung syndizierter Inhalte

VideoFormat

Die Formate, in denen ein Videocontent codiert werden kann.

Enums
VIDEO_FORMAT_UNSPECIFIED Das Videoformat wurde nicht angegeben.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Metadaten, die den Link zur m3u8-Datei angeben, die zum Konditionieren und zum Generieren von Playlists verwendet wird.

Felder
video_format

VideoFormat

Das Format des Videos.
video_preconditioned

VideoPreconditioned

Um anzugeben, ob der Content bereits für Mid-Roll-Anzeigen konditioniert ist, d. h., deine Segmente sind bereits zum Zeitpunkt der Werbeunterbrechungen aufgeteilt.
url

string

Der Link zur m3u8-Datei.

VideoPreconditioned

Der Bedingungszustand des Videocontents.

Enums
NO Noch nicht konditioniert.
YES Das Video wurde konditioniert/gespalten.