跳转至

iOS 版

Adiz iOS

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

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

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

准备

设置Adiz iOS 开发环境

安装

GADApplicationIdentifier 键添加到您的 Xcode 项目的 Info.plist 文件中,并将 AdMobId 值(格式为 ca-app-pub-XXXXX~YYYYY)作为该键的值输入。

    <key>GADApplicationIdentifier</key>
    <string>ca-app-pub-XXXXX~YYYYY</string>

 

此外,对于 iOS 14 及更高版本,请参考更新您的 info.plist指南,将 SKAdNetwork 列表添加到Info.plist文件中。

 

接下来,将以下内容添加到项目的 CocoaPods 配置(Podfile)中。

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/Com2uSPlatformCorp/HiveAdiz-iOS.git'
platform :ios, '12.0'

target 'UnityFramework' do
  pod 'HiveAdiz', '2.1.1'
end
target 'Unity-iPhone' do
end
use_frameworks!

# fix for dyld issue in pods when using Project
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      # xcode 15 Toolchain Issue
      xcconfig_path = config.base_configuration_reference.real_path
      xcconfig = File.read(xcconfig_path)
      xcconfig_mod = xcconfig.gsub(/DT_TOOLCHAIN_DIR/, "TOOLCHAIN_DIR")
      File.open(xcconfig_path, "w") { |file| file << xcconfig_mod }
      # end

      config.build_settings["BUILD_LIBRARY_FOR_DISTRIBUTION"] = "YES"
      if config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'].to_f < 12.0
        config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '12.0'
      end
    end
  end
end

 

使用 $pod install 应用 CocoaPod 设置。

测试广告设置

Adiz 可以以两种方式显示测试广告。

  1. 激活测试模式:仅显示由 AdMob 发布的测试广告
  2. 注册测试设备后显示广告:显示真实广告进行测试,确保不发生无效流量,并通过注册将显示测试广告的设备来继续

测试模式激活

在开发阶段,激活测试模式,以便点击测试广告不会向广告主收费。当测试模式激活时,只会显示测试广告。在测试模式下,即使不在控制台中输入 AdMob 广告密钥,也会显示测试广告。商业发行期间将停用测试模式。

有两种方法可以激活测试模式。

  • 在Hive控制台注册测试设备后,将其设置为演示广告(推荐):
    请参考控制台指南中的Test Device Management部分。
  • 使用Adiz类的setTestMode()方法:
    参考下面的示例代码
Note

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

使用 Adiz.setTestMode() 方法

import HiveAdiz

// 激活测试模式。将下面的行注释掉以进行生产部署。
Adiz.setTestMode(true)

// 激活 Adiz 模块日志记录。日志记录仅应在测试模式下使用。对于生产部署,请注释掉下面的行。
Adiz.setLogEnable(true)
#import <HiveAdiz/HiveAdiz-Swift.h> 

// 激活测试模式。将下面的行注释掉以进行生产部署。
[Adiz setTestMode: true];

// 激活 Adiz 模块日志记录。日志记录仅应在测试模式下使用。生产部署时请注释掉以下行。
[Adiz setLogEnable: true];

测试设备广告曝光

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

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



<

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

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

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

Note

如果您进行测试而没有注册测试设备,实际广告可能会被视为无效流量,这可能导致您的 AdMob 账户被封锁,并可能阻止进一步的广告曝光。通过注册测试设备,在广告曝光期间将显示“测试模式”或“测试广告”(原生广告)。在商业分发期间,您必须停用测试设备。

 

横幅、全屏广告或奖励广告

 

原生广告

 

使用 Adiz.setTestDevice() 方法

要注册测试设备,您首先需要检查测试设备 ID。测试设备 ID(示例:B74F6468-1516-467C-99AD-CC5973C5DB52)可以通过以下两种方式进行验证。

  1. 在调用 Adiz.Initialize() 后检查 Logcat 日志:
    要为此设备启用调试模式,请设置: UMPDebugSettings.testDeviceIdentifiers = @[B74F6468-1516-467C-99AD-CC5973C5DB52]
    
  2. 在调用 Adiz.Initialize() 之后,无论广告类型如何,都要调用 initialize()load() 并检查 Logcat 日志:
    GADMobileAds.sharedInstance().requestConfiguration.testDeviceIdentifiers = [ "B74F6468-1516-467C-99AD-CC5973C5DB52" ]
    

 

在检查测试设备ID后,在现有的Hive Adiz初始化代码中执行Adiz.initialize之前添加行Adiz.SetTestDevice(DEVICE_ID)。将复制的测试设备ID输入到DEVICE_ID中。

 

func setTestDevice(testId: String) {
        Adiz.setTestDevice(testId)
}
- (void)setTestDevice: (NSString *)testId {
        [Adiz setTestDevice: testId];
}


广告检查器使用

广告检查器是一个应用内覆盖工具,实时分析在测试设备上请求和显示实际广告的过程。它会告知您加载广告所需的时间,并提供显示广告失败的原因。您还可以指定特定的广告网络,以检查广告是否正确显示,如果存在问题,您可以在代码级别进行调试。所有这些都与广告检查器用户界面一起完成。它包含在 Google Mobile Ads SDK 版本 7.68.0 及以上版本中,可以通过调用 AdizDeveloperTool.OpenAdInspector 使用。

 

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

func openAdInspector(viewController: UIViewController) {
        AdizDeveloperTool.openAdInspector(viewController)
}
- (void)openAdInspector: (UIViewController *)viewController {
        [AdizDeveloperTool openAdInspector: viewController];
}

Adiz AppID 设置

设置您在 Hive 控制台 AppCenter 中注册的 Adiz AppID。如果未设置,将使用 Bundle ID。

Adiz.setAppId(appId)
[Adiz setAppId: appId];

Hive 控制台服务器配置

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

  • Hive 测试控制台服务器: AdizZoneType.test
  • Hive 沙盒控制台服务器: AdizZoneType.sandbox
  • Hive 生产控制台服务器: AdizZoneType.real
Adiz.setZone(AdizZoneType.real)
[Adiz setZone: AdizZoneTypeReal];

用户特定广告曝光

随着在 iOS 14.5+ 中引入的 ATT(应用追踪透明度),隐私保护得到了加强。因此,只有在用户同意在 ATT 同意弹窗中进行活动追踪的情况下,才能显示用户特定的广告。为了通过显示用户特定的广告来最大化广告收入,您需要创建一个 IDFA(广告标识符)消息。

AdMob 请按照仪表板上方的IDFA消息编写指南来编写和发布您的消息。

在编写并发布IDFA消息后,设置用户跟踪访问权限。按照以下步骤将密钥添加到Info.plist

  1. 在 Xcode 项目窗口的项目导航器中选择您的项目。
  2. 在 TARGETS 列表中选择您的应用。
  3. 点击 Info 选项卡。
  4. 在 Info 选项卡中点击 Custom iOS Target Properties 项。
  5. 在 Custom iOS Target Properties 列表中右键单击。
  6. 点击 Add Row 菜单。
  7. 在 Key 字段中输入 NSUserTrackingUsageDescription,并在 Value 字段中添加 多语言设置文件 > Base.Iproj 文件夹 > InfoPlist.strings 中指定的值。

 

