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"

deviceId 適用於搭配 setTestDeviceIds 使用的模擬器。
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!

deviceId 適用於搭配 setTestDeviceIds 使用的模擬器。

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?

傳回要傳遞至特定自訂事件介面的額外參數。如果未設定所提供類型的任何自訂事件額外資訊，則傳回 null。

getKeywords

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

傳回指定目標資訊關鍵字。如果沒有新增任何關鍵字，則傳回空白 Set。

getNeighboringContentUrls

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

傳回鄰近內容網址清單，如果未設定任何網址，則傳回空白清單。

getNetworkExtrasBundle

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

傳回要傳遞至特定廣告聯播網介面的額外參數。如果未設定所提供類型的電視網加購內容，則會傳回 null。

getPlacementId

fun getPlacementId(): Long

取得此 AdRequest 中設定的刊登位置 ID

getRequestAgent

fun getRequestAgent(): String!

傳回要求代理程式字串，以識別廣告要求的來源。

isTestDevice

fun isTestDevice(context: Context!): Boolean

如果這個裝置會收到測試廣告，則傳回 true。