VOD-API für die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung

Mit der Dynamic Ad Insertion API können Sie DAI-On-Demand-Streams anfordern und nachverfolgen.

Dienst: dai.google.com

Alle URIs sind relativ zu https://dai.google.com.

Methode: Stream erstellen

Bei dieser Methode wird ein Stream direkt vom Gerät erstellt. Dabei werden alle Ressourcen zurückgegeben, die für die Clientanwendung erforderlich sind, um Anzeigen abzuspielen und zu erfassen sowie UI-Elemente darzustellen.

Methoden
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

VOD-Sitzung für die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung erstellen

HTTP-Anfrage

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

Anfragetext

Der Anfragetext hat den Typ application/json und muss ein CreateStreamRequest-Objekt enthalten.

Antworttext

Bei Erfolg enthält der Antworttext ein neues CreateStreamResponse-Objekt.

Methode: Stream registrieren

Mit dieser Methode wird ein Stream auf dem Google DAI-Backend vom Gerät registriert. Dabei werden alle Ressourcen zurückgegeben, die für die Clientanwendung erforderlich sind, um Anzeigen zu erfassen und UI-Elemente zu präsentieren. Im Gegensatz zur Methode create stream gibt diese Methode kein Manifest für interaktive Anzeigen zurück. Stattdessen wird diese Aktion in einem separaten Serveraufruf ausgeführt: decision ad pods.

Methoden
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Registriert eine VOD-Sitzung für die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung.

HTTP-Anfrage

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

Anfragetext

Der Anfragetext hat den Typ application/json und muss ein StreamRegistrationRequest-Objekt enthalten.

Antworttext

Bei Erfolg enthält der Antworttext ein neues StreamRegistrationResponse-Objekt.

Methode: Anzeigen-Pods abrufen

Diese Methode folgt einem register stream-Aufruf von einem Gerät und ist erforderlich, um Manifeste für abspielbare Anzeigen abzurufen, die in Inhaltsmanifeste eingefügt werden sollen.

Methoden
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Entscheidung über Anzeigen-Pods für eine VOD-Sitzung mit Pod-Auslieferung mit dynamischer Anzeigenbereitstellung treffen

HTTP-Anfrage

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Pfadparameter

Parameter
network_code string

Der Google Ad Manager-Netzwerkcode des Publishers.

stream_id string

Die stream_id, die von einem stream_registration-Aufruf empfangen wurde.

Anfragetext

Der Anfragetext hat den Typ application/json und muss ein AdPodDecisionRequest-Objekt enthalten.

Antworttext

Bei Erfolg enthält der Antworttext ein neues AdPodDecisionResponse-Objekt.

Methode: Metadaten für Anzeigen-Pods

Diese Methode gibt alle Informationen zurück, die die Client-App benötigt, um Anzeigen zu erfassen und geeignete UI-Elemente korrekt zu rendern.

Methoden
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Metadaten von Anzeigen-Pods für eine bestimmte Sitzung abrufen Diese URL wird im Attribut StreamRegistrationResponse metadata_url zurückgegeben.

HTTP-Anfrage

GET: /ondemand/pods/api/v1/network/.../metadata

Antworttext

Bei Erfolg enthält der Antworttext ein Ad pods metadata-Objekt.

API-Objekte

PodMetadata

PodMetadata enthält Metadaten zu Anzeigen, Werbeunterbrechungen und Media ID-Tags.
JSON-Darstellung
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "polling_frequency": number,
}
Felder
tags map[string, object(TagSegment)]

Karte der Tag-Segmente, die nach Tag-Präfix indexiert sind.
ads map[string, object(Ad)]

Karte der nach Anzeigen-ID indexierten Anzeigen.
ad_breaks map[string, object(AdBreak)]

Karte der Werbeunterbrechungen, indexiert nach der ID der Werbeunterbrechung.
polling_frequency number

Empfohlene Häufigkeit des Abrufs der Metadaten-URL in Sekunden. Wird für VOD-Streams mit On-Demand-Entscheidungsfindung ausgefüllt.

TagSegment

„TagSegment“ enthält einen Verweis auf eine Anzeige, die zugehörige Werbeunterbrechung und den Ereignistyp. TagSegment mit type="progress" sollte nicht an den Endpunkt für die Überprüfung von Anzeigenmedien gesendet werden.
JSON-Darstellung
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Felder
ad string