接下来,写一条消息,请求来自多语言配置文件中指定的应用用户的权限批准(常规设置 > 访问权限请求设置)。如果您不输入权限批准请求弹出消息,将缺少关于用户访问权限使用的额外说明指南,并且应用将在审核过程中被拒绝。

 

如果您已完成到此步骤,ATT 同意弹出窗口将在 Adiz 初始化 期间自动显示。当用户在 ATT 同意弹出窗口上点击“允许”时,IDFA 将被激活,并显示个性化广告。

如果您的游戏面向欧洲和英国(欧洲经济区和英国),您必须显示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消息,当Adiz初始化时,GDPR同意弹出窗口将自动出现。

Warning

如果您使用的是 Hive SDK,则必须在完成 Hive Adiz 初始化后运行 AuthV4.setup。如果在显示 ATT(应用追踪透明度)同意通知后出现 GDPR 同意屏幕,您的应用可能会在 Apple 应用审核期间被拒绝。

实现GDPR同意/撤回功能

GDPR同意弹窗中的项目必须提供修改功能,以便用户可以随时更改他们的同意状态。例如,用户最初可能不同意GDPR,但后来希望再次同意以查看个性化广告;或者相反,用户最初可能同意了GDPR,但现在希望撤回他们的同意,因为他们不再想提供个人信息。为了应对这些情况,应用程序开发者必须实现重新同意每个项目或撤回现有同意的功能。要实现GDPR同意/撤回功能,请按照以下步骤操作。

  1. 在应用中实现一个按钮UI,可以重新打开GDPR同意弹窗。
  2. 在实现Adiz初始化时,调用isPrivacyOptionsRequired()来向来自欧洲和英国的用户显示按钮UI,其他情况下则不显示。如果来自欧洲或英国的用户点击该按钮,调用showPrivacyOptionsForm重新打开GDPR同意弹窗。这允许用户随时通过按下应用中的“管理选项”按钮来修改他们的GDPR同意详情。下面的showPrivacyOptionsForm是一个为说明而任意实现的方法,开发者可以根据需要更改实现。
import HiveAdiz

func initialize(_ appId: String) {
        // ...
        // isPrivacyOptionsRequired is default false
        targetViewController.showPrivacyFormButton.isEnabled = AdizConsentManager.isPrivacyOptionsRequired() 

        // HiveAdiz 初始化
        Adiz.initialize(targetViewController) { error, json in
                // ...
                // showPrivacyOptionsForm 按钮启用检查
                targetViewController.showPrivacyFormButton.isEnabled = AdizConsentManager.isPrivacyOptionsRequired()
                // ...
        }
} 

func showPrivacyOptionsForm(_ targetViewController: UIViewController) {
        // 显示GDPR表单
        if AdizConsentManager.isPrivacyOptionsRequired() {
        AdizConsentManager.showPrivacyOptionsForm(targetViewController) { error in
                        // 无需进行任何错误处理。
                }
        }
}
        #import <HiveAdiz/HiveAdiz-Swift.h>

        - (void)initialize: (NSString *)appId {
                // ...
                // isPrivacyOptionsRequired is default false
                targetViewController.showPrivacyFormButton.enabled = [AdizGDPRManager isPrivacyOptionsRequired];

                // HiveAdiz 初始化   
                [Adiz initialize: targetViewController handler:^(AdizError * error, NSDictionary<NSString *,id> * json) {
                        // ...
                        // showPrivacyOptionsForm 按钮启用检查
                        targetViewController.showPrivacyFormButton.enabled = [AdizConsentManager isPrivacyOptionsRequired];
                        // ...
                }];
        }

        - (void)showPrivacyOptionsForm: (UIViewController*) targetViewController {
                // 显示GDPR表单
                if ([AdizConsentManager isPrivacyOptionsRequired]) {
                        [AdizConsentManager showPrivacyOptionsForm: targetViewController handler:^(AdizError *error) {
                                // 无需进行任何错误处理。
                        }];
                }
        }

为GDPR同意年龄以下的用户设置标签 (TFUA)

您可以在进行广告请求时为未满同意年龄的用户设置标签(未满同意年龄标签,TFUA),以将居住在欧洲经济区(EEA)、英国和瑞士的用户视为受限数据处理的对象。对于面向儿童的应用,您可以使用 AdizConsentManager.SetUserPrivacySettings 来设置用户未满同意年龄。尽管欧洲各国之间存在一些差异,但GDPR将16岁以下定义为需要父母同意的年龄。未成年同意设置必须在执行 Adiz.initialize 之前进行配置。

Warning

为符合GDPR同意年龄设置setTagForUnderAgeOfConsent标签,同时将setTagForChildDirectedTreatment设置为COPPA儿童的true,COPPA儿童设置setTagForChildDirectedTreatment将优先,因此不要同时将它们都设置为true并同时使用。

Note

当使用 Hive SDK v4 24.2.0 或更高版本与 Adiz 2.0.1 或更高版本一起时,在 Hive SDK 中设置的用户同意年龄会自动应用,因此无需调用 AdizConsentManager.SetUserPrivacySettings

 

func initialize(_ appId: String) {
    bool isTagForUnderAgeOfConsent = false // Change to true if underage


    let privacySet = PrivacySettings.Builder()
        .setTagForUnderAgeOfConsent(isTagForUnderAgeOfConsent)

    AdizConsentManager.setUserPrivacySettings(privacySet.build())

    // HiveAdiz 初始化
    Adiz.initialize(targetViewController) { error, json in
        // ...
    }
}
- (void)initialize: (NSString *)appId {
    bool isTagForUnderAgeOfConsent = false; // Change to true if underage


    PrivacySettingsBuilder* privacySet = [[PrivacySettingsBuilder alloc] init];
    privacySet = [builder setTagForUnderAgeOfConsent: isTagForUnderAgeOfConsent];

    [AdizConsentManager setUserPrivacySettings: [privacySet build]];

    // HiveAdiz 初始化
    [Adiz initialize: targetViewController handler:^(AdizError * error, NSDictionary<NSString *,id> * json) {
        // ...
    }];
}

GDPR 测试设备设置

只有当设备的 IP 地址来自欧洲或英国时,才会显示 GDPR 同意弹窗。在开发阶段,可以强制显示 GDPR 同意弹窗,而不考虑 IP 地址,以测试弹窗的显示。要做到这一点,您需要设置一个 GDPR 测试设备。请按照以下步骤设置 GDPR 测试设备。

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

    要为此设备启用调试模式,请设置:UMPDebugSettings.testDeviceIdentifiers = @[B74F6468-1516-467C-99AD-CC5973C5DB52]

    检查消息中的设备ID(示例:B74F6468-1516-467C-99AD-CC5973C5DB52)。

  3. 复制设备ID。
  4. 在现有的Adiz初始化代码中,执行Adiz.initialize之前添加Adiz.setTestDevice(DEVICE_ID)
  5. 编写GDPR同意消息并重新初始化Adiz,以确保GDPR同意弹出窗口正确出现。
