クラス: StreamRequest

ima.StreamRequest

class   static

コンストラクタ

StreamRequest

新しいストリームリクエスト()

ストリーム要求のプロパティを指定するために使用されます。

プロパティ

adTagParameters

static

文字列

省略可。ストリーム リクエストで、広告タグのパラメータの一部をオーバーライドできます。詳しくは、ストリームにターゲティング パラメータを指定するをご覧ください。ストリーム バリアントの優先度には、dai-ot パラメータと dai-ov パラメータを使用することもできます。詳しくは、ストリームのバリエーション パラメータをオーバーライドするをご覧ください。

adUiNode

static

roSGNode

広告 UI が表示されるシーングラフ ノード。IMA は、広告の再生中にこの要素に [広告の表示について] ボタンや [スキップ] ボタンなどの要素を配置します。要素は動画要素全体を覆う必要があります。

apiKey

static

文字列

省略可。これらのキーは、ストリーム リクエストの認証に使用できます。DAI 認証キーは、DFP の管理画面で設定する必要があります。

assetKey

static

文字列

ライブストリームに必要です。これは、どのストリームを再生するかを決定するために使用されます。ライブ ストリーム リクエストのアセットキーは、DFP 管理画面で確認できる識別子です。

authToken

static

文字列

ストリーム要求の承認トークン。より厳密なコンテンツ認証のために API キーの代わりに使用されます。パブリッシャーは、このトークンに基づいて個々のコンテンツ ストリームの承認を制御できます。

contentSourceId

static

文字列

オンデマンド ストリームに必要です。cmsid は、DFP UI の DFP 動画コンテンツ ソースから取得されます。

customAssetKey

static

文字列

カスタム アセットキーは、どのストリームを再生するかを判断するために使用されます。Pod サービング ストリーム リクエストにはカスタム アセットキーが必要です。

形式

static

ima.StreamFormat

ストリームの形式。デフォルトは ima.StreamFormat.HLS です。

networkCode

static

文字列

ストリーム リクエストを行うパブリッシャーのネットワーク コード。createPodLiveStreamRequest または createPodVodStreamRequest で行われたストリーム リクエストを処理する Pod には、ネットワーク コードが必要です。これらのコードは、createVideoStitcherLiveStreamRequest、createVideoStitcherVodStreamRequest、または createVideoStitcherVodStreamRequestWithVodConfig を使用して行われたクラウド ステッチング ストリーム リクエストにも必要です。これらのコードは省略可能で、createLiveStreamRequest または createVodStreamRequest で作成されたフルサービス ストリーム リクエストに推奨されます。ネットワーク コードを追加すると、アド マネージャーの UI で選択した設定（プログラマティック制限付き広告の有効化など）が適用されます。Pod サービングとクラウド スティッチングの場合、ネットワーク コードを追加すると、ストリームが検索されて再生されます。ネットワーク コードを見つけるには、こちらの記事をご覧ください。

プレーヤー

static

（ima.Player または無効）

プレーヤー インターフェイスの実装。

ppid

static

文字列

非推奨です。adTagParameters を使用します。 省略可。DFP オーディエンスのパブリッシャー提供の識別子。

streamActivityMonitorId

static

文字列

ストリーム アクティビティ モニターを使用してストリームをデバッグするために使用する ID。 これは、パブリッシャーがストリーム アクティビティ モニター ツールでストリーム ログを見つけられるようにする便利な方法を提供するために使用されます。

videoId

static

文字列

オンデマンド ストリームに必須です。 動画コンテンツ ソースの識別子。

videoObject

static

（roVideo または Invalid）

クライアントアプリでのビデオ再生を司るビデオオブジェクト（Video roSGNode など）。このオブジェクトは、Live HLS ID3 イベントのタイミングを適切に計時するために使用する様々なデータを取得するためにポーリングされます。

videoStitcherSessionOptions

static

V の配列

セッション オプションは、VideoStitcher streamRequests の動画スティッチャー固有のパラメータを設定するために使用されます。

メソッド

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) は ima.StreamRequest を返します。

ライブの必須プロパティを初期化しますStreamRequest。この API を使用すると、他の StreamType 固有のプロパティは無視されます。必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

