このページは Cloud Translation API によって翻訳されました。

クラス: Ad

Methods

getAdId

getAdId() は文字列を返す

広告 ID は、メインの広告とコンパニオン広告の同期に使用されます。

戻り値: string 広告の ID、またはこの情報を取得できない場合は空の文字列。

getAdPodInfo

getAdPodInfo() は AdPodInfo を返します

広告の連続配信広告情報を返します。

戻り値: non-null AdPodInfo 連続配信広告に関する情報。

getAdSystem

getAdSystem() は文字列を返します

広告レスポンスに含まれるソース広告サーバー情報。

戻り値: string 広告の広告サーバー。この情報を取得できない場合は空の文字列です。

広告主名の取得

getCreativeName() は文字列を返します

広告配信事業者によって定義された広告主名。

戻り値: string 広告主名。この情報を使用できない場合は空の文字列。

getApiFramework

getApiFramework() は文字列を返します

広告の配信に必要な API を示します。これは VAST で指定された apiFramework に対応します。

戻り値: nullable string API フレームワークは広告を実行する必要があります。この情報を取得できない場合は null になります。

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) は、null 以外の CompanionAd の配列を返します

コンパニオン広告スロットのサイズに基づいて、この広告のコンパニオン広告を取得します。必要に応じて、高度な選択設定も使用できます。このメソッドは、STARTED イベント以降に取得された広告インスタンスに対して、空でない配列のみを返すことに注意してください。具体的には、LOADED イベントの広告は空の配列を返します。

パラメータ
adSlotWidth	数値コンパニオン広告スロットの幅。
adSlotHeight	数値コンパニオン広告スロットの高さ。
設定にアクセスする必要があります。	任意 CompanionAdSelectionSettings コンパニオン広告の選択設定。値を null にすることはできません。

パラメータ

adSlotWidth

数値

コンパニオン広告スロットの幅。

adSlotHeight

数値

コンパニオン広告スロットの高さ。

設定にアクセスする必要があります。

任意

CompanionAdSelectionSettings

コンパニオン広告の選択設定。

値を null にすることはできません。

戻り値: non-null Array of non-null CompanionAd 設定とスロットサイズに一致するコンパニオン広告の配列。

getContentType

getContentType() は文字列を返す

現在選択されているクリエイティブのコンテンツタイプを返します。クリエイティブが選択されていない場合やコンテンツタイプが利用できない場合は空の文字列を返します。リニア広告の場合、メディアファイルが選択された状態で、START イベント後にのみコンテンツタイプを利用できます。

戻り値: stringコンテンツタイプ。空の文字列（利用できない場合）。

getCreativeAdId

getCreativeAdId() は文字列を返します

広告の ISCI (Industry Standard Commercial Identifier) コードを返します。コードが利用できない場合は空の文字列を返します。VAST レスポンス内のクリエイティブの広告 ID です。

戻り値: string

getCreativeId

getCreativeId() は文字列を返します

広告で選択したクリエイティブの ID を取得します。

戻り値: string 広告で選択したクリエイティブの ID。この情報を使用できない場合は空の文字列です。

getDealId

getDealId() は文字列を返します

現在の広告のラッパーチェーンに存在する最初の取引 ID を上から返します。利用できない場合は、空の文字列を返します。

戻り値: string

getDescription

getDescription() は文字列を返す

VAST レスポンスからこの広告の説明を返します。

戻り値: string 説明。指定しない場合、空になります。

getDuration

getDuration() は数値を返します

選択したクリエイティブの再生時間を返します。ノンリニアクリエイティブの場合は -1 を返します。

戻り値: number 選択されたクリエイティブの再生時間（秒）。非線形の場合は -1。

getHeight

getHeight() は数値を返します

選択したノンリニアクリエイティブの高さを返します。

戻り値: number: 選択したノンリニアクリエイティブの高さ。リニアクリエイティブの場合は 0 です。

getMediaUrl

getMediaUrl() は文字列を返す

現在使用されているメディア選択設定に基づいて、広告から選択されたメディアファイルの URL を返します。この情報を使用できない場合は、null が返されます。STARTED イベントでご利用いただけます。

戻り値: nullable string

getMinDuration

getMinSuggestedDuration() は数値を返す

ノンリニアクリエイティブを表示する推奨最小再生時間（秒単位）を返します。提案された最小時間が不明な場合は -2 を返します。リニアクリエイティブの場合は、広告の再生時間全体が返されます。

戻り値: numberクリエイティブを表示する必要がある最小の推奨時間（秒単位）。

getSkipTimeOffset

getSkipTimeOffset() は数値を返します

広告がスキップ可能になるまでの秒数。スキップ不可の広告または使用できない場合は -1 が返されます。

戻り値: number: オフセット（秒単位、-1）。

getSurveyUrl

getSurveyUrl() は文字列を返します

