AdRequest

class AdRequest

既知の直接サブクラス
AdManagerAdRequest

AdManagerAdRequest には、Google アド マネージャーから広告を取得するために使用されるターゲティング情報が含まれています。


AdRequest には、広告の取得に使用されるターゲット設定情報が含まれます。広告リクエストは AdRequest.Builder を使用して作成されます。

アド マネージャーを使用しているパブリッシャーは、com.google.android.gms.ads.admanager.AdManagerAdRequest を使用する必要があります。

概要

ネストされた型

AdRequest をビルドします。

定数

const String!
DEVICE_ID_EMULATOR = "B3EEABB8EE11C2BE770B684D95219ECB"

setTestDeviceIds で使用するエミュレータの deviceId

const Int

アプリ ID がないため、広告リクエストが送信されませんでした。

const Int

広告サーバーから無効な応答があった場合などに生じる内部エラーです。

const Int

広告文字列が無効です。

const Int

広告リクエストが無効です(広告ユニット ID が不正確だった場合など)。

const Int

メディエーション アダプターが広告リクエストを処理しなかった。

const Int

ネットワーク接続が原因で広告のリクエストに失敗しました。

const Int

広告リクエストは成功したものの、広告枠の不足が原因で広告が返されませんでした。

const Int

広告文字列にリクエスト ID が見つかりません。

const Int

コンテンツの URL の最大長。

パブリック関数

String?

広告文字列を取得します。

String!

コンテンツの URL ターゲティング情報を返します。

Bundle?
<T : CustomEvent?> getCustomEventExtrasBundle(adapterClass: Class<T!>!)

この関数は非推奨になりました。

getNetworkExtrasBundle を代わりに使用してください。

(Mutable)Set<String!>!

ターゲティング情報のキーワードを返します。

(Mutable)List<String!>!

隣接するコンテンツの URL のリストを返します。URL が設定されていない場合は空のリストが返されます。

Bundle?
<T : MediationExtrasReceiver?> getNetworkExtrasBundle(
    adapterClass: Class<T!>!
)

特定の広告ネットワーク アダプタに渡す追加パラメータを返します。

String!

広告リクエストの送信元を識別するリクエスト エージェント文字列を返します。

Boolean
isTestDevice(context: Context!)

このデバイスがテスト広告を受信する場合は true を返します。

定数

DEVICE_ID_EMULATOR

const val DEVICE_ID_EMULATOR = "B3EEABB8EE11C2BE770B684D95219ECB": String!

setTestDeviceIds で使用するエミュレータの deviceId

ERROR_CODE_APP_ID_MISSING

const val ERROR_CODE_APP_ID_MISSING = 8: Int

アプリ ID がないため、広告リクエストが送信されませんでした。

ERROR_CODE_INTERNAL_ERROR

const val ERROR_CODE_INTERNAL_ERROR = 0: Int

広告サーバーから無効な応答があった場合などに生じる内部エラーです。

ERROR_CODE_INVALID_AD_STRING

const val ERROR_CODE_INVALID_AD_STRING = 11: Int

広告文字列が無効です。たとえば、広告文字列にリクエスト ID がありません。

ERROR_CODE_INVALID_REQUEST

const val ERROR_CODE_INVALID_REQUEST = 1: Int

広告リクエストが無効です(広告ユニット ID が不正確だった場合など)。

ERROR_CODE_MEDIATION_NO_FILL

const val ERROR_CODE_MEDIATION_NO_FILL = 9: Int

メディエーション アダプターが広告リクエストを処理しなかった。このエラーが getCode から返された場合は、getCause で根本的な原因を確認します。

ERROR_CODE_NETWORK_ERROR

const val ERROR_CODE_NETWORK_ERROR = 2: Int

ネットワーク接続が原因で広告のリクエストに失敗しました。

ERROR_CODE_NO_FILL

const val ERROR_CODE_NO_FILL = 3: Int

広告リクエストは成功したものの、広告枠の不足が原因で広告が返されませんでした。

ERROR_CODE_REQUEST_ID_MISMATCH

const val ERROR_CODE_REQUEST_ID_MISMATCH = 10: Int

広告文字列にリクエスト ID が見つかりません。

MAX_CONTENT_URL_LENGTH

const val MAX_CONTENT_URL_LENGTH = 512: Int

コンテンツの URL の最大長。

パブリック関数

getAdString

fun getAdString(): String?

広告文字列を取得します。

getContentUrl

fun getContentUrl(): String!

コンテンツの URL ターゲティング情報を返します。contentUrl が設定されていない場合は null を返します。

getCustomEventExtrasBundle

fun <T : CustomEvent?> getCustomEventExtrasBundle(adapterClass: Class<T!>!): Bundle?

特定のカスタム イベント アダプタに渡す追加のパラメータを返します。指定されたタイプのカスタム イベント エクストラが設定されていない場合は、null を返します。

getKeywords

fun getKeywords(): (Mutable)Set<String!>!

ターゲティング情報のキーワードを返します。キーワードが追加されていない場合は、空の Set を返します。

getNeighboringContentUrls

fun getNeighboringContentUrls(): (Mutable)List<String!>!

隣接するコンテンツの URL のリストを返します。URL が設定されていない場合は空のリストが返されます。

getNetworkExtrasBundle

fun <T : MediationExtrasReceiver?> getNetworkExtrasBundle(
    adapterClass: Class<T!>!
): Bundle?

特定の広告ネットワーク アダプタに渡す追加パラメータを返します。指定されたタイプのネットワーク エクストラが設定されていない場合は、null を返します。

getRequestAgent

fun getRequestAgent(): String!

広告リクエストの送信元を識別するリクエスト エージェント文字列を返します。

isTestDevice

fun isTestDevice(context: Context!): Boolean

このデバイスがテスト広告を受信する場合は true を返します。