assetKey

文字列

apiKey

文字列

返されるパラメータに割り当てられたima.StreamRequestのima.StreamRequest.apiKey財産。API キーが存在しない場合は、空の文字列を渡します。

networkCode

文字列

ストリーム要求を行うパブリッシャーのネットワーク コード。ネットワーク コードを含めるかどうかは任意ですが、含めることをおすすめします。
戻り値

必須の Live プロパティを含む ima.StreamRequest ima.StreamRequest オブジェクト。

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) は StreamRequest を返します

Pod Live の必須プロパティを初期化しますima.StreamRequest。 この API を使用すると、他のima.StreamType- 無視される固有のプロパティ。 必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

customAssetKey

文字列

networkCode

文字列

apiKey

文字列

返されるオプションパラメータima.StreamRequestのima.StreamRequest.apiKeyプロパティ。デフォルトは空の文字列です。

戻り値

StreamRequest ima.StreamRequest必要な PodLive プロパティを持つオブジェクト。

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode)は StreamRequest を返します

サードパーティの動画スティッチャーで DAI Pod サービングを使用するときに、VOD ストリームを登録するために ima.StreamRequest の必須プロパティを初期化します。この関数はリクエストタイプをima.StreamType.POD_VOD欠落データに対して必要なすべてのプロパティを検証します。検証に失敗すると、デバッグ コンソールにエラーが記録されます。

パラメータ

networkCode

文字列

Google Ad Manager ネットワーク コード
戻り値

StreamRequest一つのima.StreamRequest物体。必要なプロパティがすべて指定されている場合、リクエストタイプは次のように設定されます。ima.StreamType.POD_VOD 。

createStreamRequest

static

createStreamRequest() は ima.StreamRequest を返します。

戻り値

ima.StreamRequest空のima.StreamRequest物体。

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) は ima.StreamRequest を返します。

Video Stitcher Live の必須プロパティを初期化しますStreamRequest。この API を使用すると、他の StreamType 固有のプロパティはすべて無視されます。必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

customAssetKey

文字列

networkCode

文字列

liveConfigId

文字列

地域

文字列

projectNumber

文字列

oAuthToken

文字列
戻り値

ima.StreamRequest ima.StreamRequest必要な VideoStitcherLive プロパティを持つオブジェクト。

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) は ima.StreamRequest を返します。

ビデオ スティッチャー VOD の必須プロパティを初期化しますStreamRequest。この API を使用すると、他のStreamType- 無視される固有のプロパティ。 必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

adTagUrl

文字列

networkCode

文字列

contentSourceUrl

文字列

地域

文字列

projectNumber

文字列

oAuthToken

文字列
戻り値

ima.StreamRequest ima.StreamRequest必要な VideoStitcherVod プロパティを持つオブジェクト。

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) は ima.StreamRequest を返します。

ビデオ スティッチャー VOD の必須プロパティを初期化しますStreamRequest使用してvodConfigIdクラウド ビデオ スティッチャーから作成されました。 この API を使用すると、他のStreamType- 無視される固有のプロパティ。 必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

vodConfigId

文字列

networkCode

文字列

地域

文字列

projectNumber

文字列

oAuthToken

文字列
戻り値

ima.StreamRequest ima.StreamRequest必要な VideoStitcherVod プロパティを持つオブジェクト。

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) は ima.StreamRequest を返します。

VOD の必須プロパティを初期化しますima.StreamRequest。この API を使用すると、他のima.StreamType- 無視される固有のプロパティ。 必須パラメータのいずれかが空文字列の場合、エラーログが生成され、API は汎用的なStreamRequest、プロパティは無視されません。

パラメータ

contentSourceId

文字列

videoId

文字列

apiKey

文字列

返されるパラメータに割り当てられたima.StreamRequestのima.StreamRequest.apiKey財産。API キーが存在しない場合は、空の文字列を渡します。

networkCode

文字列

ストリーム要求を行うパブリッシャーのネットワーク コード。ネットワーク コードを含めるかどうかは任意ですが、含めることをおすすめします。
戻り値

ima.StreamRequest ima.StreamRequest必要な VOD プロパティを持つオブジェクト。