Die ID der Anzeige dieses Tags.
ad_break_id string

Die ID der Werbeunterbrechung dieses Tags.
type string

Der Ereignistyp dieses Tags.

AdBreak

„AdBreak“ beschreibt eine einzelne Werbeunterbrechung im Stream. Sie enthält eine Dauer, einen Typ (Mid/Pre/Post) und die Anzahl der Anzeigen.
JSON-Darstellung
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Felder
type string

Gültige Pausentypen sind: pre, mid und post.
duration number

Gesamtdauer der Anzeigen für diese Werbeunterbrechung in Sekunden.
expected_duration number

Voraussichtliche Dauer der Werbeunterbrechung (in Sekunden), einschließlich aller Anzeigen und aller Slates.
ads number

Anzahl der Anzeigen in der Werbeunterbrechung.
„Anzeige“ beschreibt eine Anzeige im Stream.
JSON-Darstellung
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Felder
ad_break_id string

Die ID der Werbeunterbrechung dieser Anzeige.
position number

Position dieser Anzeige in der Werbeunterbrechung, beginnend mit 1.
duration number

Dauer der Anzeige in Sekunden.
title string

Optionaler Titel der Anzeige.
description string

Optionale Beschreibung der Anzeige.
advertiser string

Optionale Werbetreibenden-ID.
ad_system string

Optionales Anzeigensystem.
ad_id string

Optionale Anzeigen-ID.
creative_id string

Optionale Creative-ID.
creative_ad_id string

Optionale Anzeigen-Creative-ID.
deal_id string

Optionale Deal-ID.
clickthrough_url string

Optionale Klick-URL
click_tracking_urls string

Optionale Klick-Tracking-URLs.
verifications [object(Verification)]

Optionale Open Measurement-Verifizierungseinträge, in denen die Ressourcen und Metadaten aufgeführt sind, die zum Ausführen von Drittanbieter-Messcode zur Überprüfung der Creative-Wiedergabe erforderlich sind.
slate boolean

Optionaler boolescher Wert, der angibt, ob der aktuelle Eintrag ein Slate ist.
icons [object(Icon)]

Eine Liste von Symbolen, die ausgelassen wird, wenn sie leer ist.
wrappers [object(Wrapper)]

Eine Liste von Wrappern, die ausgelassen wird, wenn sie leer ist.
universal_ad_id object(UniversalAdID)

Optionale universelle Anzeigen-ID.
extensions string

Optionale Liste aller <Extension>-Knoten im VAST.
companions [object(Companion)]

Optionale Companions, die zusammen mit dieser Anzeige ausgeliefert werden können.
interactive_file object(InteractiveFile)

Optionales interaktives Creative (SIMID), das während der Anzeigenwiedergabe angezeigt werden soll.

MatchOpts

Mit MatchOpts werden strenge Anforderungen für den Media-Abgleich für einen Stream festgelegt.
JSON-Darstellung
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Felder
audio_channels boolean

Audio-Channels zwischen Inhalten und Anzeigen abgleichen:
audio_sample_rate boolean

Audio-Abtastrate zwischen Inhalten und Anzeigen anpassen:

CreateStreamRequest

CreateStreamRequest beschreibt die Informationen, die in HTTP-Anfragen an die VOD-Pod-Serving-API enthalten sind. Die Streamerstellung wird für jeden Nutzer vom VTP (Video Technology Partner) im Namen des SDK und des Publishers initiiert. Der erstellte Stream führt zu Anzeigen-Pods, die vom VTP zusammengefügt werden. Das steht im Gegensatz zum Ablauf „StreamRegistrationRequest + AdPodDecisionRequest“, bei dem ein Stream registriert und Ad-Pods in mehreren Anfragen entschieden werden.
JSON-Darstellung
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Felder
encoding_profiles [object(EncodingProfile)]

Eine Liste von Codierungsprofilen. Erforderlich.
ad_tag string

Das Basis-Anzeigen-Tag für die Entscheidungsfindung. Erforderlich.
cuepoints number

Eine Liste mit Cuepoints in Sekunden. Erforderlich, wenn in der Antwort des Anzeigen-Tags positionale Zeit-Offsets verwendet werden.
manifest_type string

