Klasse: StreamRequest

ima.StreamRequest

class   static

Konstruktor

StreamRequest

new StreamRequest()

Wird verwendet, um Eigenschaften der Streamanfrage anzugeben.

Attribute

adTagParameters

static

String

Optional. Sie können eine begrenzte Anzahl von Anzeigen-Tag-Parametern in Ihrer Streamanfrage überschreiben. Weitere Informationen zum Übertragen von Targeting-Parametern an einen Stream Sie können auch die Parameter „dai-ot“ und „dai-ov“ für die bevorzugte Stream-Variante verwenden. Weitere Informationen zum Überschreiben der Parameter von Streamvarianten

adUiNode

static

roSGNode

Ein Knoten im Szenengraphen, in dem die Benutzeroberfläche für Anzeigen angezeigt wird. Das IMA SDK platziert während der Anzeigen Elemente wie die Schaltflächen Warum sehe ich diese Werbung? und Überspringen in diesem Element. Das Element muss das gesamte Videoelement überlagern.

apiKey

static

String

Optional. Diese Schlüssel können zur Authentifizierung von Streamanfragen verwendet werden. Authentifizierungsschlüssel für die dynamische Anzeigenbereitstellung müssen in der DFP-Benutzeroberfläche eingerichtet werden.

assetKey

static

String

Für Livestreams erforderlich. Damit wird festgelegt, welcher Stream wiedergegeben werden soll. Der Asset-Schlüssel der Livestream-Anfrage ist eine Kennung, die auf der DFP-Benutzeroberfläche zu finden ist.

authToken

static

String

Das Autorisierungstoken für die Streamanfrage. Wird anstelle des API-Schlüssels für eine strengere Inhaltsautorisierung verwendet. Der Publisher kann die Autorisierungen für einzelne Contentstreams anhand dieses Tokens steuern.

contentSourceId

static

String

Für On-Demand-Streams erforderlich. Die cmsid stammt aus der DFP-Videocontentquelle auf der DFP-Benutzeroberfläche.

customAssetKey

static

String

Der benutzerdefinierte Asset-Schlüssel dient dazu, festzulegen, welcher Stream abgespielt werden soll. Für Pod-Serving-Stream-Anfragen werden benutzerdefinierte Asset-Schlüssel benötigt.

Format

static

ima.StreamFormat

Das Format des Streams. Die Standardeinstellung ist ima.StreamFormat.HLS.

networkCode

static

String

Der Netzwerkcode des Publishers, der die Streamanfrage stellt. Für Pod-Serving-Stream-Anfragen, die mit createPodLiveStreamRequest oder createPodVodStreamRequest gestellt werden, sind Netzwerkcodes erforderlich. Diese Codes werden auch für Cloud-Stitching-Stream-Anfragen benötigt, die mit createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest oder createVideoStitcherVodStreamRequestWithVodConfig gestellt werden. Diese Codes sind optional und werden für Full-Service-Stream-Anfragen empfohlen, die mit createLiveStreamRequest oder createVodStreamRequest gestellt werden. Durch das Hinzufügen des Netzwerkcodes werden die in der Ad Manager-Benutzeroberfläche ausgewählten Einstellungen angewendet, z. B. die programmatische Aktivierung von eingeschränkten Anzeigen. Für Pod-Serving und Cloud-Stitching wird durch Hinzufügen des Netzwerkcodes der Stream gefunden und wiedergegeben. Den Netzwerkcode finden Sie in diesem Artikel.

Spieler

static

(ima.Player oder ungültig)

Eine Implementierung der Player-Schnittstelle.

ppid

static

String

Verworfen. Verwenden Sie „adTagParameters“. Optional. Eine vom Publisher bereitgestellte Kennung für DFP Audience.

streamActivityMonitorId

static

String

Die ID, die zum Debuggen des Streams mit der Überprüfung der Streamingaktivitäten verwendet werden soll. So können Publisher ganz einfach ein Streamlog im Tool zur Überprüfung der Streamingaktivitäten finden.

videoId

static

String

Für On-Demand-Streams erforderlich. Kennung für die Videocontentquelle.

videoObject

static

(roVideo oder ungültig)

Das Videoobjekt (z. B. der Video-roSGNode), das für die Videowiedergabe in der Client-App verantwortlich ist. Dieses Objekt wird nach verschiedenen Daten abgefragt, die für das richtige Timing von Live-HLS-ID3-Ereignissen verwendet werden.

videoStitcherSessionOptions

