跳转至

安卓

Adiz Android

Adiz Android是Hive提供的Android广告模块,旨在简化使用AdMob提供的广告曝光功能。Adiz Android提供的广告类型如下:

  • 插页广告
  • 横幅广告
  • 原生广告
  • 激励广告
  • 激励插页广告
  • 应用打开广告

要安装和使用 Adiz Android,请按照下面的指南进行。

安装

将 Adiz 库条目添加到应用级 Gradle 文件 (app/build.gradle).

    dependencies {
        implementation 'com.com2us.android.adiz:hive-adiz:2.1.1'
    }
 

要支持 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控制台注册测试设备后,使用演示广告进行设置(推荐):
    请参考控制台指南的Test Device Management部分。
  • 使用Adiz类的setTestMode()方法:
    参考下面的示例代码
Note

在开发阶段未处于测试模式时,过多的广告点击可能被视为无效流量,您的AdMob账户可能会被举报,从而阻止广告的显示。

使用 Adiz.setTestMode() 方法

import com.hive.adiz.Adiz
import com.hive.adiz.AdizError

import org.json.JSONException
import org.json.JSONObject

// 启用测试模式。将下面的行注释掉以进行商业分发。
Adiz.setTestMode(true)

// 为Hive Adiz模块启用日志记录。日志记录应仅在测试模式下使用。对于商业分发,请注释掉以下行。
Adiz.setLogEnable(true)
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);

测试设备广告曝光

在以下情况下,您需要注册一个测试设备以显示测试广告。

  • 当测试控制台中注册的 AdMob 广告密钥是否正常工作时
  • 当创建 GDPR 消息 并检查 GDPR 同意弹窗是否正常工作时
  • 当运行 广告检查器 以分析和调试广告请求时

    <

在测试设备上显示广告有两种方式。

  • 在 Hive 控制台注册测试设备后,将其设置为 使用广告单元 ID(推荐):
    请参考控制台指南的 测试设备管理 部分。

  • 使用Adiz类的setTestDevice()方法:
    请参阅下面的示例代码

Note

如果您在未注册测试设备的情况下进行显示实际广告的测试,这可能会被视为无效流量,从而导致您的AdMob帐户被封锁,广告将不再显示。当您注册测试设备时,广告展示期间将显示“测试模式”或“测试广告”(原生广告)。在商业分发期间,您必须停用测试设备。


横幅广告、插页广告或奖励广告


原生广告


使用 Adiz.setTestDevice() 方法

要注册测试设备,您首先需要检查测试设备 ID。测试设备 ID(示例: 33BE2250B43518CCDA7DE426D04EE231)可以通过以下两种方式进行检查。

  • 调用 Adiz.Initialize() 后检查 Logcat 日志:

    使用新的
    ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") 将其设置为调试设备。
    
  • 调用 Adiz.Initialize() 之后,无论广告类型如何,调用 initialize()load() 并检查 Logcat 日志:

    I/Ads: 使用 RequestConfiguration.Builder.setTestDeviceIds(Arrays.asList("33BE2250B43518CCDA7DE426D04EE231")) 在此设备上获取测试广告。
    


在检查测试设备 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 使用。


要使用广告检查器,必须设置测试设备上的广告曝光

import com.hive.adiz.utils.AdizDeveloperTool

AdizDeveloperTool.openAdInspector(activity)
import com.hive.adiz.utils.AdizDeveloperTool;

AdizDeveloperTool.openAdInspector(activity);


Adiz AppID 设置

设置在控制台 AppCenter 中注册的 Adiz AppID。如果未设置,将使用 AndroidManifest.xml 包名称。

Adiz.setAppId("YOUR_APPID")
Adiz.setAppId("YOUR_APPID");

Hive 控制台服务器设置

设置要使用的 Hive 控制台服务器。默认值为 REAL。即使您使用生产服务器,启用测试模式也只会显示测试广告。

  • Hive 测试控制台服务器: ZoneType.TEST
  • Hive 沙盒控制台服务器: ZoneType.SANDBOX
  • Hive 生产控制台服务器: ZoneType.REAL
Adiz.setZone(AdizConfiguration.ZoneType.REAL)
Adiz.setZone(AdizConfiguration.ZoneType.REAL);

如果游戏面向欧洲和英国(欧洲经济区和英国),则必须显示GDPR(通用数据保护条例)同意弹窗。只有当用户的设备IP地址来自欧洲和英国(欧洲经济区和英国)时,才会显示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同意/撤回功能,请按照以下步骤操作。

  1. 在应用中实现一个按钮 UI,可以重新加载 GDPR 同意弹窗。
  2. 在实现 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) {
            // 调用GDPR同意选项表单
            if(AdizConsentManager.isPrivacyOptionsRequired()) {
                    AdizConsentManager.showPrivacyOptionsForm(activity, new AdizConsentManager.ConsentListener() {
                            @Override
                            public void onResult(@NonNull AdizError error) {
                                    // 无需进行任何错误处理。
                            }
                    });
            }
    }

为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

        隐私设置 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 测试设备设置