Gültige Manifesttypen sind: hls und dash. Standard: hls. Optional.
enable_hls_asset_list boolean

Gibt an, ob Interstitials in der HLS-Assetliste aktiviert sind. Wenn diese Option aktiviert ist, gibt die dynamische Anzeigenbereitstellung für jede Werbeunterbrechung Asset-Listen-URLs zurück, die für HLS-Interstitials verwendet werden können.
targeting_parameters string

Zusätzliche Ad Manager-Targeting-Parameter. Optional.
content_duration_seconds number

ContentDurationSeconds ist die Dauer des Inhalts in Sekunden. Erforderlich, wenn in der Antwort des Anzeigen-Tags prozentuale Zeit-Offsets verwendet werden.
decision_timing_options object(DecisionTimingOptions)

Gibt an, wann über Ad-Pods entschieden werden soll.
enable_inline_manifests boolean

Gibt an, ob Pausenmanifeste in die JSON-Antwort eingefügt werden sollen.
dai_options object(CreateStreamOptions)

DAIOptions für die Streamerstellung.

CreateStreamOptions

CreateStreamOptions stellt die Optionen dar, die im Workflow zum Erstellen von Streams in einem Schritt verfügbar sind.
JSON-Darstellung
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Felder
dash_profile string

Zu verwendendes MPEG-DASH-Profil: „live“ oder „on-demand“.
match_options object(MatchOpts)

data_sharing_policy_code string

Ermöglicht Publishern, die Standardrichtlinie zur Datenweitergabe für das Netzwerk zu überschreiben.
sam_id string

sam_id ist der optionale SAM-Schlüssel zur Fehlerbehebung für die Sitzung.
session_title string

session_title ist der SAM-Sitzungstitel für den Stream (optional).
dash_inband_event_stream boolean

dash_inband_event_stream indicates that DAI inserts ID3 messages as inband events (in-media) using the InbandEventStream element, rather than as EventStream elements (in-manifest).
distinct_ad_profiles boolean

Wenn diese Option auf „true“ gesetzt ist, verwendet der Server jedes verfügbare Anzeigenprofil beim Abgleichen der angeforderten Codierungsprofile höchstens einmal.
tracking_mode string

tracking_mode ist der Typ des Anzeigen-Trackings, der für den Stream verwendet werden soll (optional). Gültige Werte sind: „ad_media“, „server“, „client“.
emsg_version uint32

emsg_version erzwingt die Verwendung einer bestimmten emsg-Version für In-Media-ID3s. Wird nur unterstützt, wenn „dash_inband_event_stream“ auf „true“ gesetzt ist.

StreamRegistrationRequest

Mit StreamRegistrationRequest wird ein Stream vom Gerät für zukünftige Adpod-Entscheidungen registriert. Das ist anders als bei einem CreateStreamRequest, bei dem ein Stream erstellt und Adpods in einer einzigen Anfrage entschieden werden.
JSON-Darstellung
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Felder
targeting_parameters string

Zusätzliche Ad Manager-Targeting-Parameter. Optional.
dai_options object(StreamRegistrationOptions)

DAIOptions für die Streamregistrierung.

StreamRegistrationOptions

StreamRegistrationOptions listet die Optionen auf, die für die Streamerstellung verfügbar sind.
JSON-Darstellung
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Felder
sam_id string

sam_id ist der optionale SAM-Schlüssel zur Fehlerbehebung für die Sitzung.
tracking_mode string

tracking_mode ist der Typ des Anzeigen-Trackings, der für den Stream verwendet werden soll (optional). Gültige Werte sind: „ad_media“, „server“, „client“.
emsg_version uint32

emsg_version erzwingt die Verwendung einer bestimmten emsg-Version für In-Media-ID3s. Wird nur unterstützt, wenn „dash_inband_event_stream“ auf „true“ gesetzt ist.
skippable_ads_supported boolean

Gibt an, ob überspringbare Anzeigen unterstützt werden.

StreamRegistrationResponse

StreamRegistrationResponse stellt die JSON-Antwort dar, die als Reaktion auf eine StreamRegistrationRequest an den Client zurückgesendet wird. Sie enthält die Stream-ID und alle URLs, die das Gerät benötigt. Die Stream-ID kann in einer nachfolgenden Adpod-Entscheidungsanfrage referenziert werden. Das steht im Gegensatz zu einer CreateStreamResponse, die eine Antwort für das Erstellen eines Streams und das gleichzeitige Treffen von Entscheidungen für Werbeblöcke darstellt.
JSON-Darstellung
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Felder
stream_id string

