AdRequest

class AdRequest

已知的直接子类
AdManagerAdRequest

AdManagerAdRequest 包含用于从 Google Ad Manager 中提取广告的定位信息。

AdRequest 包含用于提取广告的定位信息。广告请求是使用 AdRequest.Builder 创建的。

使用 Ad Manager 的发布商应使用 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

内容网址长度上限。

公共函数
String?

获取广告字符串。
String!

返回内容网址定位信息。
Bundle?
<T : CustomEvent?> getCustomEventExtrasBundle(adapterClass: Class<T!>!)

此函数已弃用。

请改用 getNetworkExtrasBundle。
(Mutable)Set<String!>!

返回定位信息关键字。
(Mutable)List<String!>!

返回邻近内容网址的列表；如果未设置任何网址，则返回空列表。
Bundle?
<T : MediationExtrasReceiver?> getNetworkExtrasBundle(
    adapterClass: Class<T!>!
)

返回要传递给特定广告联盟适配器的额外参数。
Long

获取此 AdRequest 中设置的展示位置 ID
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

内容网址长度上限。

公共函数

getAdString

fun getAdString(): String?

获取广告字符串。

getContentUrl

fun getContentUrl(): String!

返回内容网址定位信息。如果未设置 contentUrl，则返回 null。

getCustomEventExtrasBundle

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

返回要传递给特定自定义事件适配器的额外参数。如果没有设置所提供类型的任何自定义事件 extras，则返回 null。

getKeywords

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

返回定位信息关键字。如果没有添加任何关键字，则返回空的 Set。

getNeighboringContentUrls

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

返回邻近内容网址的列表；如果未设置任何网址，则返回空列表。

getNetworkExtrasBundle

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

返回要传递给特定广告联盟适配器的额外参数。如果没有设置所提供类型的任何广告联盟 extras，则返回 null。

getPlacementId

fun getPlacementId(): Long

获取此 AdRequest 中设置的展示位置 ID

getRequestAgent

fun getRequestAgent(): String!

返回用于标识广告请求来源的请求代理字符串。

isTestDevice

fun isTestDevice(context: Context!): Boolean

如果相应设备将接收测试广告，则返回 true。