只有当设备的 IP 地址来自欧洲或英国时,GDPR 同意弹窗才会显示。在开发阶段,可以强制显示 GDPR 同意弹窗,而不考虑 IP 地址,从而允许测试弹窗的显示。要做到这一点,您需要设置一个 GDPR 测试设备。在 Hive 控制台中设置测试设备使测试变得简单。 使用 setTestDevice 方法设置它的方法如下,并且与 在测试设备上显示广告 相同。

  1. 通过初始化来初始化Adiz。这是一个初始化步骤,用于检查测试设备ID,不需要编写GDPR同意消息。
  2. 检查logcat输出,确认设备ID的消息。以下是一个示例消息。

    使用新的ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")将其设置为调试设备。
    
  3. 检查设备ID的消息(示例:33BE2250B43518CCDA7DE426D04EE231)。
  4. 复制设备ID。
  5. 在现有的Adiz初始化代码中,在执行Adiz.initialize之前添加AdizGDPRManager.setTestDevice(DEVICE_ID)
  6. 编写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。在与Hive SDK一起使用Adiz时,儿童定向标签会自动应用,因此无需单独配置。

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

        隐私设置 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.gradledependencyResolutionManagement 部分添加 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>();

                尝试 {
                    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() 广告终止
  • 广告终止后,要再次显示相同的广告实例,必须再次调用 load(),然后再调用 show()
  • 要不再显示广告,请调用 destroy() 来移除广告实例。
X
onRewarded(rewardItem: RewardItem) 用户在奖励广告(rewarded, rewarded interstitial)中曝光后获得奖励的时刻 X
var adizListener = object : AdizListener() {
    override fun 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 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(); // 广告展示时的收入
        String currency = adRevenueData.getCurrency(); // 广告展示时的收入货币代码      
    }

    @Override
    public void onClose() {
        // Called when the ad is closed.
        // Banner, Native ads do not have a close button and therefore do not have an onClose callback.
    }

    @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
    }
};

错误代码

在接收到 onFail()Adiz.InitializeAdizListener 时,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同意弹出窗口,或者处于不需要显示的状态

广告展示和广告终止

要展示和终止广告,请遵循以下步骤。

  1. 为您想要显示的每种广告类型在广告类中创建一个广告实例。如果您想要显示的广告不是默认广告,则必须输入从初始化中获得的广告密钥或投放ID。
    如果您不输入广告密钥(hiveAdKey)或投放ID(placementId),将创建一个默认广告实例。投放ID可以在Hive控制台中设置,更多详细信息,请参阅控制台指南中的Admob设置页面。
  2. 加载您想要显示的广告(load())。
  3. 显示加载的广告(show())。要重新显示广告,请再次调用load(),然后调用show()
  4. 要关闭广告,请调用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(); // error code
            String message = loadError.getMessage(); // error message
        }

        @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() {
        // 显示插页广告。
        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() // 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
        }
    }

    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() {
        // 显示横幅广告。
        banner?.let { 
            if(it.isLoaded()) it.show()
        }

        // 设置横幅位置
        /* 
        var position = PositionType.TOP
        banner?.let {
            if(it.isLoaded()) it.show(position)
        } 
        */
    }

    fun requestDestroyAd() {
        // 移除横幅广告。
        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(); // error code
                        String message = loadError.getMessage(); // error message
                }

                @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)) {
                        // 创建一个横幅广告实例。
                        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() {
                // 加载横幅广告。
                if(banner != null && banner.isInitialized()) banner.load();
        }

        private void  requestShowAd() {
                // Expose the banner ad.
                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() 来关闭广告。

 

当前模板支持 smallmedium 尺寸。

模板 对齐方式 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 // Revenue when ad is shown
                        var currency = adRevenueData.currency // Currency code for revenue when ad is shown
                }
        }

        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(); // 广告展示时的收入
                        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,则使用默认密钥(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,则使用默认密钥(is_default=true)创建实例,该密钥在Hive Adiz初始化期间接收。)
                        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() {
                // 移除奖励插页广告。
                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 // Revenue when ad is shown
                        var currency = adRevenueData.currency // Currency code for revenue when ad is shown
                }

                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()) {
                        // 创建一个应用打开广告实例。
                        appOpen = AdizAppOpen.initialize(activity, adizListener)
                } else {
                        // 您可以通过输入placementId来创建一个应用打开广告实例。
                        appOpen = AdizAppOpen.initializeWithPlacementId(activity, placementId, adizListener)
                }

                // requestLoadAd()
        }

        fun requestLoadAd() {
                // 加载应用打开广告。加载完成后,当应用从后台切换到前台时,广告将自动显示。
                // 一旦广告至少显示一次,它将不会重新显示,因此如果您想继续显示广告,您需要在 onClose() 回调中再次调用 appOpen.load()。
                appOpen?.let {
                        if(it.isInitialized()) it.load()
                }
        }

        fun requestDestroyAd() {
                // 移除应用打开广告。
                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(); // 广告展示时的收入
                        String currency = adRevenueData.getCurrency(); // 广告展示时的收入货币代码
                }

                @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();
        }
}