StreamID ist die eindeutige Kennung für den aktuellen Stream dieses Zuschauers.
media_verification_url string

MediaVerificationURL ist das URL-Präfix, das in den unten beschriebenen Anfragen zur Überprüfung von Anzeigenmedien verwendet werden soll. Nicht vorhanden bei Streams mit clientseitigem Beaconing.
valid_for string

ValidFor ist die Dauer, für die dieser Stream gültig ist, im Format „00h00m00s“.
valid_until string

ValidUntil ist das Datum und die Uhrzeit, bis zu der dieser Stream gültig ist.
metadata_url string

MetadataURL ist die Metadaten-URL, die zum Anfordern von Ad-Pod-Metadaten verwendet werden soll.

DecisionTimingOptions

DecisionTimingOptions beschreibt die Timing-Optionen für die Entscheidungsfindung bei Werbeunterbrechungen für den Stream.
JSON-Darstellung
{
  "type": string,
  "on_create_breaks": [],
}
Felder
type string

Type describes when adpods are decisioned for the stream. Gültige Typen sind: on_create (Standard), on_demand. Wenn der Typ „on_demand“ ist, werden Anzeigen erst dann entschieden, wenn das Manifest für eine bestimmte Pause angefordert wird. Wenn der Typ „on_create“ ist, werden alle Anzeigenentscheidungen bei der Erstellung des Streams getroffen.
on_create_breaks string

OnCreateBreaks ist eine Liste von VMAP-Unterbrechungs-IDs, bei denen beim Erstellen des Streams eine Entscheidung getroffen werden soll. Bei den IDs wird die Groß-/Kleinschreibung beachtet. Dieses Feld ist nur zulässig, wenn der Typ „on_demand“ ist. Mit den speziellen Pausen-IDs „preroll“ und „postroll“ kann angegeben werden, dass die Pre-Roll- oder Post-Roll-Pause beim Erstellen des Streams entschieden werden soll.

EncodingProfile

„EncodingProfile“ beschreibt die Codierung einer einzelnen Inhaltsvariante. Sie kann nur Videoeinstellungen, nur Audioeinstellungen (bei diesem Medientyp), sowohl Video- als auch Audioeinstellungen oder bei Untertiteln keine Einstellungen enthalten.
JSON-Darstellung
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Felder
profile_name string

Der vom Publisher angegebene Name für das Profil. Eindeutig pro Stream. Erforderlich.
type string

Gültige Typen sind: media, iframe, subtitles. Erforderlich.
container_type string

Gültige Typen sind: mpeg2ts, fmp4cmaf und hls_packed_audio. Erforderlich für die Typen „Media“ und „iFrame“.
video_settings object(VideoSettings)

Videoeinstellungen sind erforderlich, wenn der Containertyp „iframe“ ist. Andernfalls sind sie nur vorhanden, wenn das Profil Videos enthält.
audio_settings object(AudioSettings)

Audioeinstellungen sind vorhanden, wenn das Profil Audio enthält. Audioeinstellungen sind nur zulässig, wenn der Containertyp „media“ ist.
subtitle_settings object(SubtitleSettings)

Untertiteleinstellungen sind für „Untertitel eingeben“ erforderlich.

VideoSettings

VideoSettings beschreibt das Video eines Codierungsprofils. Wenn eine Videoeinstellung vorhanden ist, müssen alle vorhanden sein.
JSON-Darstellung
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Felder
codec string

Der RFC6381-Codec-String des Videos.
bitrate int32

Die maximale Videobitrate des Codierungsprofils.
frames_per_second number

Die Bilder pro Sekunde des Videos.
resolution object(Resolution)

Die Auflösung des Videos in Breite × Höhe.

AudioSettings

AudioSettings beschreibt die Audioeinstellungen eines Codierungsprofils. Wenn eine Audioeinstellung vorhanden ist, müssen alle vorhanden sein.
JSON-Darstellung
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Felder
codec string

Der RFC6381-Codec-String des Audios.
bitrate int32

Die maximale Audiobitrate des Codierungsprofils.
channels int32