func initialize(_ appId: String) {
    // ...
    // 在 Adiz.initialize 之前设置 TestDevice。示例 @"B74F6468-1516-467C-99AD-CC5973C5DB52"
    Adiz.setTestDevice("B74F6468-1516-467C-99AD-CC5973C5DB52")

    // HiveAdiz 初始化
    Adiz.initialize(targetViewController) { error, json in
            // ...
    }
}
- (void)initialize: (NSString *)appId {
    // ...
    // 在 Adiz.initialize 之前设置 TestDevice。示例 @"B74F6468-1516-467C-99AD-CC5973C5DB52"
    [Adiz setTestDevice: @"B74F6468-1516-467C-99AD-CC5973C5DB52"];

    // HiveAdiz 初始化
    [Adiz initialize: targetViewController handler:^(AdizError * error, NSDictionary<NSString *,id> * json) {
            // ...
    }];
}

COPPA儿童导向处理标签设置

根据儿童在线隐私保护法案(COPPA),应用程序开发者可以通过在广告请求时设置儿童导向处理标签(tagForChildDirectedTreatment, TFCD)来指定Google是否应将内容视为儿童导向。如果您希望它被视为儿童导向,您必须在执行Adiz.initialize之前调用AdizConsentManager.SetUserPrivacySettings。在使用Adiz与Hive SDK时,儿童导向处理标签会自动应用,因此无需单独配置。

func initialize(_ appId: String) {
        bool isTagForChildDirectedTreatment = false // Change to true if it is for children

        let privacySet = PrivacySettings.Builder()
                .setTagForChildDirectedTreatment(isTagForUnderAgeOfConsent)

        AdizConsentManager.setUserPrivacySettings(privacySet.build())

        // HiveAdiz 初始化
        Adiz.initialize(targetViewController) { error, json in
                // ...
        }
}
- (void)initialize: (NSString *)appId {
        bool isTagForChildDirectedTreatment = false; // 如果是针对儿童,请更改为 true 

        PrivacySettingsBuilder* privacySet = [[PrivacySettingsBuilder alloc] init];
        privacySet = [builder setTagForChildDirectedTreatment: isTagForChildDirectedTreatment];

        [AdizConsentManager setUserPrivacySettings: [privacySet build]];

        // HiveAdiz 初始化
        [Adiz initialize: targetViewController handler:^(AdizError * error, NSDictionary<NSString *,id> * json) {
                // ...
        }];
}

添加广告调解

Adiz 可以使用 AdMob 调解显示广告。要添加 AdMob 调解,请按照以下步骤操作。

添加 AdMob 调解

我们将继续在 AdMob 控制台中集成广告源。请按照下表进行操作。

AppLovin Pangle Unity Ads Meta
步骤 1 设置 AppLovin 配置 设置 Pangle 配置 设置 Unity Ads 配置 设置 Meta 配置
步骤 2 将 AppLovin 广告源添加到 AdMob 将 Pangle 广告源添加到 AdMob 将 Unity Ads 广告源添加到 AdMob 将 Meta 广告源添加到 AdMob
步骤 3 添加 Adiz 适配器

添加 Adiz 适配器

将依赖项添加到 CocoaPods Podfile。


# ...

$HIVE_ADIZ_VERSION = '2.1.1'

def adiz
  pod 'HiveAdiz', $HIVE_ADIZ_VERSION
end

def adizAdapter
  pod 'HiveAdizAdapterAppLovin', $HIVE_ADIZ_VERSION
  pod 'HiveAdizAdapterPangle', $HIVE_ADIZ_VERSION
  pod 'HiveAdizAdapterUnityAds', $HIVE_ADIZ_VERSION
end

target 'MyGame-mobile' do
  adiz
  adizAdapter
end

# ...

 

要检查Adiz适配器配置是否已正确应用,请运行应用程序并检查广告检查器屏幕上的配置列表。

Adiz 初始化

这是在显示所有类型广告之前必须执行的强制步骤。通过初始化 Adiz,您将收到显示广告所需的广告密钥。如果您处于测试模式,您将收到测试密钥。如果您使用的是 Hive SDK,请在调用 AuthV4.setup 后进行 Adiz 初始化。

Warning

如果您正在使用 GDPR 设置,则必须在完成 Hive Adiz 初始化后运行 AuthV4.setup。如果在显示 ATT(应用追踪透明度)同意通知后出现 GDPR 同意屏幕,则应用可能会在苹果的应用审核中被拒绝。

import HiveAdiz

// Hive Adiz 初始化中
Adiz.initialize(targetViewController) { error, json in
        if error.isSuccess,
                let responseList = json?["keys"] as? [[String:Any]] {

                var interstitialKeyList = [String]()
                var bannerKeyList = [String]()
                var nativeKeyList = [String]()
                var rewardedKeyList = [String]()
                var rewardedInterstitialKeyList = [String]()
                var appOpenKeyList = [String]()

                for response in responseList {
                        if let isDefault = response["is_default"] as? Bool,
                                isDefault == false {
                                let hiveAdKey = response["key"] as? String ?? ""
                                let hiveForm = response["form"] as? String ?? ""

                                switch hiveForm {
                                case "interstitial": interstitialKeyList.append(hiveAdKey)
                                case "banner": bannerKeyList.append(hiveAdKey)
                                case "native": nativeKeyList.append(hiveAdKey)
                                case "rewarded": rewardedKeyList.append(hiveAdKey)
                                case "rewarded_interstitial": rewardedInterstitialKeyList.append(hiveAdKey)
                                case "app_open": appOpenKeyList.append(hiveAdKey)
                                default: break
                                }
                        }
                }

                print("interstitialKeyList \(interstitialKeyList)");
                print("bannerKeyList \(bannerKeyList)");
                print("nativeKeyList \(nativeKeyList)");
                print("rewardedKeyList \(rewardedKeyList)");
                print("rewardedInterstitialKeyList \(rewardedInterstitialKeyList)");
                print("appOpenKeyList \(appOpenKeyList)");
        }
}
#import <HiveAdiz/HiveAdiz-Swift.h> 

