Vungle (SDK v.1.0 - v.4.1) - Marmalade 入门

使用本指南可以将我们的 Vungle Marmalade 插件快速集成到基本的示例应用程序。这里引用的源代码可以在我们的公共 GitHub 存储库中获得。

目录

  1. 开始之前
  2. 安装 Vungle Marmalade 插件
  3. 添加代码!

开始之前……

  1. Vungle Marmalade 插件需要 Marmalade 8.0.0 或更高版本。
  2. Windows N 和 KN 版本上的 Vungle 广告:对于使用 Windows 特别的 N 或 KN 版本的用户而言,必须为 Vungle 广告安装 "Media feature pack for Windows 10 N and KN Editions" 以便工作。
  3. 集成需要 Vungle 帐户,所以如果您目前还没有帐户,请创建 Vungle 帐户
  4. 如果您尚未执行此操作,请前往我们的 仪表板将您的应用添加到帐户中。这样您就能获得应用 ID,您要使用 SDK 将该应用 ID 添加至您的应用中。它位于您的应用页面。
  5. Vungle Marmalade 插件未包含在上述链接的示例代码中,因此请确保您已先从 Vungle 仪表板上下载了该插件。't included in the sample code linked above, so you'll want to make sure you'一旦下载完成...

安装 Vungle Marmalade 插件

将 Vungle Marmalade 插件的链接添加到您项目的 MKB 文件内。若要执行此操作,使用文本编辑器打开您项目的 MKB 文件,并将以下行添加到文件结尾处:

subproject <path_to_the_Vungle_Marmalade_Plugin_directory>/VungleSDK

例如:

subproject ../publisher-marmalade-plugin/VungleSDK

添加代码!

在本演练中,我们将初始化所有 Vungle 相关代码。我们建议您尽快初始化 Vungle Marmalade 插件,以确保包含的 Vungle SDK 已及时完成配置,可以在调用 'playAd' 时向用户呈现广告。

初始化

初始化只是一行。它仅需要被调用一次,并且用于使 Vungle Marmalade 插件做好准备以向用户呈现广告。请尝试尽早在您的应用程序中初始化 Vungle SDK,因为 SDK 需要 30-45 秒的时间来初始和缓存广告以供播放:

#include "VungleSDK.h"
//...
int main()
{
    //您的应用 ID 可在应用页面上的 Vungle 仪表板中找到
    VungleInit("Test_Android", "Test_iOS", "Test_Windows");
}

播放广告

播放广告是另一行程序。

//简单扼要!
VunglePlayAd();

VunglePlayAdWithOptions 方法可以接受一个选项来自定义广告播放体验:

//播放有着更多选项的广告。请使用结构 VungleSDKPlayOption 来设置选项。
VungleSDKPlayOption* opts = new VungleSDKPlayOption();
VunglePlayAdWithOptions(opts); 

选项结构包含以下字段:

密匙 说明
奖励 您可以选择每当用户完成广告时即获得通知。这方面的一个典型的使用情况是当您提供某种价值交换(“观看此视频,并获得 100 个宝石!”)的时候。如果您选择奖励推广您的广告,我们会立刻将消息及(您提供的)用户 ID 一起发送到您的服务器,这样您就可以奖励您的用户。“YES”意味着将奖励推广此广告。请参阅我们的设置奖励推广广告的说明
orientation

设置广告的方向。

  • 0 - 自动旋转(Windows、iOS、android)
  • 1 - 横向(Windows、iOS),匹配视频 (android)
  • 2 - 纵向(Windows、iOS)
userTag 关键用户是 S2S 调用中作为用户通过的用户(如有)。
placement 提示单个广告播放的广告展示位置详细信息的元数据。 这用于在为您的应用程序的性能检索报表数据时,筛选不同的广告体验。
alertTitle 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框标题的字符串。
alertText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框正文文本的字符串。
alertCloseText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框关闭按钮文本的字符串标题。
alertContinueText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框关闭按钮文本的字符串标题。
key1..8 我们在此构建了八个密匙。
 

事件处理

Vungle Marmalade 插件允许应用订阅广告介绍周围的 5 个事件:

  • VUNGLESDK_CALLBACK_ADPLAYABLECHANGED - Vungle 广告已准备好显示时触发
  • VUNGLESDK_CALLBACK_ADSTART - Vungle 广告开始时触发
  • VUNGLESDK_CALLBACK_ADEND - 当用户离开广告,控制返回至您的应用程序/游戏时调用
  • VUNGLESDK_CALLBACK_VIDEOVIEW - 每次广告完成时触发
  • VUNGLESDK_CALLBACK_LOG - SDK 发送日志事件时触发

回调函数有两个 void* 类型的参数。第一个参数链接到其他事件信息。

回调 类型 描述
ADPLAYABLECHANGED bool 如果值为 true,您现在可以播放广告。
ADSTART  
ADEND bool 如果用户点击“下载”按钮转至商店则为 True
视频视图 VungleSDKAdViewInfo*

struct VungleSDKAdViewInfo
{
bool IsCompletedView; // 如果至少观看了 80% 的视频内容为 True
int VideoDuration; // Vungle 广告的总持续时间(毫秒)
int WatchedDuration; // 观看 Vungle 广告的持续时间(毫秒)
};

LOG 常量字符* 日志消息

订阅这些事件非常简单。添加事件监听器会看起来像这样:

int32 OnAdPlayableChanged(void* systemData, void* userData) {
    bool adPlayble = (bool)systemData;
    if (adPlayble){
        //广告可以显示!
    }else{
        //现在没有可以播放的广告。
    }
    return 0;
}
 
int main()
{
    VungleSDKRegister(VUNGLESDK_CALLBACK_ADPLAYABLECHANGED, (s3eCallback)OnAdPlayableChanged, (void*)NULL);
}

注意: 当您的应用程序处于测试模式时,您将无法下载任何通告的应用程序。此外,Dashboard 不会报告展示次数。这是因为测试广告仅用于验证您是否已正确集成 SDK。一旦您的应用程序在活动模式下可用,即可使用此功能。

就这么简单!有关 Vungle Marmalade 插件的更多信息,请查看我们其他的插件文章,或仔细查看我们的 Marmalade 示例应用的源代码。

还有其它问题?提交请求

评论