Anzahl der Audiokanäle (einschließlich der Kanäle für niedrige Frequenzen).
sample_rate int64

Die Abtastrate des Audiosignals in Hertz.

SubtitleSettings

SubtitleSettings beschreibt die Untertitel eines Codierungsprofils.
JSON-Darstellung
{
  "format": string,
  "language": string,
}
Felder
format string

Das Format der Untertitel: webvtt für HLS, webvtt oder ttml für DASH.
language string

Die Sprache, die in das Manifest eingefügt werden soll.

Auflösung

Die Auflösung gibt die Breite × Höhe eines Videos an.
JSON-Darstellung
{
  "width": int32,
  "height": int32,
}
Felder
width int32

Breite des Videos in Pixeln. Erforderlich.
height int32

Höhe des Videos in Pixeln. Erforderlich.

AdPodDecisionRequest

AdPodDecisionRequest stellt eine Anfrage dar, um Entscheidungen zu Ad-Pods für einen zuvor registrierten Stream zu treffen.
JSON-Darstellung
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Felder
encoding_profiles [object(EncodingProfile)]

Eine Liste von Codierungsprofilen. Erforderlich.
ad_tag string

Das Basis-Anzeigen-Tag für die Entscheidungsfindung. Erforderlich.
cuepoints number

Eine Liste mit Cuepoints in Sekunden. Erforderlich, wenn in der Antwort des Anzeigen-Tags positionale Zeit-Offsets verwendet werden.
manifest_type string

Gültige Manifesttypen sind: hls und dash. Standard: hls. Optional.
enable_hls_asset_list boolean

Gibt an, ob Interstitials in der HLS-Assetliste aktiviert sind. Wenn diese Option aktiviert ist, gibt die dynamische Anzeigenbereitstellung für jede Werbeunterbrechung Asset-Listen-URLs zurück, die für HLS-Interstitials verwendet werden können.
targeting_parameters string

Zusätzliche Ad Manager-Targeting-Parameter. Optional.
content_duration_seconds number

ContentDurationSeconds ist die Dauer des Inhalts in Sekunden. Erforderlich, wenn in der Antwort des Anzeigen-Tags prozentuale Zeit-Offsets verwendet werden.
decision_timing_options object(DecisionTimingOptions)

Gibt an, wann über Ad-Pods entschieden werden soll.
enable_inline_manifests boolean

Gibt an, ob Pausenmanifeste in die JSON-Antwort eingefügt werden sollen.
dai_options object(AdPodDecisionOptions)

DAIOptions für die Entscheidung zum Anzeigen-Pod.

AdPodDecisionResponse

AdPodDecisionResponse stellt eine Antwort auf die Entscheidung für Ad-Pods für einen zuvor registrierten Stream dar. Sie enthält eine Liste der Anzeigen-Pods, die für diesen Stream entschieden wurden.
JSON-Darstellung
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Felder
valid_for string

ValidFor ist die Dauer, für die dieser Stream gültig ist, im Format „00h00m00s“.
valid_until string

ValidUntil ist das Datum und die Uhrzeit, bis zu der dieser Stream gültig ist.
ad_pods [object(AdPod)]

Eine Liste von Anzeigen-Pods, sortiert nach Einfügereihenfolge.

CreateStreamResponse

CreateStreamResponse stellt die JSON-Antwort dar, die als Reaktion auf eine CreateStreamRequest an den Client zurückgesendet wird.
JSON-Darstellung
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Felder
valid_for string

ValidFor ist die Dauer, für die dieser Stream gültig ist, im Format „00h00m00s“.
valid_until string

ValidUntil ist das Datum und die Uhrzeit, bis zu der dieser Stream gültig ist.
ad_pods [object(AdPod)]

Eine Liste von Anzeigen-Pods, sortiert nach Einfügereihenfolge.
stream_id string

StreamID ist die eindeutige Kennung für den aktuellen Stream dieses Zuschauers.
media_verification_url string

MediaVerificationURL ist das URL-Präfix, das in den unten beschriebenen Anfragen zur Überprüfung von Anzeigenmedien verwendet werden soll. Nicht vorhanden bei Streams mit clientseitigem Beaconing.
pod_metadata object(PodMetadata)