// 初始化 Hive Adiz
[Adiz initialize: targetViewController handler:^(AdizError * error, NSDictionary<NSString *,id> * json) {
        if([error isSuccess] && json[@"keys"] != nil) {
                NSArray* responseList = json[@"keys"];

                NSMutableArray<NSString*> *interstitialKeyList = [[NSMutableArray alloc] init];
                NSMutableArray<NSString*> *bannerKeyList = [[NSMutableArray alloc] init];
                NSMutableArray<NSString*> *nativeKeyList = [[NSMutableArray alloc] init];
                NSMutableArray<NSString*> *rewardedKeyList = [[NSMutableArray alloc] init];
                NSMutableArray<NSString*> *rewardedInterstitialKeyList = [[NSMutableArray alloc] init];
                NSMutableArray<NSString*> *appOpenKeyList = [[NSMutableArray alloc] init];

                for (NSDictionary* response in responseList) {
                        // 这是一个设置广告键列表的示例(is_default = false),当你想直接放置广告键时。
                        if (response[@"is_default"] != nil && [response[@"is_default"] boolValue] == false) {
                                NSString* hiveAdKey = response[@"key"];
                                NSString* hiveForm = response[@"form"];
                                if ([hiveForm isEqualToString: @"interstitial"]) {
                                        [interstitialKeyList addObject: hiveAdKey];
                                } else if ([hiveForm isEqualToString: @"banner"]) {
                                        [bannerKeyList addObject: hiveAdKey];
                                } else if ([hiveForm isEqualToString: @"native"]) {
                                        [nativeKeyList addObject: hiveAdKey];
                                } else if ([hiveForm isEqualToString: @"rewarded"]) {
                                        [rewardedKeyList addObject: hiveAdKey];
                                } else if ([hiveForm isEqualToString: @"rewarded_interstitial"]) {
                                        [rewardedInterstitialKeyList addObject: hiveAdKey];
                                } else if ([hiveForm isEqualToString: @"app_open"]) {
                                        [appOpenKeyList addObject: hiveAdKey];
                                }
                        }
                }

                NSLog(@"interstitialKeyList %@", interstitialKeyList);
                NSLog(@"bannerKeyList %@", bannerKeyList);
                NSLog(@"nativeKeyList %@", nativeKeyList);
                NSLog(@"rewardedKeyList %@", rewardedKeyList);
                NSLog(@"rewardedInterstitialKeyList %@", rewardedInterstitialKeyList);
                NSLog(@"appOpenKeyList %@", appOpenKeyList);
        }
}];

 

初始化时接收到的回调 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"
            }
        ]
    }

 

在测试模式下初始化时,即使您没有在控制台中注册AdMob广告密钥,您也会收到一份测试广告密钥列表。在生产模式下初始化时,您将收到在控制台中注册的AdMob广告密钥列表。

对于每种类型的广告(form),使用一个广告作为默认广告(即具有"is_default":true的广告)。当注册任何类型的第一个广告时,该广告将成为默认广告。创建广告实例(initialize())时,不需要输入广告密钥(hiveAdKey)来使用默认广告。要更改默认广告,必须从控制台删除现有的默认广告并注册一个新的广告。

设置广告回调监听器

通过在创建每个广告实例时实现AdizListener,您可以根据广告状态的变化接收回调。

名称 描述 必需的实现
onLoad() 广告加载成功 O
onFail(error: AdizError) 失败(失败的原因可以通过 error.getCode()error.getMessage() 知道) O
onShow() 广告展示成功 O
onClick() 广告点击 O
onPaidEvent(_ revenueData: AdRevenueData) 在广告曝光后,付费事件发生时接收到的,传达广告收入信息的地方 O
onClose() 广告结束
  • 要在广告结束后重新显示相同的广告实例,您必须再次调用 load(),然后调用 show()
  • 要停止显示广告,请调用 destroy() 以移除广告实例。
X
onRewarded(_ rewardItem: RewardItem) 用户在基于奖励的广告(rewardedrewarded interstitial)曝光后获得奖励的时刻 X
import HiveAdiz

class TestAdizListener: AdizListener {
        func onLoad() {
                // 当广告加载完成时调用。
                // 如果广告加载成功,您需要在合适的时机调用广告实例的 .show() 来显示广告。
                print("[\(delegateTypeName)] onLoad")
        }
        func onFail(_ error: AdizError) {
                // 如果广告加载失败或由于其他原因广告显示失败时调用。
                print("[\(delegateTypeName)] onFail: ")
                print("(\(error.getCode())) \(error.getMessage() ?? "")")
        }
        func onShow() {
                // 当广告显示时调用。
                print("[\(delegateTypeName)] onShow")
        }
        func onClick() {
                // 当广告被点击时调用。
                print("[\(delegateTypeName)] onClick")
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
                // 当广告产生收入时调用。
                print("[\(delegateTypeName)] onPaidEvent: \(revenueData.getCurrency()) \(revenueData.getRevenue().description)")
                var revenue = revenueData.getRevenue() // 广告曝光时的收入
                var currency = revenueData.getCurrency() // 广告曝光时的收入货币代码
        }
        func onClose() {
                // 当广告关闭时调用。
                // 横幅广告、原生广告没有 onClose 回调。
                print("[\(delegateTypeName)] onClose")
        }
        func onRewarded(_ rewardItem: RewardItem) {
                // 当观看广告获得奖励时调用,适用于奖励广告和奖励插播广告。
                print("[\(delegateTypeName)] onRewarded")
                print("amount: \(rewardItem.getItemAmount()) type: \(rewardItem.getItemType())")

                var itemType = rewardItem.getItemType() // 奖励物品类型
                var itemAmount = rewardItem.getItemAmount() // 奖励物品数量    }}
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface TestAdizListener : NSObject<AdizListener>
@end

@implementation TestAdizListener

- (void) onLoad {
        // 当广告加载时调用。
        // 如果广告加载成功,您需要在合适的时机调用广告实例的 .show() 来显示广告。
        NSLog(@"[TestAdizListener] onLoad");
}

- (void) onFail:(AdizError *)error {
        // 如果广告加载失败或由于其他原因广告显示失败,则调用此方法。
        NSLog(@"[TestAdizListener] onFail: ");
        NSLog(@"errorCode: %ld, errorMessage: %@", (long)[error getCode], [error getMessage]);
}

- (void) onShow {
        // Called when the ad is displayed.
        NSLog(@"[TestAdizListener] onShow");
}

- (void) onClick {
        // 当广告被点击时调用。
        NSLog(@"[TestAdizListener] onClick");
}

- (void) onPaidEvent:(AdRevenueData *)revenueData {
        // 当广告产生收入时调用。
        NSLog(@"[TestAdizListener] onPaidEvent: %@ %f", [revenueData getCurrency], [revenueData getRevenue]);
        double revenue = [revenueData getRevenue]; // 广告曝光时的收入
        NSString* currency = [revenueData getCurrency]; // 广告曝光时的收入货币代码
}

- (void) onClose {
        // 当广告关闭时调用。
        // 横幅广告、原生广告没有 onClose 回调。
        NSLog(@"[TestAdizListener] onClose");
}

- (void) onRewarded:(RewardItem *)rewardItem {
        // 当观看广告时发生奖励时调用,奖励插页广告。
        NSLog(@"[TestAdizListener] onRewarded");
        NSLog(@"amount: %ld type: %@", (long)[rewardItem getItemAmount], [rewardItem getItemType]);

        NSString* itemType = [rewardItem getItemType]; // 奖励项目类型
        NSInteger itemAmount = [rewardItem getItemAmount]; // 奖励项目数量
}

@end

错误代码

当从 Adiz.InitializeAdizListener 接收到 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同意弹窗,或处于不需要显示的状态

广告曝光和广告终止

要曝光和终止广告,请按照以下步骤操作。

  1. 为您想要显示的每种广告类型在广告类中创建一个广告实例。如果您想要显示的广告不是默认广告,则必须输入从初始化中获得的广告密钥或投放 ID。如果您不输入广告密钥(hiveAdKey)或投放 ID(placementId),则会创建一个默认广告实例。投放 ID 可以在 Hive 控制台中设置,更多详细信息,请参考控制台指南中的Admob 设置页面。
  2. 加载您想要显示的广告(load())。
  3. 显示已加载的广告(show())。要再次显示广告,您必须再次调用load(),然后调用show()
  4. 要关闭广告,请调用destroy()

插页广告

这是一个全屏插页广告。

import UIKit
import HiveAdiz

class InitViewController: UIViewController {

        // 创建一个插页广告实例。
        var interstitialAd: AdizInterstitial?

        func requestInitAd(hiveAdKey: String?) {
                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizInterstitial 实例 (ViewController, hiveAdKey, AdizListener)
                        self.interstitialAd = AdizInterstitial.initialize(self, hiveAdKey: adKey, adizListener: self)
                }
                else {
                        // 初始化默认的 AdizInterstitial 实例 (ViewController, AdizListener)
                        self.interstitialAd = AdizInterstitial.initialize(self, adizListener: self)
                }
        }

        func requestInitAdWithPlacementId(placementId: String?) {
                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizInterstitial 实例 (ViewController, placementId, AdizListener)
                        self.interstitialAd = AdizInterstitial.initializeWithPlacementId(self, placementId: placementId, adizListener: self)
                }
                else {
                        // 初始化默认 AdizInterstitial 实例 (ViewController, AdizListener)
                        self.interstitialAd = AdizInterstitial.initialize(self, adizListener: self)
                }
        }