static

Array von V

Mit den Sitzungsoptionen werden Video Stitcher-spezifische Parameter für VideoStitcher-Streamanfragen festgelegt.

Methoden

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) gibt ima.StreamRequest zurück

Initialisiert erforderliche Attribute eines Live-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
assetKey	String
apiKey	String Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen ist. Wenn kein API-Schlüssel vorhanden ist, übergeben Sie einen leeren String.
networkCode	String Netzwerkcode des Publishers, der die Streamanfrage stellt. Die Angabe des Netzwerkcodes ist optional, wird aber empfohlen.

Ausgabe

ima.StreamRequest-Objekt ima.StreamRequest mit erforderlichen Live-Eigenschaften.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

Initialisiert erforderliche Attribute eines Pod-Livestreams ima.StreamRequest. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
customAssetKey	String
networkCode	String
apiKey	String Optionaler Parameter, der der ima.StreamRequest.apiKey-Eigenschaft der zurückgegebenen ima.StreamRequest zugewiesen wird. Der Standardwert ist ein leerer String.

Ausgabe

StreamRequest-ima.StreamRequest-Objekt mit erforderlichen PodLive-Properties.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) returns StreamRequest

Initialisiert die erforderlichen Attribute eines ima.StreamRequest, um einen VOD-Stream zu registrieren, wenn die Pod-Auslieferung mit dynamischer Anzeigenbereitstellung mit einem Drittanbieter-Video-Stitcher verwendet wird. Mit dieser Funktion wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt und es wird geprüft, ob für alle erforderlichen Attribute Daten fehlen. Bei fehlgeschlagenen Validierungen wird ein Fehler in der Debug-Konsole protokolliert.

Parameter
networkCode	String der Google Ad Manager-Netzwerkcode

Ausgabe

StreamRequest ein ima.StreamRequest-Objekt. Wenn alle erforderlichen Properties angegeben sind, wird der Anfragetyp auf ima.StreamType.POD_VOD festgelegt.

createStreamRequest

static

createStreamRequest() gibt ima.StreamRequest zurück

Ausgabe

ima.StreamRequest Ein leeres ima.StreamRequest-Objekt.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) returns ima.StreamRequest

Initialisiert erforderliche Eigenschaften eines Video Stitcher Live-StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
customAssetKey	String
networkCode	String
liveConfigId	String
Region	String
projectNumber	String
oAuthToken	String

Ausgabe

ima.StreamRequest ima.StreamRequest-Objekt mit erforderlichen VideoStitcherLive-Eigenschaften.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) returns ima.StreamRequest

Initialisiert die erforderlichen Attribute eines Video Stitcher VOD StreamRequest. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
adTagUrl	String
networkCode	String
contentSourceUrl	String
Region	String
projectNumber	String
oAuthToken	String

Ausgabe

ima.StreamRequest ima.StreamRequest-Objekt mit erforderlichen VideoStitcherVod-Properties.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) gibt ima.StreamRequest zurück

Initialisiert die erforderlichen Eigenschaften eines Video Stitcher VOD-Objekts StreamRequest mit vodConfigId, das vom Cloud Video Stitcher erstellt wurde. Wenn Sie diese API verwenden, werden alle anderen StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
vodConfigId	String
networkCode	String
Region	String
projectNumber	String
oAuthToken	String

Ausgabe

ima.StreamRequest ima.StreamRequest-Objekt mit erforderlichen VideoStitcherVod-Properties.

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) returns ima.StreamRequest

Initialisiert erforderliche Attribute eines VOD-ima.StreamRequest. Wenn Sie diese API verwenden, werden alle anderen ima.StreamType-spezifischen Eigenschaften ignoriert. Wenn erforderliche Parameter leere Strings sind, wird ein Fehler protokolliert und die API gibt einen generischen StreamRequest-Fehler zurück, ohne dass Eigenschaften ignoriert werden.

Parameter
contentSourceId	String
videoId	String
apiKey	String Parameter, der dem Attribut ima.StreamRequest.apiKey des zurückgegebenen ima.StreamRequest zugewiesen ist. Wenn kein API-Schlüssel vorhanden ist, übergeben Sie einen leeren String.
networkCode	String Netzwerkcode des Publishers, der die Streamanfrage stellt. Die Angabe des Netzwerkcodes ist optional, wird aber empfohlen.

Ausgabe

ima.StreamRequest-ima.StreamRequest-Objekt mit erforderlichen VOD-Properties.