指定した広告のアンケートに関連付けられた URL を返します。利用できない場合は null を返します。

戻り値: nullable string

getTitle

getTitle() は文字列を返す

VAST レスポンスからこの広告のタイトルを返します。

戻り値: stringタイトルを指定します。指定しなかった場合は空になります。

getTraffickingParameters

getTraffickingParameters() は文字列プロパティを持つオブジェクトを返します。

広告の入稿時に、広告に関連付けられていたカスタムパラメータを取得します。

戻り値: non-null Object with string properties 入稿キーとその値のマッピング（この情報を利用できない場合は空のオブジェクト）。

getTraffickingParametersString

getTraffickingParametersString() は文字列を返します

広告の入稿時に、広告に関連付けられていたカスタムパラメータを取得します。getTraffickingParameters から解析されたパラメータの未加工の文字列バージョンを返します。

戻り値: string 入稿パラメータ。この情報を使用できない場合は空の文字列。

getUiElements

getUiElements() は文字列の配列を返します

この広告が再生されたときに表示される UI 要素を返します。返される配列の要素については、UiElements を参照してください。

戻り値: non-null Array of string 表示されている UI 要素。

getUniversalAdIdRegistry

getUniversalAdIdRegistry() は文字列を返す

広告で選択したクリエイティブの UniversalAdId のカタログ化に関連するレジストリ。

非推奨: 代わりに ad.getUniversalAdIds() を使用してください。
戻り値: string レジストリ値、または使用できない場合は「不明」を返します。

getUniversalAdIdValue

getUniversalAdIdValue() は文字列を返します

広告で選択されているクリエイティブの UniversalAdId。

非推奨: 代わりに ad.getUniversalAdIds() を使用してください。
戻り値: string ID 値を返します。使用できない場合は「不明」を返します。

getUniversalAdIds

getUniversalAdIds() は、null 以外の UniversalAdIdInfo の配列を返します

広告で選択したクリエイティブの UniversalAdId のリスト。

戻り値: non-null Array of non-null UniversalAdIdInfo この広告に適用されるユニバーサル広告 ID 情報のリストを返します。

getVastMediaBitrate

getVastMediaBitrate() は数値を返す

クリエイティブとメディアファイルの両方が SDK により選択されると、VAST レスポンスに記載されているメディアファイルのビットレートが返されます。

戻り値: number 選択したメディアファイルのビットレートまたは 0。

getVastMediaHeight

getVastMediaHeight() は数値を返します

選択したクリエイティブの VAST メディアの高さを返します。

戻り値: number 選択したクリエイティブの VAST メディアの高さ。何も選択されていない場合は 0。

getVastMediaWidth

getVastMediaWidth() は数値を返す

選択したクリエイティブの VAST メディア幅を返します。

戻り値: number 選択したクリエイティブの VAST メディアの幅。何も選択されていない場合は 0。

getWidth

getWidth() は数値を返します

選択したクリエイティブの幅を返します。

戻り値: number: 選択したノンリニアクリエイティブの幅。リニアクリエイティブの場合は 0。

getWrapperAdIds

getWrapperAdIds() は文字列の配列を返す

ラッパー広告に使用される広告 ID。返された ID はインライン広告（最も内側）で開始され、最も外側のラッパー広告に走査されます。ラッパー広告がない場合は、空の配列が返されます。

戻り値: non-null Array of string: インライン広告で始まる広告の ID。ラッパー広告がない場合は空の配列。

getWrapperAdSystems

getWrapperAdSystems() は文字列の配列を返す

ラッパー広告に使用される広告システム。返された広告システムは、インライン広告から開始して、最も外側のラッパー広告に走査します。ラッパー広告がない場合は、空の配列が返されます。

戻り値: non-null Array of string: インライン広告（ラッパー広告がない場合は空の配列）から始まる、広告システム。

getWrapperCreativeIds

getWrapperCreativeIds() は文字列の配列を返す

ラッパー広告に使用する選択したクリエイティブ ID。返されたクリエイティブ ID はインライン広告で開始され、最も外側のラッパー広告に走査されます。ラッパー広告がない場合は、空の配列が返されます。

戻り値: non-null Array of string - インライン広告で始まる広告クリエイティブの ID。ラッパー広告がない場合は空の配列。

IsLinear

isLinear() はブール値を返す

広告の現在の動作モードが線形か非線形かを示します。値が true の場合、広告がリニア再生モードであることを示します。false の場合、非線形モードを示します。プレーヤーは線形プロパティを確認し、広告プレースメントの詳細に従って状態を更新します。広告がリニアモードの場合、プレーヤーはコンテンツ動画を一時停止します。最初はリニアが true で、広告がプレロール（外部で定義）である場合、プレーヤーは広告再生が終わる間際にコンテンツ動画の読み込みを遅らせることができます。

戻り値: boolean: 広告が線形の場合に true、そうでない場合は false です。