        func requestLoadAd() {
                // Load AdizInterstitial
                if let ad = self.interstitialAd,
                    ad.isInitialized() {
                        ad.load()
                        }
        }

        func requestShowAd() {
                // 显示 AdizInterstitial
                if let ad = self.interstitialAd,
                    ad.isLoaded() {
                        ad.show()
                        }
        }

        func requestDestroyAd() {
                // 销毁 AdizInterstitial
                self.interstitialAd?.destroy()
                self.interstitialAd = nil
        }
}

extension InitViewController: AdizListener {
        func onLoad() {
                // requestShowAd()
        }
        func onFail(_ error: AdizError) {
        }
        func onShow() {
        }
        func onClick() {
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
        }
        func onClose() {
                // requestDestroyAd()
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface InitViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizInterstitial* interstitialAd;
@end

@implementation InitViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizInterstitial 实例 (ViewController, hiveAdKey, AdizListener)
                // 创建一个插页广告实例。
                self.interstitialAd = [AdizInterstitial initialize:self hiveAdKey:hiveAdKey adizListener:self];
        }
        else {
                // 初始化默认 AdizInterstitial 实例 (ViewController, AdizListener)
                self.interstitialAd = [AdizInterstitial initialize:self adizListener:self];
        }
}

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizInterstitial 实例 (ViewController, placementId, AdizListener)
                // 创建一个插页广告实例。
                self.interstitialAd = [AdizInterstitial initializeWithPlacementId:self placementId:placementId adizListener:self];
        }
        else {
                // 初始化默认的 AdizInterstitial 实例 (ViewController, AdizListener)
                self.interstitialAd = [AdizInterstitial initialize:self adizListener:self];
        }
}

- (void) requestLoadAd {
        // 加载 AdizInterstitial
        if (self.interstitialAd != nil && [self.interstitialAd isInitialized]) {
                [self.interstitialAd load];
        }
}

- (void) requestShowAd {
        // 显示 AdizInterstitial
        if (self.interstitialAd != nil && [self.interstitialAd isLoaded]) {
                [self.interstitialAd show];
        }
}

- (void) requestDestroyAd {
        // 销毁 AdizInterstitial
        if (self.interstitialAd != nil) {
                [self.interstitialAd destroy];
                self.interstitialAd = nil;
        }
}

#pragma mark - AdizListener

- (void) onLoad {
        // [self requestShowAd];
}

- (void) onFail:(AdizError *)error {
}

- (void) onShow {
}

- (void) onClick {
}

- (void) onPaidEvent:(AdRevenueData *)revenueData {
}

- (void) onClose {
        // [self requestDestroyAd];
}

@end

横幅广告

这是一个展示特定大小横幅的广告。横幅广告不会接收 onClose() 回调。因此,您需要从其他位置调用 destroy() 来终止广告。

 

BannerSize 遵循标准横幅尺寸。

尺寸点(宽 x 高) 描述 支持的设备 BannerSize 常量
320x50 横幅 手机和平板 BannerSize.normal
320x100 大横幅 手机和平板 BannerSize.medium
300x250 IAB 中矩形 手机和平板 BannerSize.large
468 x 60 IAB 全尺寸横幅 平板 BannerSize.full

 

PositionType 是最上面或最下面的。默认值是最下面的。

对齐方式 描述 PositionType 常量
顶部对齐 根据 SafeArea 指定屏幕顶部的对齐方式 PositionType.top
底部对齐(默认) 根据 SafeArea 指定屏幕底部的对齐方式 PositionType.bottom
import UIKit
import HiveAdiz

class BannerViewController: UIViewController {

        // 创建 AdizBanner 实例
        // 创建一个横幅广告实例。
        var bannerAd: AdizBanner?

        func requestInitAd(hiveAdKey: String?) {        // 设置横幅大小
                var bannerSize: BannerSize = .normal

                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizBanner 实例 (ViewController, hiveAdKey, BannerSize, AdizListener)
                        self.bannerAd = AdizBanner.initialize(self, hiveAdKey: adKey, size: bannerSize, adizListener: self)
                }
                else {
                        // 初始化默认 AdizBanner 实例 (ViewController, BannerSize, AdizListener)
                        self.bannerAd = AdizBanner.initialize(self, size: bannerSize, adizListener: self)
                }    
        }    

        func requestInitAdWithPlacementId(placementId: String?) {        // 设置横幅大小
                var bannerSize: BannerSize = .normal

                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizBanner 实例 (ViewController, placementId, BannerSize, AdizListener)
                        self.bannerAd = AdizBanner.initializeWithPlacementId(self, placementId: placementId, size: bannerSize, adizListener: self)
                }
                else {
                        // 初始化默认 AdizBanner 实例 (ViewController, BannerSize, AdizListener)
                        self.bannerAd = AdizBanner.initialize(self, size: bannerSize, adizListener: self)
                }    
        }    

        func requestLoadAd() {
                // Load AdizBanner
                if let ad = self.bannerAd,
                    ad.isInitialized() {
                        ad.load()
                        }
        }     

        func requestShowAd() {
                // 设置位置类型
                var position: PositionType = .top

                // 显示 AdizBanner
                if let ad = self.bannerAd,
                    ad.isLoaded() {
                        ad.show(position)
                        }
        }     

        func requestDestroyAd() {
                // 销毁 AdizBanner
                self.bannerAd?.destroy()
                self.bannerAd = nil
        }
} 