PodMetadata enthält die zusätzlichen Informationen, die zum Rendern des Pods auf dem Gerät und zum Auslösen der Bestätigung erforderlich sind. Wie in der Dokumentation zur Linear API für die dynamische Anzeigenbereitstellung beschrieben. Nur für Streams mit clientseitigem Beaconing enthalten.
metadata_url string

MetadataURL ist die Metadaten-URL, die zum Anfordern von Ad-Pod-Metadaten verwendet werden soll.

AdPod

AdPod steht für eine ausgewählte Werbeunterbrechung, die zur Wiedergabe bereit ist.
JSON-Darstellung
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Felder
manifest_uris string

ManifestURIs ist eine Zuordnung von Namen von Codierungsprofilen zu HLS-Variantenmanifest-URIs für HLS-Inhalte.
multivariant_uri string

MultivariantURI ist der URI für das Manifest mit mehreren Varianten für HLS-Inhalte.
mpd_uri string

MPDURI ist der URI für die MPD für DASH-Inhalte.
manifests string

Manifests ist eine Zuordnung des Namens des Codierungsprofils zum HLS-Variantenmanifest. Wird nur ausgefüllt, wenn für den Stream „enable_inline_manifests“ auf „true“ gesetzt ist.
multivariant_manifest string

MultivariantManifest ist das Manifest mit mehreren Varianten für HLS-Inhalte. Wird nur ausgefüllt, wenn für den Stream „enable_inline_manifests“ auf „true“ gesetzt ist.
mpd_manifest string

MPDManifest ist das MPD-Manifest für DASH-Inhalte. Wird nur ausgefüllt, wenn für den Stream „enable_inline_manifests“ auf „true“ gesetzt ist.
asset_list_uri string

AssetListURI ist die URI für die HLS-Interstitial-Asset-Liste für HLS-Inhalte. Wird nur gefüllt, wenn für den Stream HLS-Asset-List-Interstitials aktiviert sind.
start number

Startzeit des Anzeigen-Pods auf der Asset-Zeitachse (ohne die vorherigen Anzeigen-Pods) in Gleitkomma-Sekunden.
duration number

Dauer des Anzeigen-Pods in Gleitkomma-Sekunden.
type string

Typ der Werbeunterbrechung:
midroll_index number

1-basierter Index von Mid-Rolls in einem Stream, basierend auf der VMAP-Unterbrechungs-ID. Bei Pre-Rolls und Post-Rolls wird sie nicht angezeigt.

AdPodDecisionOptions

„AdPodDecisionOptions“ stellt zusätzliche Optionen für den Stream dar.
JSON-Darstellung
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Felder
dash_profile string

Zu verwendendes MPEG-DASH-Profil: „live“ oder „on-demand“.
match_options object(MatchOpts)

data_sharing_policy_code string

Ermöglicht Publishern, die Standardrichtlinie zur Datenweitergabe für das Netzwerk zu überschreiben.
sam_id string

sam_id ist der optionale SAM-Schlüssel zur Fehlerbehebung für die Sitzung.
session_title string

session_title ist der SAM-Sitzungstitel für den Stream (optional).
dash_inband_event_stream boolean

dash_inband_event_stream indicates that DAI inserts ID3 messages as inband events (in-media) using the InbandEventStream element, rather than as EventStream elements (in-manifest).
distinct_ad_profiles boolean

Wenn diese Option auf „true“ gesetzt ist, verwendet der Server jedes verfügbare Anzeigenprofil beim Abgleichen der angeforderten Codierungsprofile höchstens einmal.

Stream

