NativeCustomFormatAd

interface NativeCustomFormatAd

アド マネージャーのカスタム ネイティブ広告フォーマット。カスタム（ユーザー定義の）ネイティブ広告フォーマットでは、従来のネイティブ広告用に独自の変数を定義できます。カスタム ネイティブ広告フォーマットを使用すると、独自のアセットを定義してレンダリングし、広告のクリック動作を定義できます。

概要

ネストされた型

ディスプレイ広告のオープン測定用のインターフェース。

ユーザーがカスタム ネイティブ広告フォーマットをクリックしたときに呼び出されるコールバックのインターフェース定義。

カスタム ネイティブ広告フォーマットが正常に読み込まれたときに呼び出されるコールバックのインターフェース定義。

定数
const String!
ASSET_NAME_VIDEO = "_videoMediaView"

getMediaContent によって返される動画コンテンツに関連付けられたアセット名。

パブリック関数
Unit

広告オブジェクトを破棄します。
(Mutable)List<String!>?

使用可能なすべてのアセットのリストを返します。
String?

アド マネージャーの管理画面で定義されているカスタム ネイティブ広告フォーマットの ID を返します。
NativeCustomFormatAd.DisplayOpenMeasurement?

この広告に関連付けられている DisplayOpenMeasurement を返します。
NativeAd.Image?
getImage(assetName: String!)

画像アセットを返します。
MediaContent?

この広告に関連付けられている MediaContent を返します。
CharSequence?
getText(assetName: String!)

画像アセット以外の数値、URL、その他のタイプの文字列アセットを返します。
Unit
performClick(assetName: String!)

広告をクリックして、クリックスルー動作を実行します。
Unit

インプレッションを記録します。

定数

ASSET_NAME_VIDEO

const val ASSET_NAME_VIDEO = "_videoMediaView": String!

getMediaContent によって返される動画コンテンツに関連付けられたアセット名。これは、ユーザーが getMediaContent から返された動画コンテンツを含む MediaView をクリックしたときに onCustomClick でレポートされるアセット名です。

パブリック関数

destroy

fun destroy(): Unit

広告オブジェクトを破棄します。destroy が呼び出された後は、広告オブジェクトで他のメソッドを呼び出さないでください。

getAvailableAssetNames

fun getAvailableAssetNames(): (Mutable)List<String!>?

使用可能なすべてのアセットのリストを返します。

戻り値
(Mutable)List<String!>?

使用可能なすべてのアセットのリスト。使用可能なアセットがない場合は空のリスト。

getCustomFormatId

fun getCustomFormatId(): String?

アド マネージャーの管理画面で定義されているカスタム ネイティブ広告フォーマットの ID を返します。

getDisplayOpenMeasurement

fun getDisplayOpenMeasurement(): NativeCustomFormatAd.DisplayOpenMeasurement?

この広告に関連付けられている DisplayOpenMeasurement を返します。

戻り値
NativeCustomFormatAd.DisplayOpenMeasurement?

この広告でディスプレイ オープン測定を利用できない場合は null。

getImage

fun getImage(assetName: String!): NativeAd.Image?

画像アセットを返します。

パラメータ
assetName: String!

取得するアセットの名前。
戻り値
NativeAd.Image?

アセット名を持つアセットの値。そのようなアセット名がない場合は null。

getMediaContent

fun getMediaContent(): MediaContent?

この広告に関連付けられている MediaContent を返します。

getText

fun getText(assetName: String!): CharSequence?

画像アセット以外の数値、URL、その他のタイプの文字列アセットを返します。

パラメータ
assetName: String!

取得するアセットの名前。
戻り値
CharSequence?

アセット名を持つアセットの値。そのようなアセット名がない場合は null。

performClick

fun performClick(assetName: String!): Unit

広告をクリックして、クリックスルー動作を実行します。

パラメータ
assetName: String!

クリックされたアセットの名前。

recordImpression

fun recordImpression(): Unit

インプレッションを記録します。広告がユーザーに初めて表示されたときに、このメソッドを呼び出します。