extension BannerViewController: AdizListener {
        func onLoad() {
                // requestShowAd()
        }    
        func onFail(_ error: AdizError) {
        }    
        func onShow() {
        }    
        func onClick() {
        }    
        func onPaidEvent(_ revenueData: AdRevenueData) {    
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface BannerViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizBanner* bannerAd;
@end

@implementation BannerViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        // 设置横幅大小
        BannerSize bannerSize = BannerSizeNormal;

        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizBanner 实例 (ViewController, hiveAdKey, BannerSize, AdizListener)
                self.bannerAd = [AdizBanner initialize:self hiveAdKey:hiveAdKey size: bannerSize adizListener:self];
        }    else {
                // 初始化默认 AdizBanner 实例 (ViewController, BannerSize, AdizListener)
                self.bannerAd = [AdizBanner initialize:self size:bannerSize adizListener:self];
        }
} 

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        // 设置横幅大小
        BannerSize bannerSize = BannerSizeNormal;

        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizBanner 实例 (ViewController, placementId, BannerSize, AdizListener)
                self.bannerAd = [AdizBanner initializeWithPlacementId:self placementId:placementId size: bannerSize adizListener:self];
        }    else {
                // 初始化默认 AdizBanner 实例 (ViewController, BannerSize, AdizListener)
                self.bannerAd = [AdizBanner initialize:self size:bannerSize adizListener:self];
        }
} 

- (void) requestLoadAd {
        // 加载 AdizBanner
        if (self.bannerAd != nil && [self.bannerAd isInitialized]) {
                [self.bannerAd load];
        }
} 

- (void) requestShowAd {
        // 设置位置类型
        PositionType position = PositionTypeTop;

        // 显示 AdizBanner
        if (self.bannerAd != nil && [self.bannerAd isLoaded]) {
                [self.bannerAd show: position];
        }
} 

- (void) requestDestroyAd {
        // 销毁 AdizBanner
        if (self.bannerAd != nil) {
                [self.bannerAd destroy];
                self.bannerAd = nil;
        }
} 

#pragma mark - AdizListener

- (void) onLoad {
        // [self requestShowAd];
} 

- (void) onFail:(AdizError *)error {
} 

- (void) onShow {
} 

- (void) onClick {
} 

- (void) onPaidEvent:(AdRevenueData *)revenueData {
} 

@end

原生广告

这是一个原生广告,展示了特定大小的原生模板。原生广告针对垂直屏幕进行了优化,因此建议在垂直游戏(竖屏游戏)中使用它们。原生广告不会接收 onClose() 回调。因此,您需要从其他位置调用 destroy() 来关闭广告。

 

当前模板支持 smallmedium 尺寸。

尺寸点(宽 x 高) 模板 对齐方式 BannerSize 常量
355x91(调整了纵横比) 小尺寸 顶部 / 底部 BannerSize.normal
355x370(调整了纵横比) 中尺寸 居中(固定) BannerSize.medium, BannerSize.large, BannerSize.full

 

small 模板中,PositionType 可以是顶部或底部,默认是底部。

对齐方式 描述 位置类型常量
顶部对齐 指定屏幕顶部的对齐方式 PositionType.top
底部对齐(默认) 指定屏幕底部的对齐方式 PositionType.bottom

 

medium 模板不允许选择对齐方式,默认使用居中对齐。

import UIKit
import HiveAdiz

class NativeViewController: UIViewController {

        // 创建 AdizNative 实例
        var nativeAd: AdizNative?

        func requestInitAd(hiveAdKey: String?) {
                // 设置横幅大小
                var bannerSize: BannerSize = .normal

                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizNative 实例 (ViewController, hiveAdKey, BannerSize, AdizListener)
                        self.nativeAd = AdizNative.initialize(self, hiveAdKey: adKey, size: bannerSize, adizListener: self)
                }
                else {
                        // 初始化默认 AdizNative 实例 (ViewController, BannerSize, AdizListener)
                        self.nativeAd = AdizNative.initialize(self, size: bannerSize, adizListener: self)
                }
        }

        func requestInitAdWithPlacementId(placementId: String?) {
                // 设置横幅大小
                var bannerSize: BannerSize = .normal

                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizNative 实例 (ViewController, placementId, BannerSize, AdizListener)
                        self.nativeAd = AdizNative.initializeWithPlacementId(self, placementId: placementId, size: bannerSize, adizListener: self)
                }
                else {
                        // 初始化默认的 AdizNative 实例 (ViewController, BannerSize, AdizListener)
                        self.nativeAd = AdizNative.initialize(self, size: bannerSize, adizListener: self)
                }
        }

        func requestLoadAd() {
                // Load AdizNative
                if let ad = self.nativeAd,
                    ad.isInitialized() {
                        ad.load()
                }
        }

        func requestShowAd() {
                // 设置位置类型
                var position: PositionType = .top

                // 显示 AdizNative
                if let ad = self.nativeAd,
                    ad.isLoaded() {
                        ad.show(position)
                }
        }

        func requestDestroyAd() {
                // 销毁 AdizNative
                self.nativeAd?.destroy()
                self.nativeAd = nil
        }
}

extension NativeViewController: AdizListener {
        func onLoad() {
                // requestShowAd()
        }
        func onFail(_ error: AdizError) {
        }
        func onShow() {
        }
        func onClick() {
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface NativeViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizNative* nativeAd;
@end

@implementation NativeViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        // 设置横幅大小
        BannerSize bannerSize = BannerSizeNormal;

        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizNative 实例 (ViewController, hiveAdKey, BannerSize, AdizListener)
                self.nativeAd = [AdizNative initialize:self hiveAdKey:hiveAdKey size: bannerSize adizListener:self];
        }
        else {
                // 初始化默认 AdizNative 实例 (ViewController, BannerSize, AdizListener)
                self.nativeAd = [AdizNative initialize:self size:bannerSize adizListener:self];
        }
}

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        // 设置横幅大小
        BannerSize bannerSize = BannerSizeNormal;

        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizNative 实例 (ViewController, placementId, BannerSize, AdizListener)
                self.nativeAd = [AdizNative initializeWithPlacementId:self placementId:placementId size: bannerSize adizListener:self];
        }
        else {
                // 初始化默认 AdizNative 实例 (ViewController, BannerSize, AdizListener)
                self.nativeAd = [AdizNative initialize:self size:bannerSize adizListener:self];
        }
}