Mit dem Stream wird eine Liste aller Ressourcen für einen neu erstellten Stream im JSON-Format gerendert .
JSON-Darstellung
{
  "stream_id": string,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Felder
stream_id string

Stream-Kennung:
valid_for string

Gültigkeitsdauer des Streams im Format „00h00m00s“.
valid_until string

Das Datum, bis zu dem der Stream gültig ist, im RFC 3339-Format.
media_verification_url string

URL für die Media-Bestätigung.

Symbol

Das Symbol enthält Informationen zu einem VAST-Symbol.
JSON-Darstellung
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Felder
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData enthält Informationen zu einem Symbol-Clickthrough.
JSON-Darstellung
{
  "url": string,
}
Felder
url string

FallbackImage

„FallbackImage“ enthält Informationen zu einem VAST-Fallback-Bild.
JSON-Darstellung
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Felder
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Der Wrapper enthält Informationen zu einer Wrapper-Anzeige. Wenn keine Deal-ID vorhanden ist, wird sie nicht angegeben.
JSON-Darstellung
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Felder
system string

Kennung des Anzeigensystems.
ad_id string

Anzeigen-ID, die für die Wrapper-Anzeige verwendet wird.
creative_id string

Creative-ID, die für die Wrapper-Anzeige verwendet wird.
creative_ad_id string

Creative-Anzeigen-ID, die für die Wrapper-Anzeige verwendet wird.
deal_id string

Optionale Deal-ID für die Wrapper-Anzeige.

Bestätigung

Die Verifizierung enthält Informationen für Open Measurement, die die Sichtbarkeits- und Verifizierungsmessung durch Drittanbieter erleichtern. Derzeit werden nur JavaScript-Ressourcen unterstützt. Weitere Informationen finden Sie unter https://iabtechlab.com/standards/open-measurement-sdk/.
JSON-Darstellung
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Felder
vendor string

Der Anbieter der Überprüfung.
java_script_resources [object(JavaScriptResource)]

Liste der JavaScript-Ressourcen für die Überprüfung.
tracking_events [object(TrackingEvent)]

Liste der Tracking-Ereignisse für die Bestätigung.
parameters string

Ein nicht transparenter String, der an den Bootstrap-Bestätigungscode übergeben wird.

JavaScriptResource

JavaScriptResource enthält Informationen zur Überprüfung über JavaScript.
JSON-Darstellung
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Felder
script_url string

URI zur JavaScript-Nutzlast.
api_framework string

APIFramework ist der Name des Videoframeworks, das den Bestätigungscode verwendet.
browser_optional boolean

Gibt an, ob dieses Skript außerhalb eines Browsers ausgeführt werden kann.

TrackingEvent

TrackingEvent enthält URLs, die vom Client in bestimmten Situationen angepingt werden sollen.
JSON-Darstellung
{
  "event": string,
  "uri": string,
}
Felder
event string

Der Typ des Tracking-Ereignisses.
uri string

Das Tracking-Ereignis, das gepingt werden soll.

UniversalAdID

Mit UniversalAdID wird eine eindeutige Creative-Kennung bereitgestellt, die in allen Anzeigensystemen beibehalten wird.
JSON-Darstellung
{
  "id_value": string,
  "id_registry": string,
}
Felder
id_value string

Die universelle Anzeigen-ID des ausgewählten Creatives für die Anzeige.
id_registry string

Ein String zur Identifizierung der URL für die Registrierungswebsite, auf der die Universal Ad ID des ausgewählten Creatives katalogisiert ist.

Companion

„Companion“ enthält Informationen zu Companion-Anzeigen, die zusammen mit der Anzeige ausgeliefert werden können.
JSON-Darstellung
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Felder
click_data object(ClickData)

Die Klickdaten für diesen Companion.
creative_type string

Das CreativeType-Attribut für den <StaticResource>-Knoten im VAST, wenn es sich um einen Companion vom Typ „static“ handelt.
height int32

Die Höhe dieses Companion-Elements in Pixeln.
width int32

Die Breite dieses Companion-Banners in Pixeln.
resource string

Bei statischen und iFrame-Begleit-Creatives ist dies die URL, die geladen und angezeigt werden soll. Bei HTML-Companions ist das das HTML-Snippet, das als Companion angezeigt werden soll.
type string

Typ dieses Companion. Sie kann statisch, als iFrame oder als HTML-Code vorliegen.
ad_slot_id string

Die Slot-ID für diesen Companion.
api_framework string

Das API-Framework für diesen Companion.
tracking_events [object(TrackingEvent)]

Liste der Tracking-Ereignisse für diesen Companion.

InteractiveFile

„InteractiveFile“ enthält Informationen für interaktive Creatives (z.B. SIMID), die während der Anzeigenwiedergabe angezeigt werden sollen.
JSON-Darstellung
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Felder
resource string

Die URL des interaktiven Creatives.
type string

Der MIME-Typ der als Ressource bereitgestellten Datei.
variable_duration boolean

Gibt an, ob bei diesem Creative die Dauer verlängert werden darf.
ad_parameters string

Der Wert des Knotens <AdParameters> im VAST.