Android
Adiz Android¶
Adiz Android 是 Hive 提供的一個 Android 廣告模組,旨在簡化使用 AdMob 提供的廣告曝光功能。Adiz Android 提供的廣告類型如下:
- 插頁式廣告
- 橫幅廣告
- 原生廣告
- 獎勵廣告
- 獎勵插頁式廣告
- 應用程式開啟廣告
要安裝和使用 Adiz Android,請按照下面的指南進行。
安裝¶
將 Adiz 庫條目添加到應用級 Gradle 文件 (app/build.gradle)。
要支持 Java 8 功能,请在模块的应用级 Gradle 文件中的 android
设置下添加以下内容。
android {
// ...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
AndroidManifest.xml 文件,输入 AdMobId
(格式为 ca-app-pub-XXXXX~YYYYY)。
<manifest>
<application>
<!-- Sample AdMob app ID: ca-app-pub-3940256099942544~3347511713 -->
<meta-data
android:name="com.google.android.gms.ads.APPLICATION_ID"
android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
</application>
</manifest>
使用 Proguard 時,Adiz 模組的 ProGuard 規則已包含在內。因此,無需將 ProGuard 規則添加到項目中。
要顯示視頻廣告,您需要啟用硬體加速。在AndroidManifest.xml文件中添加硬體加速的設置。將其添加到application
標籤中會為整個應用程序啟用硬體加速。將其添加到activity
標籤中僅會為您想要顯示廣告的特定Activity
啟用硬體加速。
<application android:hardwareAccelerated="true">
<!-- For activities that use ads, hardwareAcceleration should be true. -->
<activity android:hardwareAccelerated="true" />
</application>
測試廣告設定¶
Adiz 可以以兩種方式顯示測試廣告。
- 啟用測試模式:僅顯示由 AdMob 發佈的測試廣告
- 註冊測試設備後顯示廣告:顯示真實廣告以進行測試,確保不會發生無效流量,並通過註冊將顯示測試廣告的設備來進行
啟用測試模式¶
在開發階段,啟用測試模式,以便點擊測試廣告不會向廣告主收費。當測試模式啟用時,將僅顯示測試廣告。在測試模式下,即使未在控制台中輸入 AdMob 廣告密鑰,也會顯示測試廣告。在商業發行期間停用測試模式。
有兩種方法可以啟用測試模式。
<
- 在 Hive 控制台中注册测试设备后,请使用 演示广告 进行设置(推荐):
请参考控制台指南中的 测试设备管理 部分。 - 使用 Adiz 类的
setTestMode()
方法:
参考下面的 示例代码。
Note
在開發階段未處於測試模式時,過多的廣告點擊可能會被視為無效流量,您的 AdMob 帳戶可能會被報告,從而阻止廣告顯示。
使用 Adiz.setTestMode() 方法¶
import com.hive.adiz.Adiz;
import com.hive.adiz.AdizError;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import org.json.JSONArray;
import org.json.JSONObject;
import java.util.ArrayList;
// 啟用測試模式。對於商業發行,請註解掉以下行。
Adiz.setTestMode(true);
// 啟用 Hive Adiz 模組的日誌記錄。日誌記錄應僅在測試模式下使用。對於商業發行,請註釋掉以下行。
Adiz.setLogEnable(true);
測試設備廣告曝光¶
在以下情況下,您需要註冊一個測試設備以顯示測試廣告。
有兩種方法可以在測試設備上顯示廣告。
<
-
在 Hive 控制台中注册测试设备后,将其设置为 使用广告单元 ID(推荐):
请参阅控制台指南的 测试设备管理 部分。 -
使用Adiz類別的
setTestDevice()
方法:
請參考下面的範例代碼。
Note
如果您在未注册测试设备的情况下进行显示实际广告的测试,可能会被视为无效流量,从而导致您的 AdMob 帐户被封锁,广告将不再显示。当您注册测试设备时,在广告展示期间将显示“测试模式”或“测试广告”(原生广告)。在商业分发期间,您必须停用测试设备。
使用 Adiz.setTestDevice() 方法¶
要註冊測試設備,您首先需要檢查測試設備 ID。測試設備 ID(例如:33BE2250B43518CCDA7DE426D04EE231
)可以通過以下兩種方式檢查。
-
在呼叫
Adiz.Initialize()
後檢查 Logcat 日誌: -
在呼叫
Adiz.Initialize()
之後,無論廣告類型為何,都要呼叫initialize()
→load()
並檢查 Logcat 日誌:
在检查测试设备 ID 后,在现有的 Adiz 初始化代码中执行 Adiz.initialize
之前添加行 Adiz.setTestDevice(DEVICE_ID)
。将复制的测试设备 ID 输入到 DEVICE_ID
中。
import com.hive.Adiz
import com.hive.adiz.AdizError
import org.json.JSONObject
fun initialize() {
Adiz.setTestDevice("33BE2250B43518CCDA7DE426D04EE231")
Adiz.initialize(activity, object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
// ... omitted
}
})
}
import com.hive.Adiz;
import com.hive.adiz.AdizError;
import org.json.JSONObject;
public void initialize() {
Adiz.setTestDevice("33BE2250B43518CCDA7DE426D04EE231");
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... omitted
}
}
});
}
import com.hive.Adiz;
import com.hive.adiz.AdizError;
import org.json.JSONObject;
public void initialize() {
Adiz.setTestDevice("33BE2250B43518CCDA7DE426D04EE231");
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... omitted
}
}
});
}
廣告檢查器使用¶
廣告檢查器是一個應用內覆蓋工具,實時分析在測試設備上請求和顯示實際廣告的過程。它告訴您加載廣告所需的時間,並在廣告無法顯示時提供失敗的原因。您還可以指定特定的廣告網絡,以檢查廣告是否正確顯示,如果有問題,您可以在代碼層面進行調試。整個過程與廣告檢查器用戶界面一起進行。它包含在 Google Mobile Ads SDK 版本 20.0.0 及以上,並可以通過調用 AdizDeveloperTool.openAdInspector
使用。
要使用廣告檢查器,必須設置測試設備上的廣告曝光。
Adiz AppID 設定¶
設定在控制台 AppCenter 中註冊的 Adiz AppID。如果未設定,將使用 AndroidManifest.xml 包名稱。
Hive 控制台伺服器設定¶
設定要使用的 Hive 控制台伺服器。預設為 REAL
。即使您使用生產伺服器,啟用測試模式也只會顯示測試廣告。
- Hive 測試控制台伺服器:
ZoneType.TEST
- Hive 沙盒控制台伺服器:
ZoneType.SANDBOX
- Hive 生產控制台伺服器:
ZoneType.REAL
GDPR 同意彈出窗口曝光 (歐洲,英國)¶
如果遊戲的目標是歐洲和英國(EEA 和英國),則必須顯示 GDPR(一般數據保護條例)同意彈出窗口。只有當用戶的設備 IP 地址來自歐洲和英國(EEA 和英國)時,才會顯示 GDPR 同意彈出窗口。Adiz 通過 Google UMP(用戶消息平台)支持顯示 GDPR 同意彈出窗口。在 AdMob 控制台中創建 GDPR 消息後,初始化 Adiz 以向來自歐洲和英國的用戶顯示 GDPR 彈出窗口。
Warning
如果您针对的是欧洲和英国以外的地区,例如,如果您计划仅在国内提供服务,则可以跳过GDPR同意弹出窗口曝光(欧洲,英国)步骤,并使用Adiz.initializeForNonGDPR()
方法进行初始化。
如果您使用Adiz.initialize()
方法进行初始化,则必须在AdMob控制台中写入GDPR消息,以便Adiz初始化正常进行。
撰寫 GDPR 訊息¶
訪問 Google AdMob 控制台以撰寫 GDPR 訊息。在撰寫 GDPR 訊息之前,請參考GDPR 訊息撰寫指南。
如果您已經創建了GDPR消息,GDPR同意彈出窗口將在Adiz初始化時自動出現。
GDPR同意/撤回功能的實現¶
GDPR同意彈出窗口中的項目必須提供修改功能,以便用戶可以隨時更改其同意狀態。例如,用戶最初可能不同意GDPR,但後來希望再次同意以查看個性化廣告;或者,相反,用戶最初可能同意了GDPR,但現在希望撤回其同意,因為他們不再想提供個人信息。為了解決這些情況,應用程序開發人員必須實現一個功能,以便重新同意每個項目或撤回現有同意。要實現GDPR同意/撤回功能,請按照以下步驟操作。
- 在應用程式中實現一個按鈕 UI,可以重新加載 GDPR 同意彈出窗口。
- 在實現Adiz 初始化時,調用
isPrivacyOptionsRequired()
,以便對來自歐洲和英國的用戶顯示按鈕 UI,而對其他用戶不顯示。如果來自歐洲或英國的用戶點擊該按鈕,則調用showPrivacyOptionsForm
來重新加載 GDPR 同意彈出窗口。這樣,用戶可以隨時通過按下應用程式中的“管理選項”按鈕來修改他們的 GDPR 詳細信息的同意。下面的showPrivacyOptionsForm
是一個為示例目的而隨意實現的方法,開發者可以根據需要更改實現。
import com.hive.Adiz
import com.hive.adiz.AdizError
import com.hive.AdizConsentManager
import org.json.JSONObject
fun initialize() {
// ...
Adiz.initialize(activity, object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
if(error.isSuccess) {
// ... omitted
// 确定是否在应用程序中显示按钮以重新打开GDPR同意弹出窗口
var isPrivacyOptionsRequired = AdizConsentManager.isPrivacyOptionsRequired()
if(isPrivacyOptionsRequired) {
// 在应用程序中显示按钮。 (当按钮被点击时,showPrivacyOptionsForm()被调用以显示GDPR同意弹出窗口)
showGDPRConsentPopupButton()
} else {
// 不在应用程序中显示按钮。
// 根据应用程序的需要进行其他处理。
}
}
}
})
}
fun showPrivacyOptionsForm(activity: Activity) {
// GDPR 同意選項表單調用
if(AdizConsentManager.isPrivacyOptionsRequired()) {
AdizConsentManager.showPrivacyOptionsForm(activity, object : AdizConsentManager.ConsentListener {
override fun onResult(error: AdizError) {
addLog("AdizConsentManager.showPrivacyOptionsForm() errorCode : ${error.getCode()}, errorMessage : ${error.getMessage()}}\n")
// 無需進行任何錯誤處理。
}
})
}
}
import com.hive.adiz.Adiz;
import com.hive.adiz.AdizError;
import com.hive.AdizConsentManager;
import org.json.JSONObject;
public void initialize() {
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... 省略
// 確定是否在應用程式中顯示按鈕以重新打開GDPR同意彈出窗口
boolean isPrivacyOptionsRequired = AdizConsentManager.isPrivacyOptionsRequired();
if(isPrivacyOptionsRequired) {
// 在應用程式中顯示按鈕。 (當按鈕被點擊時調用showPrivacyOptionsForm()以顯示GDPR同意彈出窗口)
showGDPRConsentPopupButton();
} else {
// 不在應用程式中顯示按鈕。
// 應用程式所需的其他處理。
}
}
}
});
public void showPrivacyOptionsForm(Activity activity) {
// Call GDPR consent options form
if(AdizConsentManager.isPrivacyOptionsRequired()) {
AdizConsentManager.showPrivacyOptionsForm(activity, new AdizConsentManager.ConsentListener() {
@Override
public void onResult(@NonNull AdizError error) {
// No need to do any error handling.
}
});
}
}
為未滿GDPR同意年齡的用戶設置標籤 (TFUA)¶
您可以使用未滿同意年齡標籤(TFUA)將居住在歐洲經濟區(EEA)、英國和瑞士的用戶視為有限數據處理的主體,當進行廣告請求時。對於針對兒童的應用程序,您可以使用 AdizConsentManager.setUserPrivacySettings
將用戶設置為未滿同意年齡。儘管歐洲各國之間存在一些差異,但GDPR將需要父母同意的年齡定義為16歲以下。未滿同意年齡的設置必須在執行 Adiz.initialize
之前進行配置。
Warning
同時將 setTagForUnderAgeOfConsent
標籤設置為 GDPR 同意年齡和 setTagForChildDirectedTreatment
設置為 COPPA 兒童的設置為 true
,COPPA 兒童設置 setTagForChildDirectedTreatment
將優先,因此請不要將它們都設置為 true
並使用它們。
Note
當使用 Hive SDK v4 24.2.0 或更高版本以及 Adiz 2.0.1 或更高版本時,Hive SDK 的同意年齡設置會自動應用於低於同意年齡的用戶,因此無需調用 AdizConsentManager.setUserPrivacySettings
。
import com.hive.Adiz
import com.hive.adiz.AdizError
import com.hive.adiz.consent.PrivacySettings
import org.json.JSONObject
fun initialize() {
val isUnderAgeForGDPR = false // Change to true if a child
val settings = PrivacySettings.Builder()
.setTagForUnderAgeOfConsent(isUnderAgeForGDPR)
.build()
AdizConsentManager.setUserPrivacySettings(settings)
Adiz.initialize(activity, object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
// ... omitted
}
})
}
import com.hive.Adiz;
import com.hive.adiz.AdizError;
import com.hive.adiz.consent.PrivacySettings;
import org.json.JSONObject;
public void initialize() {
boolean isUnderAgeForGDPR = false; // Change to true if a child
PrivacySettings settings = new PrivacySettings.Builder()
.setTagForUnderAgeOfConsent(isUnderAgeForGDPR)
.build();
AdizConsentManager.setUserPrivacySettings(settings);
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... omitted
}
}
});
}
GDPR 測試設備設置¶
GDPR 同意彈出窗口僅在設備的 IP 地址來自歐洲或英國時顯示。在開發階段,可以強制顯示 GDPR 同意彈出窗口,而不管 IP 地址,這樣可以測試彈出窗口的顯示。要做到這一點,您需要設置一個 GDPR 測試設備。在 Hive 控制台中設置測試設備使測試變得簡單。 使用 setTestDevice
方法設置它的方法如下,這與 在測試設備上顯示廣告 相同。
- 通过初始化来初始化Adiz。这是一个初始化步骤,用于检查测试设备ID,并不需要编写GDPR同意消息。
检查logcat输出,确认设备ID的消息。以下是一个示例消息。
- 检查设备ID的消息(示例:
33BE2250B43518CCDA7DE426D04EE231
)。 - 复制设备ID。
- 在现有的Adiz初始化代码中,在执行
Adiz.initialize
之前添加AdizGDPRManager.setTestDevice(DEVICE_ID)
。 - 编写GDPR同意消息并重新初始化Adiz,以确保GDPR同意弹出窗口正确出现。
import com.hive.Adiz
import com.hive.adiz.AdizError
import org.json.JSONObject
fun initialize() {
Adiz.setTestDevice("33BE2250B43518CCDA7DE426D04EE231")
Adiz.initialize(activity, object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
// ... omitted
}
})
}
import com.hive.Adiz;
import com.hive.adiz.AdizError;
import org.json.JSONObject;
public void initialize() {
Adiz.setTestDevice("33BE2250B43518CCDA7DE426D04EE231");
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... omitted
}
}
});
}
COPPA 兒童定向標籤設置¶
根據《兒童在線隱私保護法》(COPPA),應用開發者可以通過在發送廣告請求時設置兒童定向標籤(tagForChildDirectedTreatment,TFCD)來指定 Google 是否應將內容視為面向兒童的。如果您希望其被視為面向兒童,您必須在執行 Adiz.initialize
之前調用 AdizConsentManager.setUserPrivacySettings
。在將 Adiz 與 Hive SDK 一起使用時,兒童定向標籤會自動應用,因此不需要單獨配置。
import com.hive.Adiz
import com.hive.adiz.AdizError
import com.hive.adiz.consent.PrivacySettings
import org.json.JSONObject
fun initialize() {
val isChildDirectedTreatmentForCOPPA = false // 如果是針對兒童,請改為 true
val settings = PrivacySettings.Builder()
.setTagForChildDirectedTreatment(isChildDirectedTreatmentForCOPPA)
.build()
AdizConsentManager.setUserPrivacySettings(settings)
Adiz.initialize(activity, object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
// ... omitted
}
})
}
import com.hive.Adiz;
import com.hive.adiz.AdizError;
import com.hive.adiz.consent.PrivacySettings;
import org.json.JSONObject;
public void initialize() {
boolean isChildDirectedTreatmentForCOPPA = false; // Change to true if it is for children
PrivacySettings settings = new PrivacySettings.Builder()
.setTagForChildDirectedTreatment(isChildDirectedTreatmentForCOPPA)
.build();
AdizConsentManager.setUserPrivacySettings(settings);
Adiz.initialize(activity, new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
// ... omitted
}
}
});
}
添加廣告調解¶
Adiz 可以使用 AdMob 調解顯示廣告。要添加 AdMob 調解,請按照以下步驟操作。
添加 AdMob 中介¶
我們將在 AdMob 控制台中進行廣告來源的整合。請按照下表進行操作。
AppLovin | Liftoff Monetize | Meta Audience Network | Pangle | Unity Ads | |
---|---|---|---|---|---|
步驟 1 | 設置 AppLovin 配置 | 設置 Pangle 配置 | 設置 Unity Ads 配置 | 設置 Liftoff Monetize | 設置 Meta Audience Network |
步驟 2 | 將 AppLovin 廣告來源添加到 AdMob | 將 Liftoff Monetize 廣告來源添加到 AdMob< | 將 Meta Audience Network 廣告來源添加到 AdMob | 將 Pangle 廣告來源添加到 AdMob | 將 Unity Ads 廣告來源添加到 AdMob |
步驟 3 | 添加 Adiz 適配器 |
添加 Adiz 适配器¶
将库依赖项添加到应用级 build.gradle。
dependencies {
// ... (생략)
implementation 'com.com2us.android.adiz:hive-adiz:2.1.1' // Common (required addition)
implementation 'com.com2us.android.adiz:hive-adiz-adapter-applovin:2.1.1' // Add when integrating AppLovin
implementation 'com.com2us.android.adiz:hive-adiz-adapter-pangle:2.1.1' // Add when integrating Pangle
implementation 'com.com2us.android.adiz:hive-adiz-adapter-unityads:2.1.1' // Add when integrating Unity Ads
implementation 'com.com2us.android.adiz:hive-adiz-adapter-meta:2.1.1' // Add when integrating Meta
}
在整合 Pangle 時,請添加以下設置。如果您使用的是 Gradle 7.0 或更高版本,請在項目級 settings.gradle 的 dependencyResolutionManagement
部分添加 repository
設置。
// When using Gradle 7.0 or higher, configure settings.gradle
dependencyResolutionManagement {
repositories {
maven { url 'https://artifact.bytedance.com/repository/pangle/' } // Add when integrating Pangle
}
}
如果您使用的 Gradle 版本低于 7.0,请在项目级 build.gradle 文件的 allprojects
部分添加 repository
设置。
// Configuration for build.gradle when using Gradle below 7.0
allprojects {
repositories {
maven {
url 'https://artifact.bytedance.com/repository/pangle' // Add when integrating Pangle
}
}
}
要驗證 Adiz 轉接器配置是否已正確應用,請運行應用程序並檢查 廣告檢查器 屏幕上的配置列表。
Adiz 初始化¶
這是一個必須在顯示任何類型的廣告之前執行的步驟。通過初始化 Adiz,您將獲得顯示廣告所需的廣告密鑰。如果您處於測試模式,您將獲得一個測試密鑰。如果您使用的是 Hive SDK,請在調用 AuthV4.setup
之後繼續進行 Adiz 初始化。
val sdkInitializationListener = object : Adiz.SdkInitializationListener {
override fun onComplete(error: AdizError, jsonData: JSONObject?) {
Log.d(TAG, "Adiz initialize complete. error code : ${error.getCode()}, message : ${error.getMessage()}, data : $jsonData")
if(error.isSuccess) {
if(jsonData != null) {
var interstitialKeyList = ArrayList<String>()
var bannerKeyList = ArrayList<String>()
var nativeKeyList = ArrayList<String>()
var rewardedKeyList = ArrayList<String>()
var rewardedInterstitialKeyList = ArrayList<String>()
var appOpenKeyList = ArrayList<String>()
try {
var keysArr = jsonData.getJSONArray("keys")
for (i in 0 until keysArr.length()) {
var unit = keysArr.optJSONObject(i)
// 一個構建鍵列表的示例,其中 is_default 為 false,如果您直接在遊戲中輸入廣告鍵。
if (unit.optBoolean("is_default").not()) {
var hiveAdKey = unit.optString("key")
when (unit.optString("form")) {
"interstitial" -> interstitialKeyList.add(hiveAdKey)
"banner" -> bannerKeyList.add(hiveAdKey)
"native" -> nativeKeyList.add(hiveAdKey)
"rewarded" -> rewardedKeyList.add(hiveAdKey)
"rewarded_interstitial" -> rewardedInterstitialKeyList.add(hiveAdKey)
"app_open" -> appOpenKeyList.add(hiveAdKey)
}
}
}
println("interstitialKeyList $interstitialKeyList")
println("bannerKeyList $bannerKeyList")
println("nativeKeyList $nativeKeyList")
println("rewardedKeyList $rewardedKeyList")
println("rewardedInterstitialKeyList $rewardedInterstitialKeyList")
println("appOpenKeyList $appOpenKeyList")
} catch (e: JSONException) {
//...
}
}
}
}
}
fun initAdiz() {
// 一般初始化
Adiz.initialize(activity, sdkInitializationListener)
}
fun initAdizForNonGDPR() {
// 在未處理GDPR合規性的情況下
Adiz.initializeForNonGDPR(activity, sdkInitializationListener)
}
Adiz.SdkInitializationListener sdkInitializationListener = new Adiz.SdkInitializationListener() {
@Override
public void onComplete(@NonNull AdizError error, @Nullable JSONObject jsonData) {
if(error.isSuccess()) {
if(jsonData != null) {
ArrayList interstitialKeyList = new ArrayList<String>();
ArrayList bannerKeyList = new ArrayList<String>();
ArrayList nativeKeyList = new ArrayList<String>();
ArrayList rewardedKeyList = new ArrayList<String>();
ArrayList rewardedInterstitialKeyList = new ArrayList<String>();
ArrayList appOpenKeyList = new ArrayList<String>();
try {
JSONArray keysArr = jsonData.optJSONArray("keys");
for(int i = 0; i < keysArr.length(); i++) {
JSONObject unit = keysArr.optJSONObject(i);
if(unit.optBoolean("is_default") == false) {
String hiveAdKey = unit.optString("key");
String form = unit.optString("form");
switch (form) {
case "interstitial":
interstitialKeyList.add(hiveAdKey);
break;
case "banner":
bannerKeyList.add(hiveAdKey);
break;
case "native":
nativeKeyList.add(hiveAdKey);
break;
case "rewarded":
rewardedKeyList.add(hiveAdKey);
break;
case "rewarded_interstitial":
rewardedInterstitialKeyList.add(hiveAdKey);
break;
case "app_open":
appOpenKeyList.add(hiveAdKey);
break;
}
}
}
System.out.println("interstitialKeyList " + interstitialKeyList);
System.out.println("bannerKeyList " + bannerKeyList);
System.out.println("nativeKeyList " + nativeKeyList);
System.out.println("rewardedKeyList " + rewardedKeyList);
System.out.println("rewardedInterstitialKeyList " + rewardedInterstitialKeyList);
System.out.println("appOpenKeyList " + appOpenKeyList);
} catch (Exception e) {
}
}
}
}
};
void initAdiz() {
// 一般初始化
Adiz.initialize(activity, sdkInitializationListener);
}
void initAdizForNonGDPR() {
// 如果沒有對GDPR的回應
Adiz.initializeForNonGDPR(activity, sdkInitializationListener);
}
在初始化期間作為回調接收的JSON文件包含一個廣告鍵的列表。廣告鍵的列表具有以下格式。
{
"keys":[
{
"mediation_id":5,
"key":"ca-app-pub-3940256099942544/5354046379",
"form":"rewarded_interstitial",
"is_default":true,
"placement_id":"lobby01"
},
{
"mediation_id":4,
"key":"ca-app-pub-3940256099942544/5224354917",
"form":"rewarded",
"is_default":true,
"placement_id":"game02"
},
{
"mediation_id":3,
"key":"ca-app-pub-3940256099942544/2247696110",
"form":"native",
"is_default":true,
"placement_id":"event01"
},
{
"mediation_id":1,
"key":"ca-app-pub-3940256099942544/1033173712",
"form":"interstitial",
"is_default":true,
"placement_id":"mission01"
},
{
"mediation_id":2,
"key":"ca-app-pub-3940256099942544/6300978111",
"form":"banner",
"is_default":true,
"placement_id":"main01"
},
{
"mediation_id":6,
"key":"ca-app-pub-3940256099942544/9257395921",
"form":"app_open",
"is_default":true,
"placement_id":"appopen01"
}
]
}
在測試模式下初始化時,即使您尚未在 Hive 控制台中註冊 AdMob 廣告鍵,您仍會收到一個測試廣告鍵的列表。在生產模式下初始化時,您將收到在 Hive 控制台中註冊的 AdMob 廣告鍵的列表。
對於每種類型的廣告(form
),一個廣告被用作預設廣告(具有"is_default":true
的廣告)。當任何類型的第一個廣告被註冊時,該廣告成為預設廣告。創建廣告實例(initialize()
)時,預設廣告不需要輸入廣告鍵(hiveAdKey
)。要更改預設廣告,您需要從Hive 控制台刪除現有的預設廣告並註冊一個新的廣告。
設置廣告回調監聽器¶
透過在創建每個廣告實例時實現AdizListener
,您可以根據廣告狀態的變化接收回調。
名稱 | 描述 | 所需實現 |
---|---|---|
onLoad() | 廣告加載成功 | O |
onFail(error: AdizError) | 失敗(失敗的原因可以通過 error.getCode() 和 error.getMessage() 知道) | O |
onShow() | 廣告顯示成功 | O |
onClick() | 廣告點擊 | O |
onPaidEvent(adRevenueData: AdRevenueData) | 在廣告曝光後收到付費事件的時刻,並傳達廣告收入信息 | O |
onClose() | 廣告終止
| X |
onRewarded(rewardItem: RewardItem) | 用戶在獎勵型廣告(rewarded ,rewarded interstitial )曝光後獲得獎勵的時刻 | X |
var adizListener = object : AdizListener() {
override fun onLoad() {
// 當廣告加載時被調用。
// 如果廣告加載成功,您需要在所需的時候調用廣告實例的 .show() 來顯示廣告。
}
override fun onFail(loadError: AdizError) {
// 如果廣告加載失敗或因其他原因顯示廣告失敗,則調用此方法。
}
override fun onShow() {
// Called when the ad is displayed.
}
override fun onClick() {
// Called when the ad is clicked.
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
// 當廣告產生收入時被調用。
var revenue = adRevenueData.revenue // 广告展示时的收入
var currency = adRevenueData.currency // 广告展示时收入的货币代码
}
override fun onClose() {
// Called when the ad is closed.
// Banner, Native ads do not have an onClose callback.
}
override fun onRewarded(rewardItem: RewardItem) {
// 當觀看廣告時,為獎勵創建獎勵。
var itemType = rewardItem.itemType // 獎勵項目類型
var itemAmount = rewardItem.itemAmount // 獎勵項目數量
}
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// Called when the ad is loaded.
// If the ad load is successful, you need to call the ad instance's .show() at the desired point to display the ad.
}
@Override
public void onFail(@NonNull AdizError loadError) {
// 如果廣告加載失敗或因其他原因顯示廣告失敗,則調用此方法。
}
@Override
public void onShow() {
// Called when the ad is displayed.
}
@Override
public void onClick() {
// Called when the ad is clicked.
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // Revenue at the time of ad display
String currency = adRevenueData.getCurrency(); // Currency code for the revenue at the time of ad display
}
@Override
public void onClose() {
// 當廣告關閉時調用。
// 橫幅、原生廣告沒有關閉按鈕,因此沒有 onClose 回調。
}
@Override
public void onRewarded(@NonNull RewardItem rewardItem) {
// Called when a reward occurs for watching the ad in rewarded, rewarded interstitial ads.
String rewardType = rewardItem.getItemType(); // Reward item type
int rewardAmount = rewardItem.getItemAmount(); // Reward item quantity
}
};
錯誤代碼¶
當在 Adiz.Initialize
和 AdizListener
中接收到 onFail()
時,AdizError
錯誤代碼和錯誤信息如下。
常見代碼¶
編號 | 案例 | 解釋 |
---|---|---|
0 | 成功 | 成功 |
Adiz 錯誤代碼¶
編號 | 案例 | 解釋 |
---|---|---|
-1 | InvalidParam | 無效的參數 |
-2 | NotSupported | 不支持 |
-3 | InProgress | 處理中 |
-4 | Network | 網絡錯誤 |
-5 | NeedInitialize | 需要初始化 |
-6 | ResponseFail | 響應失敗 |
-7 | Timeout | 網絡超時 |
-99 | Unknown | 未知錯誤 |
廣告平台錯誤代碼¶
編號 | 案例 | 解釋 |
---|---|---|
-101 | NeedLoad | 廣告未加載 |
-102 | NeedReload | 由於廣告曝光時間到期,需要重新加載 |
-103 | NotEnoughInventory | 調解回應成功,但由於缺乏庫存而未填充廣告 |
-104 | MissingAppId | 調解請求的AppID錯誤 |
-105 | InternalNetworkError | 調解網絡相關錯誤 |
-106 | InvalidUnitId | 無效的單元ID |
-107 | MediationNoFill | 調解適配器無法處理廣告請求 |
-108 | AlreadyLoaded | 已經處於加載狀態 |
-109 | CannotRequestAds | 無法請求廣告 |
-201 | GdprConsentError | GDPR同意錯誤 |
-202 | IsNotPrivacyOptionsRequired | 無法顯示GDPR同意彈出窗口,或處於不需要顯示的狀態 |
廣告顯示與廣告終止¶
要顯示和終止廣告,請遵循以下步驟。
- 為您想要顯示的每種類型的廣告在廣告類別中創建一個廣告實例。如果您想要顯示的廣告不是預設廣告,則必須輸入從初始化中獲得的廣告金鑰或展示 ID。
如果您不輸入廣告金鑰(hiveAdKey
)或展示 ID(placementId
),將創建一個預設廣告實例。展示 ID 可以在 Hive 控制台中設置,更多詳細信息請參閱控制台指南中的Admob 設定頁面。 - 加載您想要顯示的廣告(
load()
)。 - 顯示已加載的廣告(
show()
)。要重新顯示廣告,請再次調用load()
,然後調用show()
。 - 要關閉廣告,請調用
destroy()
。
插播廣告¶
佔據整個螢幕的全螢幕廣告。
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizInterstitial
import com.hive.adiz.common.AdRevenueData
class InterstitialExample : Activity() {
var interstitialAd: AdizInterstitial? = null
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
// requestShowAd()
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // error code
var message = loadError.getMessage() // error message
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // revenue when ad is exposed
var currency = adRevenueData.currency // currency code for revenue when ad is exposed
}
override fun onClose() {
// requestDestroyAd()
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initialize(activity, adizListener)
} else {
// 你可以通过输入 hiveAdKey 创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initialize(activity, hiveAdKey, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementid(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// 创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initialize(activity, adizListener)
} else {
// 你可以通过输入placementId来创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initializeWithPlacementId(activity, placementId, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 加載插頁廣告。
interstitialAd?.let {
if(it.isInitialized()) it.load()
}
}
fun requestShowAd() {
// 顯示插頁式廣告。
interstitialAd?.let {
if(it.isLoaded()) it.show()
}
}
fun requestDestroyAd() {
// 移除插頁廣告。
interstitialAd?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizInterstitial;
import com.hive.adiz.common.AdRevenueData;
public class InterstitialExample extends Activity {
AdizInterstitial interstitialAd = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// requestShowAd();
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤訊息
}
@Override
public void onShow() {
}
@Override
public void onClick() {
//
}
@Override
public void onClose() {
// requestDestroyAd();
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // revenue when ad is exposed
String currency = adRevenueData.getCurrency(); // currency code for revenue when ad is exposed
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 创建插页广告实例。
interstitialAd = AdizInterstitial.initialize(activity, adizListener);
} else {
// 您可以通过输入 hiveAdKey 来创建插页广告实例。
interstitialAd = AdizInterstitial.initialize(activity, hiveAdKey, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initialize(activity, adizListener);
} else {
// 您可以通过输入 placementId 来创建一个插页式广告实例。
interstitialAd = AdizInterstitial.initializeWithPlacementId(activity, placementId, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// 加載插頁廣告。
if(interstitialAd != null && interstitialAd.isInitialized()) interstitialAd.load();
}
private void requestShowAd() {
// Expose the interstitial ad.
if(interstitialAd != null && interstitialAd.isLoaded()) interstitialAd.show();
}
private void requestDestroyAd() {
// 移除插页广告。
if(interstitialAd != null) interstitialAd.destroy();
}
}
橫幅廣告¶
這是一個顯示特定大小橫幅的廣告。橫幅廣告不會接收 onClose()
回調。因此,您需要從其他位置調用 destroy()
來終止廣告。
BannerSize
遵循標準橫幅大小。
尺寸點(寬 x 高) | 描述 | 支持的目標 | BannerSize 常量 |
---|---|---|---|
320x50 | 橫幅 | 手機和平板電腦 | BannerSize.NORMAL |
320x100 | 大橫幅 | 手機和平板電腦 | BannerSize.MEDIUM |
300x250 | IAB 中型矩形 | 手機和平板電腦 | BannerSize.LARGE |
468 x 60 | IAB 全尺寸橫幅 | 平板電腦 | BannerSize.FULL |
PositionType
是最上面或最下面的。默認值是最下面的。
對齊方式 | 描述 | 位置類型常數 |
---|---|---|
頂部對齊 | 指定在螢幕頂部的對齊方式 | PositionType.TOP |
底部對齊(默認) | 指定在螢幕底部的對齊方式 | PositionType.BOTTOM |
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizBanner
import com.hive.adiz.common.AdRevenueData
import com.hive.adiz.common.BannerSize
import com.hive.adiz.common.PositionType
class BannerExample : Activity() {
var banner: AdizBanner? = null
// 設定橫幅大小。
var bannerSize = BannerSize.NORMAL
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
// requestShowAd()
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // 錯誤代碼
var message = loadError.getMessage() // 錯誤訊息
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // revenue when ad is exposed
var currency = adRevenueData.currency // currency code for revenue when ad is exposed
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 創建一個橫幅廣告實例。
banner = AdizBanner.initialize(activity, bannerSize, adizListener)
} else {
// 您可以通過輸入 hiveAdKey 創建一個橫幅廣告實例。
banner = AdizBanner.initialize(activity, hiveAdKey, bannerSize, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementId(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// 創建一個橫幅廣告實例。
banner = AdizBanner.initialize(activity, bannerSize, adizListener)
} else {
// 您可以通過輸入 placementId 創建一個橫幅廣告實例。
banner = AdizBanner.initializeWithPlacementId(activity, placementId, bannerSize, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 載入橫幅廣告。
banner?.let {
if(it.isInitialized()) it.load()
}
}
fun requestShowAd() {
// Expose the banner ad.
banner?.let {
if(it.isLoaded()) it.show()
}
// 設定橫幅位置
/*
var position = PositionType.TOP
banner?.let {
if(it.isLoaded()) it.show(position)
}
*/
}
fun requestDestroyAd() {
// Remove the banner ad.
banner?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizBanner;
import com.hive.adiz.common.AdRevenueData;
import com.hive.adiz.common.BannerSize;
import com.hive.adiz.common.PositionType;
public class BannerExample extends Activity {
// 設定橫幅大小。
BannerSize bannerSize = BannerSize.NORMAL;
AdizBanner banner = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// requestShowAd();
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤訊息
}
@Override
public void onShow() {
}
@Override
public void onClick() {
//
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // revenue when ad is exposed
String currency = adRevenueData.getCurrency(); // currency code for revenue when ad is exposed
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 创建一个横幅广告实例。
banner = AdizBanner.initialize(activity, bannerSize, adizListener);
} else {
// 您可以通过输入hiveAdKey来创建一个横幅广告实例。
banner = AdizBanner.initialize(activity, hiveAdKey, bannerSize, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 創建一個橫幅廣告實例。
banner = AdizBanner.initialize(activity, bannerSize, adizListener);
} else {
// 您可以通過輸入 placementId 創建一個橫幅廣告實例。
banner = AdizBanner.initializeWithPlacementId(activity, placementId, bannerSize, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// Load the banner ad.
if(banner != null && banner.isInitialized()) banner.load();
}
private void requestShowAd() {
// 顯示橫幅廣告。
if(banner != null && banner.isLoaded()) banner.show();
// 設定橫幅位置
// PositionType position = PositionType.TOP;
// if(banner != null) banner.show(position);
}
private void requestDestroyAd() {
// 移除橫幅廣告。
if(banner != null) banner.destroy();
}
}
原生廣告¶
這是一個原生廣告,展示了一個特定大小的原生模板。原生廣告已針對垂直螢幕進行優化,因此建議在垂直遊戲(豎屏遊戲)中使用。原生廣告不會接收 onClose()
回調。因此,您必須從其他位置調用 destroy()
來關閉廣告。
目前的模板支持 small
或 medium
尺寸。
模板 | 對齊 | BannerSize 常數 |
---|---|---|
小尺寸 | 上 / 下 | BannerSize.NORMAL |
中尺寸 | 居中(固定) | BannerSize.MEDIUM |
在small
模板中,PositionType
可以是顶部或底部,默认为底部。
對齊方式 | 描述 | 位置類型常數 |
---|---|---|
頂部對齊 | 指定在螢幕頂部的對齊方式 | PositionType.TOP |
底部對齊(預設) | 指定在螢幕底部的對齊方式 | PositionType.BOTTOM |
medium
模板不允許選擇對齊方式,並默認使用居中對齊。
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizNative
import com.hive.adiz.common.AdRevenueData
import com.hive.adiz.common.BannerSize
class NativeAdExampleKT : Activity() {
var nativeAd: AdizNative? = null
// 設定橫幅大小。
var bannerSize = BannerSize.NORMAL
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
// requestShowAd()
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // 錯誤代碼
var message = loadError.getMessage() // 錯誤信息
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // 广告显示时的收入
var currency = adRevenueData.currency // 广告显示时的收入货币代码
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 创建一个原生广告实例。
nativeAd = AdizNative.initialize(activity, bannerSize, adizListener)
} else {
// 您可以通过输入hiveAdKey来创建一个原生广告实例。
nativeAd = AdizNative.initialize(activity, hiveAdKey, bannerSize, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementId(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// 创建一个原生广告实例。
nativeAd = AdizNative.initialize(activity, bannerSize, adizListener)
} else {
// 您可以通过输入placementId来创建一个原生广告实例。
nativeAd = AdizNative.initializeWithPlacementId(activity, placementId, bannerSize, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 載入原生廣告。
nativeAd?.let {
if(it.isInitialized()) it.load()
}
}
fun requestShowAd() {
// Expose the native ad.
nativeAd?.let {
if(it.isLoaded()) it.show()
}
// 設定橫幅位置
/*
var position = PositionType.TOP
nativeAd?.let {
if(it.isLoaded()) it.show(position)
}
*/
}
fun requestDestroyAd() {
// 移除原生廣告。
nativeAd?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizNative;
import com.hive.adiz.common.AdRevenueData;
import com.hive.adiz.common.BannerSize;
import com.hive.adiz.common.PositionType;
public class NativeAdExample extends Activity {
// 設定橫幅大小。
BannerSize bannerSize = BannerSize.NORMAL;
AdizNative nativeAd = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// requestShowAd();
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤信息
}
@Override
public void onShow() {
}
@Override
public void onClick() {
//
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // 广告显示时的收入
String currency = adRevenueData.getCurrency(); // 广告显示时的收入货币代码
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 基本鍵被設置為is_default=true的狀態下,使用接收到的基本鍵初始化Hive Adiz,將生成實例。(如果未輸入HiveAdKey,將使用基本鍵生成實例。)
nativeAd = AdizNative.initialize(activity, bannerSize, adizListener);
} else {
// 輸入hiveAdKey以生成原生廣告實例。
nativeAd = AdizNative.initialize(activity, hiveAdKey, bannerSize, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 创建一个原生广告实例。(如果没有输入HiveAdKey,则使用默认密钥创建实例,设置为is_default=true,这是在初始化Hive Adiz时接收到的。)
nativeAd = AdizNative.initialize(activity, bannerSize, adizListener);
} else {
// 您可以通过输入placementId来创建一个原生广告实例。
nativeAd = AdizNative.initializeWithPlacementId(activity, placementId, bannerSize, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// Load the native ad.
if(nativeAd != null && nativeAd.isInitialized()) nativeAd.load();
}
private void requestShowAd() {
// 顯示本地廣告。
if(nativeAd != null && nativeAd.isLoaded()) nativeAd.show();
// 設定橫幅位置
// PositionType position = PositionType.TOP;
// if(nativeAd != null && nativeAd.isLoaded()) nativeAd.show(position);
}
private void requestDestroyAd() {
// 移除原生廣告。
if(nativeAd != null) nativeAd.destroy();
}
}
獎勵廣告¶
這是一個獎勵廣告,使用者在觀看廣告一定時間後會獲得獎勵。獎勵一旦發放,獎勵項目的信息將通過 onRewarded()
回調接收。
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizRewarded
import com.hive.adiz.common.AdRevenueData
class RewardedExample : Activity() {
var rewardedAd: AdizRewarded? = null
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
// requestShowAd()
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // 錯誤代碼
var message = loadError.getMessage() // 錯誤信息
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // 广告展示时的收入
var currency = adRevenueData.currency // 广告展示时的收入货币代码
}
override fun onClose() {
// requestDestroyAd()
}
override fun onRewarded(rewardItem: RewardItem) {
var itemType = rewardItem.itemType // 獎勵項目類型
var itemAmount = rewardItem.itemAmount // 獎勵項目數量
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 创建一个奖励广告实例。
rewardedAd = AdizRewarded.initialize(activity, adizListener)
} else {
// 您可以通过输入 hiveAdKey 创建一个奖励广告实例。
rewardedAd = AdizRewarded.initialize(activity, hiveAdKey, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementId(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// 创建一个奖励广告实例。
rewardedAd = AdizRewarded.initialize(activity, adizListener)
} else {
// 你可以通过输入placementId来创建一个奖励广告实例。
rewardedAd = AdizRewarded.initializeWithPlacementId(activity, placementId, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 加載獎勵廣告。
rewardedAd?.let {
if(it.isInitialized()) it.load()
}
}
fun requestShowAd() {
// 顯示獎勵廣告。
rewardedAd?.let {
if(it.isLoaded()) it.show()
}
}
fun requestDestroyAd() {
// 移除奖励广告。
rewardedAd?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizRewarded;
import com.hive.adiz.common.AdRevenueData;
public class RewardedExample extends Activity {
AdizRewarded rewardedAd = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// requestShowAd();
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤訊息
}
@Override
public void onShow() {
//
}
@Override
public void onClick() {
//
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // Revenue when ad is shown
String currency = adRevenueData.getCurrency(); // Currency code for revenue when ad is shown
}
@Override
public void onClose() {
// requestDestroyAd();
}
@Override
public void onRewarded(@NonNull RewardItem rewardItem) {
String rewardType = rewardItem.getItemType(); // 獎勵項目類型
int rewardAmount = rewardItem.getItemAmount(); // 獎勵項目數量
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 創建一個獎勵廣告實例。(如果沒有輸入 HiveAdKey,則使用默認密鑰 (is_default=true) 創建實例,該密鑰是在初始化 Hive Adiz 時接收到的。)
rewardedAd = AdizRewarded.initialize(activity, adizListener);
} else {
// 您可以通過輸入 hiveAdKey 來創建獎勵廣告實例。
rewardedAd = AdizRewarded.initialize(activity, hiveAdKey, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 创建一个奖励广告实例。 (如果没有输入HiveAdKey,则使用在Hive Adiz初始化期间接收到的默认密钥(is_default=true)创建实例。)
rewardedAd = AdizRewarded.initialize(activity, adizListener);
} else {
// 您可以通过输入placementId来创建一个奖励广告实例。
rewardedAd = AdizRewarded.initializeWithPlacementId(activity, placementId, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// Load the rewarded ad.
if(rewardedAd != null && rewardedAd.isInitialized()) rewardedAd.load();
}
private void requestShowAd() {
// 顯示獎勵廣告。
if(rewardedAd != null && rewardedAd.isLoaded()) rewardedAd.show();
}
private void requestDestroyAd() {
// 移除奖励广告。
if(rewardedAd != null) rewardedAd.destroy();
}
}
獎勵插頁廣告¶
這是一個獎勵插頁廣告,用戶在觀看廣告一段時間後會獲得獎勵。一旦獎勵被授予,獎勵項目的信息將通過 onRewarded()
回調接收。
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizRewardedInterstitial
import com.hive.adiz.common.AdRevenueData
import com.hive.adiz.rewarded.RewardItem
class RewardedInterstitialExample : Activity() {
var rewardedInterstitialAd: AdizRewardedInterstitial? = null
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
// requestShowAd()
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // 錯誤代碼
var message = loadError.getMessage() // 錯誤訊息
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // 广告显示时产生的收入
var currency = adRevenueData.currency // 广告显示时收入的货币代码
}
override fun onClose() {
// requestDestroyAd()
}
override fun onRewarded(rewardItem: RewardItem) {
var itemType = rewardItem.itemType // 獎勵項目類型
var itemAmount = rewardItem.itemAmount // 獎勵項目數量
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 创建奖励插页广告的实例。
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, adizListener)
} else {
// 您可以通过输入hiveAdKey来创建奖励插页广告的实例。
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, hiveAdKey, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementId(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// 创建奖励插页广告的实例。
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, adizListener)
} else {
// 您可以通过输入 placementId 来创建奖励插页广告的实例。
rewardedInterstitialAd = AdizRewardedInterstitial.initializeWithPlacementId(activity, placementId, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 加載獎勵插播廣告。
rewardedInterstitialAd?.let {
if(it.isInitialized()) it.load()
}
}
fun requestShowAd() {
// 顯示獎勵插播廣告。
rewardedInterstitialAd?.let {
if(it.isLoaded()) it.show()
}
}
fun requestDestroyAd() {
// Removes the rewarded interstitial ad.
rewardedInterstitialAd?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizRewardedInterstitial;
import com.hive.adiz.common.AdRevenueData;
import com.hive.adiz.rewarded.RewardItem;
public class RewardedInterstitialExample extends Activity {
AdizRewardedInterstitial rewardedInterstitialAd = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
// requestShowAd();
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤訊息
}
@Override
public void onShow() {
//
}
@Override
public void onClick() {
//
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // 顯示廣告時產生的收入
String currency = adRevenueData.getCurrency(); // 顯示廣告時的貨幣代碼
}
@Override
public void onClose() {
// requestDestroyAd();
}
@Override
public void onRewarded(@NonNull RewardItem rewardItem) {
String rewardType = rewardItem.getItemType(); // 獎勵項目類型
int rewardAmount = rewardItem.getItemAmount(); // 獎勵項目數量
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 創建獎勵插頁廣告的實例(如果未輸入廣告鍵(HiveAdKey),則在Hive Adiz初始化期間將使用默認鍵(is_default=true)創建實例。)
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, adizListener);
} else {
// 您可以通過輸入hiveAdKey來創建獎勵插頁廣告的實例。
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, hiveAdKey, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 創建獎勵插頁廣告的實例(如果未輸入廣告密鑰(HiveAdKey),則在Hive Adiz初始化期間將使用默認密鑰(is_default=true)創建實例。)
rewardedInterstitialAd = AdizRewardedInterstitial.initialize(activity, adizListener);
} else {
// 您可以通過輸入placementId來創建獎勵插頁廣告的實例。
rewardedInterstitialAd = AdizRewardedInterstitial.initializeWithPlacementId(activity, placementId, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// 加載獎勵插播廣告。
if(rewardedInterstitialAd != null && rewardedInterstitialAd.isInitialized()) rewardedInterstitialAd.load();
}
private void requestShowAd() {
// 顯示獎勵插播廣告。
if(rewardedInterstitialAd != null && rewardedInterstitialAd.isLoaded()) rewardedInterstitialAd.show();
}
private void requestDestroyAd() {
// Removes the rewarded interstitial ad.
if(rewardedInterstitialAd != null) rewardedInterstitialAd.destroy();
}
}
應用程式開啟廣告 (AppOpen)¶
這是一個應用程式開啟廣告,當應用程式狀態從背景轉換到前景時顯示預加載的 (load()
) 廣告。如果在廣告加載後經過 3 小時後調用 show()
,它將自動重新加載廣告然後顯示它。一旦廣告至少顯示過一次,它將不會自動重新加載。
import android.app.Activity
import android.os.Bundle
import com.hive.adiz.AdizError
import com.hive.adiz.AdizListener
import com.hive.adiz.base.AdizAppOpen
import com.hive.adiz.common.AdRevenueData
class AppOpenExample : Activity() {
var appOpen: AdizAppOpen? = null
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// ...
// requestInitAd(this)
}
val adizListener = object : AdizListener() {
override fun onLoad() {
//
}
override fun onFail(loadError: AdizError) {
var code = loadError.getCode() // 錯誤代碼
var message = loadError.getMessage() // 錯誤訊息
}
override fun onShow() {
//
}
override fun onClick() {
//
}
override fun onPaidEvent(adRevenueData: AdRevenueData) {
var revenue = adRevenueData.revenue // 廣告顯示時的收入
var currency = adRevenueData.currency // 廣告顯示時的收入的貨幣代碼
}
override fun onClose() {
// requestDestroyAd()
}
}
fun requestInitAd(activity: Activity, hiveAdKey: String? = null) {
if(hiveAdKey.isNullOrEmpty()) {
// 創建應用開啟廣告實例。
appOpen = AdizAppOpen.initialize(activity, adizListener)
} else {
// 您可以通過輸入hiveAdKey來創建應用開啟廣告實例。
appOpen = AdizAppOpen.initialize(activity, hiveAdKey, adizListener)
}
// requestLoadAd()
}
fun requestInitAdWithPlacementId(activity: Activity, placementId: String? = null) {
if(placementId.isNullOrEmpty()) {
// Creates an app opening ad instance.
appOpen = AdizAppOpen.initialize(activity, adizListener)
} else {
// You can create an app opening ad instance by entering the placementId.
appOpen = AdizAppOpen.initializeWithPlacementId(activity, placementId, adizListener)
}
// requestLoadAd()
}
fun requestLoadAd() {
// 加載應用開啟廣告。加載完成後,當應用從背景轉到前景時,廣告將自動顯示。
// 一旦廣告至少顯示一次,它將不會再次顯示,因此如果您想繼續顯示廣告,您需要在 onClose() 回調中再次調用 appOpen.load()。
appOpen?.let {
if(it.isInitialized()) it.load()
}
}
fun requestDestroyAd() {
// Removes the app opening ad.
appOpen?.destroy()
}
}
import android.app.Activity;
import android.os.Bundle;
import android.text.TextUtils;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.hive.adiz.AdizError;
import com.hive.adiz.AdizListener;
import com.hive.adiz.base.AdizAppOpen;
import com.hive.adiz.common.AdRevenueData;
public class AppOpenExample extends Activity {
AdizAppOpen appOpen = null;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//...
// requestInitAd(this, null);
}
AdizListener adizListener = new AdizListener() {
@Override
public void onLoad() {
//
}
@Override
public void onFail(@NonNull AdizError loadError) {
int code = loadError.getCode(); // 錯誤代碼
String message = loadError.getMessage(); // 錯誤訊息
}
@Override
public void onShow() {
//
}
@Override
public void onClick() {
//
}
@Override
public void onPaidEvent(@NonNull AdRevenueData adRevenueData) {
double revenue = adRevenueData.getRevenue(); // Revenue when ad is shown
String currency = adRevenueData.getCurrency(); // Currency code for revenue when ad is shown
}
@Override
public void onClose() {
// requestDestroyAd();
}
};
public void requestInitAd(Activity activity, String hiveAdKey) {
if(TextUtils.isEmpty(hiveAdKey)) {
// 創建應用開啟廣告實例。(如果未輸入廣告鍵 (HiveAdKey),則在 Hive Adiz 初始化期間將使用默認鍵 (is_default=true) 創建實例。)
appOpen = AdizAppOpen.initialize(activity, adizListener);
} else {
// 您可以通過輸入 hiveAdKey 創建應用開啟廣告實例。
appOpen = AdizAppOpen.initialize(activity, hiveAdKey, adizListener);
}
// requestLoadAd();
}
public void requestInitAdWithPlacementId(Activity activity, String placementId) {
if(TextUtils.isEmpty(placementId)) {
// 創建一個應用開啟廣告實例。(如果未輸入廣告鍵(HiveAdKey),則在Hive Adiz初始化期間將使用默認鍵(is_default=true)創建實例。)
appOpen = AdizAppOpen.initialize(activity, adizListener);
} else {
// 您可以通過輸入placementId來創建應用開啟廣告實例。
appOpen = AdizAppOpen.initializeWithPlacementId(activity, placementId, adizListener);
}
// requestLoadAd();
}
private void requestLoadAd() {
// 加載應用開啟廣告。
if(appOpen != null && appOpen.isInitialized()) appOpen.load();
}
private void requestDestroyAd() {
// Removes the app opening ad.
if(appOpen != null) appOpen.destroy();
}
}