- (void) requestLoadAd {
        // 加载 AdizNative
        if (self.nativeAd != nil && [self.nativeAd isInitialized]) {
                [self.nativeAd load];
        }
}

- (void) requestShowAd {
        // 设置位置类型
        PositionType position = PositionTypeTop;

        // 显示 AdizNative
        if (self.nativeAd != nil && [self.nativeAd isLoaded]) {
                [self.nativeAd show: position];
        }
}

- (void) requestDestroyAd {
        // 销毁 AdizNative
        if (self.nativeAd != nil) {
                [self.nativeAd destroy];
                self.nativeAd = nil;
        }
}

#pragma mark - AdizListener

- (void) onLoad {
        // [self requestShowAd];
}

- (void) onFail:(AdizError *)error {
}

- (void) onShow {
}

- (void) onClick {
}

- (void) onPaidEvent:(AdRevenueData *)revenueData {
}

@end

奖励广告

这是一个奖励广告,用户在观看广告一定时间后会获得奖励。一旦奖励被授予,奖励项目信息将通过onRewarded()回调接收。

import UIKit
import HiveAdiz  

class RewardViewController: UIViewController {

        // 创建 AdizRewarded 实例
        var rewardAd: AdizRewarded?

        func requestInitAd(hiveAdKey: String?) {
                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizRewarded 实例 (ViewController, hiveAdKey, AdizListener)
                        self.rewardAd = AdizRewarded.initialize(self, hiveAdKey: adKey, adizListener: self)
                }
                else {
                        // 初始化默认 AdizRewarded 实例 (ViewController, AdizListener)
                        self.rewardAd = AdizRewarded.initialize(self, adizListener: self)
                }
        }

        func requestInitAdWithPlacementId(placementId: String?) {
                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizRewarded 实例 (ViewController, placementId, AdizListener)
                        self.rewardAd = AdizRewarded.initializeWithPlacementId(self, placementId: placementId, adizListener: self)
                }
                else {
                        // 初始化默认 AdizRewarded 实例 (ViewController, AdizListener)
                        self.rewardAd = AdizRewarded.initialize(self, adizListener: self)
                }
        }

        func requestLoadAd() {
                // 加载 AdizRewarded
                if let ad = self.rewardAd,
                    ad.isInitialized() {
                        ad.load()
                }
        }

        func requestShowAd() {
                // 显示 AdizRewarded
                if let ad = self.rewardAd,
                    ad.isLoaded() {
                        ad.show()
                }
        }

        func requestDestroyAd() {
                // 销毁 AdizRewarded
                self.rewardAd?.destroy()
                self.rewardAd = nil
        }
}

extension RewardViewController: AdizListener {
        func onLoad() {
                // requestShowAd()
        }
        func onFail(_ error: AdizError) {
        }
        func onShow() {
        }
        func onClick() {
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
        }
        func onClose() {
                // requestDestroyAd()
        }
        func onRewarded(_ rewardItem: RewardItem) {
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h> 

@interface RewardedViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizRewarded* rewardedAd;
@end

@implementation RewardedViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizRewarded 实例 (ViewController, hiveAdKey, AdizListener)
                self.rewardedAd = [AdizRewarded initialize:self hiveAdKey:hiveAdKey adizListener:self];
        }
        else {
                // 初始化默认 AdizRewarded 实例 (ViewController, AdizListener)
                self.rewardedAd = [AdizRewarded initialize:self adizListener:self];
        }
}

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizRewarded 实例 (ViewController, placementId, AdizListener)
                self.rewardedAd = [AdizRewarded initializeWithPlacementId:self placementId:placementId adizListener:self];
        }
        else {
                // 初始化默认 AdizRewarded 实例 (ViewController, AdizListener)
                self.rewardedAd = [AdizRewarded initialize:self adizListener:self];
        }
}

- (void) requestLoadAd {
        // 加载 AdizRewarded
        if (self.rewardedAd != nil && [self.rewardedAd isInitialized]) {
                [self.rewardedAd load];
        }
}

- (void) requestShowAd {
        // 显示 AdizRewarded
        if (self.rewardedAd != nil && [self.rewardedAd isLoaded]) {
                [self.rewardedAd show];
        }
}

- (void) requestDestroyAd {
        // 销毁 AdizRewarded
        if (self.rewardedAd != nil) {
                [self.rewardedAd destroy];
                self.rewardedAd = nil;
        }
}

#pragma mark - AdizListener

- (void) onLoad {
        // [self requestShowAd];
}

- (void) onFail:(AdizError *)error {
}

- (void) onShow {
} 

- (void) onClick {
} 

- (void) onPaidEvent:(AdRevenueData *)revenueData {
}

- (void) onClose {
        // [self requestDestroyAd];
}

- (void) onRewarded:(RewardItem *)rewardItem {
}

@end

奖励插页广告

这是一个奖励插页广告,用户在观看广告一定时间后会获得奖励。一旦奖励被授予,奖励项目信息将通过onRewarded()回调接收。

import UIKit
import HiveAdiz  

class RewardInterstitialViewController: UIViewController {

        // 创建 AdizRewardedInterstitial 实例
        var rewardInterstitialAd: AdizRewardedInterstitial?

        func requestInitAd(hiveAdKey: String?) {
                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizRewardedInterstitial 实例 (ViewController, hiveAdKey, AdizListener)
                        self.rewardInterstitialAd = AdizRewardedInterstitial.initialize(self, hiveAdKey: adKey, adizListener: self)
                }
                else {
                        // 初始化默认 AdizRewardedInterstitial 实例 (ViewController, AdizListener)
                        self.rewardInterstitialAd = AdizRewardedInterstitial.initialize(self, adizListener: self)
                }    
        }   

        func requestInitAdWithPlacementId(placementId: String?) {
                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizRewardedInterstitial 实例 (ViewController, placementId, AdizListener)
                        self.rewardInterstitialAd = AdizRewardedInterstitial.initializeWithPlacementId(self, placementId: placementId, adizListener: self)
                }
                else {
                        // 初始化默认的 AdizRewardedInterstitial 实例 (ViewController, AdizListener)
                        self.rewardInterstitialAd = AdizRewardedInterstitial.initialize(self, adizListener: self)
                }    
        }   

        func requestLoadAd() {
                // Load AdizRewardedInterstitial
                if let ad = self.rewardInterstitialAd,
                    ad.isInitialized() {
                        ad.load()
                }
        }     

        func requestShowAd() {
                // 显示 AdizRewardedInterstitial
                if let ad = self.rewardInterstitialAd,
                    ad.isLoaded() {
                        ad.show()
                }
        }     

        func requestDestroyAd() {
                // 销毁 AdizRewardedInterstitial
                self.rewardInterstitialAd?.destroy()
                self.rewardInterstitialAd = nil
        }
}

扩展 RewardInterstitialViewController: AdizListener {
        func onLoad() {
                // requestShowAd()
        }    
        func onFail(_ error: AdizError) {
        }    
        func onShow() {
        }    
        func onClick() {
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
        }
        func onClose() {
                // requestDestroyAd()
        }
        func onRewarded(_ rewardItem: RewardItem) {
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface RewardedInterstitialViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizRewardedInterstitial* rewardedInterstitialAd;
@end

@implementation RewardedInterstitialViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizRewardedInterstitial 实例 (ViewController, hiveAdKey, AdizListener)
                self.rewardedInterstitialAd = [AdizRewardedInterstitial initialize:self hiveAdKey:hiveAdKey adizListener:self];
        }
        else {
                // 初始化默认 AdizRewardedInterstitial 实例 (ViewController, AdizListener)
                self.rewardedInterstitialAd = [AdizRewardedInterstitial initialize:self adizListener:self];
        }
} 

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizRewardedInterstitial 实例 (ViewController, placementId, AdizListener)
                self.rewardedInterstitialAd = [AdizRewardedInterstitial initializeWithPlacementId:self placementId:placementId adizListener:self];
        }
        else {
                // 初始化默认的 AdizRewardedInterstitial 实例 (ViewController, AdizListener)
                self.rewardedInterstitialAd = [AdizRewardedInterstitial initialize:self adizListener:self];
        }
} 

- (void) requestLoadAd {
        // 加载 AdizRewardedInterstitial
        if (self.rewardedInterstitialAd != nil && [self.rewardedInterstitialAd isInitialized]) {
                [self.rewardedInterstitialAd load];
        }
}

- (void) requestShowAd {
        // 显示 AdizRewardedInterstitial
        if (self.rewardedInterstitialAd != nil && [self.rewardedInterstitialAd isLoaded]) {
                [self.rewardedInterstitialAd show];
        }
} 

- (void) requestDestroyAd {
        // 销毁 AdizRewardedInterstitial
        if (self.rewardedInterstitialAd != nil) {
                [self.rewardedInterstitialAd destroy];
                self.rewardedInterstitialAd = nil;
        }
}

#pragma mark - AdizListener

- (void) onLoad {
        // [self requestShowAd];
} 
- (void) onFail:(AdizError *)error {
} 
- (void) onShow {
} 
- (void) onClick {
} 
- (void) onPaidEvent:(AdRevenueData *)revenueData {
}

- (void) onClose {
        // [self requestDestroyAd];
}

- (void) onRewarded:(RewardItem *)rewardItem {
}

@end

应用打开广告 (AppOpen)

这是一个应用打开广告,当应用状态从后台切换到前台时,会显示一个预加载的 (load()) 广告。如果在广告加载后经过 3 小时调用 show(),广告将自动重新加载并显示。一旦广告至少显示过一次,它将不会自动重新加载。

import UIKit
import HiveAdiz  

class AppOpenViewController: UIViewController {

        // 创建 AdizAppOpen 实例
        var appOpenAd: AdizAppOpen?

        func requestInitAd(hiveAdKey: String?) {
                if let adKey = hiveAdKey,
                        adKey.count > 0 {
                        // 初始化 AdizAppOpen 实例 (ViewController, hiveAdKey, AdizListener)
                        self.appOpenAd = AdizAppOpen.initialize(self, hiveAdKey: adKey, adizListener: self)
                }
                else {
                        // 初始化默认 AdizAppOpen 实例 (ViewController, AdizListener)
                        self.appOpenAd = AdizAppOpen.initialize(self, adizListener: self)
                }    
        }     

        func requestInitAdWithPlacementId(placementId: String?) {
                if let placementId = placementId,
                        placementId.count > 0 {
                        // 初始化 AdizAppOpen 实例 (ViewController, placementId, AdizListener)
                        self.appOpenAd = AdizAppOpen.initializeWithPlacementId(self, placementId: placementId, adizListener: self)
                }
                else {
                        // 初始化默认 AdizAppOpen 实例 (ViewController, AdizListener)
                        self.appOpenAd = AdizAppOpen.initialize(self, adizListener: self)
                }    
        }   

        func requestLoadAd() {
                // Load AdizAppOpen
                if let ad = self.appOpenAd,
                    ad.isInitialized() {
                        ad.load()
                }
        }     

        func requestShowAd() {
                print("[appOpenAd] appOpenAd don't request Show")
        }     

        func requestDestroyAd() {
                // 销毁 AdizAppOpen
                self.appOpenAd?.destroy()
                self.appOpenAd = nil
        }
}

extension AppOpenViewController: AdizListener {
        func onLoad() {
        }    
        func onFail(_ error: AdizError) {
        }    
        func onShow() {
        }    
        func onClick() {
        }
        func onPaidEvent(_ revenueData: AdRevenueData) {
        }
        func onClose() {
                // requestDestroyAd()
        }
}
#import <UIKit/UIKit.h>
#import <HiveAdiz/HiveAdiz-Swift.h>

@interface AppOpenViewController : UIViewController<AdizListener>
@property (nonatomic, strong) AdizAppOpen* appOpenAd;
@end

@implementation AppOpenViewController

- (void) requestInitAd: (NSString*)hiveAdKey {
        if (hiveAdKey != nil && ![hiveAdKey isEqualToString:@""]) {
                // 初始化 AdizAppOpen 实例 (ViewController, hiveAdKey, AdizListener)
                self.appOpenAd = [AdizAppOpen initialize:self hiveAdKey:hiveAdKey adizListener:self];
        }
        else {
                // 初始化默认 AdizAppOpen 实例 (ViewController, AdizListener)
                self.appOpenAd = [AdizAppOpen initialize:self adizListener:self];
        }
} 

- (void) requestInitAdWithPlacementId: (NSString*)placementId {
        if (placementId != nil && ![placementId isEqualToString:@""]) {
                // 初始化 AdizAppOpen 实例 (ViewController, placementId, AdizListener)
                self.appOpenAd = [AdizAppOpen initializeWithPlacementId:self placementId:placementId adizListener:self];
        }
        else {
                // 初始化默认 AdizAppOpen 实例 (ViewController, AdizListener)
                self.appOpenAd = [AdizAppOpen initialize:self adizListener:self];
        }
} 

- (void) requestLoadAd {
        // 加载 AdizAppOpen
        if (self.appOpenAd != nil && [self.appOpenAd isInitialized]) {
                [self.appOpenAd load];
        }
} 

- (void) requestShowAd {
        NSLog(@"[appOpenAd] appOpenAd don't request Show");
}

- (void) requestDestroyAd {
        // 销毁 AdizAppOpen
        if (self.appOpenAd != nil) {
                [self.appOpenAd destroy];
                self.appOpenAd = nil;
        }
} 

#pragma mark - AdizListener

- (void) onLoad {
} 

- (void) onFail:(AdizError *)error {
} 

- (void) onShow {
} 

- (void) onClick {
} 

- (void) onPaidEvent:(AdRevenueData *)revenueData {
}

- (void) onClose {
        // [self requestDestroyAd];
}

@end