Vungle (SDK v.1.0 - v.4.1) - Unity 入门指南

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

目录

  1. 开始之前
  2. 安装 Vungle Unity 插件
  3. 添加代码!
  4. 运行 Vungle 示例应用程序
  5. 如何在 Windows 上导出 Xcode 项目

开始之前……

    1. Vungle Unity 插件需要 Android Java 1.7 并支持 iOS 7+。
    2. Vungle Unity 插件:
      - iOS SDK,支持 Unity 4 和 Unity 5.3.2 或更高版本(iOS SDK 4.0.6 或更高版本需要 Unity 5.4.1 或更高版本)。
      - Android SDK,支持 Unity 4 和 Unity 5.3.2 或更高版本。
      - Windows SDK(Universal 8.1 或 Phone 8.1),支持 Unity 4 和 Unity 5.3.2 或更高版本。
      - Windows SDK(Windows 10 UWP),支持 Unity 5.3.2 或更高版本。

    3. 对于 Windows 系统,先安装 Windows SDK,然后按照以下说明安装 Vungle Unity 插件。Windows 开发只能在 Windows PC 上进行。请务必根据所用的开发系统版本安装相应版本的 Windows SDK:

      - 下载 Windows SDK 8.1 - https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk

      - 下载 Windows SDK 10 - https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk

    4. Windows N 和 KN 版本上的 Vungle 广告:对于使用 N 或 KN 特殊版本的 Windows 用户,必须安装“适用于 Windows 10 N 和 KN 版本的媒体功能包”才能使 Vungle 广告正常运行。

    5. 集成需要您拥有 Vungle 帐户,如果还没有,请创建 Vungle 帐户

    6. 如果还没有这样做,请转到“管理面板”,向您的帐户添加应用程序。只有这样做才能获得“应用程序 ID”,用于添加到您的应用程序中与我们的 SDK 一起使用。例如,在下图的红圈中就是您的“应用程序 ID",该 ID 可在应用程序页面上找到。

      在新版应用程序中,应用程序 ID 可与报告 API ID 匹配。对于使用“搜索”创建的现有应用程序,应用程序 ID 和报告 API ID 可能不同。(对于中介,可以在用户帐户的详细信息页面上找到报告 API “键”。)

Vungle Unity 插件并未包含在上述链接的示例代码中,因此,请确保先从“Vungle 管理面板”下载该插件。下载完成后...

安装 Vungle Unity 插件

打开 Unity,显示出您的项目,双击下载的 VunglePlugin.unitypackage 文件,将 Vungle Unity 插件添加到您的应用程序。

点击“全部”选择一切,然后再导入。

确保在构建设置中选择面向的正确平台。

为避免后续步骤中的编译错误,请确保项目的“构建设置”(cmd + Shift + B) 选择面向的是 iOS、Android 或 Window 平台。

对于 Windows

如果在 Windows 上使用 Unity 5,我们的 SDK 针对每个 Windows 平台分别有独立的 VungleSDK.winmd 文件。该文件位于以相应平台命名的目录中。参考下图,完成以下设置:

“项目”选项卡下,选择适合的 Vungle SDK。在“检查器”选项卡的“选择插件平台”“平台设置”项下,确认以下参数是否设置正确:

  • 对于 Assets/Plugins/metro/VungleSDKProxy.winmd
    平台:WSAPlayer
    SDK:任何 SDK
    占位符:Assets/Plugins/VungleSDKProxy.dll:

  • 对于 Assets/Plugins/metro/VungleSDK.winmd
    平台:WSAPlayer
    SDK:SDK81

  • 对于 Assets/Plugins/metro/UWP/VungleSDK.winmd
    平台:WSAPlayer
    SDK:UWP

  • 对于 Assets/Plugins/metro/WindowsPhone81/VungleSDK.winmd
    平台:WSAPlayer
    SDK:Phone SDK81

重要事项!如果使用 5.3.1 或更高版本 Unity 构建Universal 8.1Phone 8.1 项目,您必须按以下两种方式之一禁止使用 Assets/Plugins/metro/UWP/VungleSDK.winmd

  • 选择 Assets/Plugins/metro/UWP/VungleSDK.winmd,然后在“检查器”选项卡的选择插件平台“项下,清除 WSAPlayer 选项
  • 或者删除 Assets/Plugins/metro/UWP/VungleSDK.winmd

如果是 Unity 4,请转至“播放器设置” --> “发布设置”,并更改以下设置:

  • 未处理的插件: Size 1
  • Element 0: VungleSDKProxy.dll

在 Unity 中发布 Windows 项目后,请确保项目在 Unity 环境中具有 internetClient功能。打开“构建设置”(shift + ctrl + b) --> 选择 “Windows 应用商店”(位于“平台”下面)--> 单击“播放器设置”。在“发布设置”(位于“功能”菜单中)项下,选择 InternetClient 选项,如下所示:

添加代码!

在本演练中,我们将在主“游戏对象”附属的脚本中对所有与 Vungle 相关的代码进行初始化,您也可以从任何合适的脚本中调用 Vungle Unity 插件。但是,应尽快初始化 Vungle Unity 插件,以确保所包含的 Vungle SDK 已及时完成配置,在调用“playAd”时即可用户展示广告了。

初始化

初始化只需调用一次,且可用于 Vungle Unity 插件准备以向用户展示广告*应尽快在应用程序中初始化 Vungle SDK,因为在播放广告前,SDK 需要 30-45 秒时间进行初始化和缓存广告*

//Your App IDs and Placement IDs, they can be found in the Vungle Dashboard on your apps' pages
Vungle.init ("Test_Android", "Test_iOS", "vungleTest");

Vungle SDK 初始化之后,它会自动对您在 Vungle 管理面板中选定为“自动缓存”的广告位置请求广告。我们建议选择观看次数最多的广告位置用于自动缓存。

播放广告

您可使用以下方法来播放广告:

Vungle.playAd();

 

自定义选项

playAd 方法可以接受一个选项词典来自定义广告播放体验。

public static void playAd(Dictionary<string,object> options);

选项字典接受以下键:

说明
orientation

设置广告的方向。

  • 对于 iOS,请使用 VungleAdOrientation
public enum VungleAdOrientation
{
Portrait = 1,
LandscapeLeft = 2,
LandscapeRight = 3,
PortraitUpsideDown = 4,
Landscape = 5,
All = 6,
AllButUpsideDown = 7
}
  • 对于 Android,将 matchVideo 设为 true,并将 autoRotate 设为 false
  • 对于 Windows,将 autoRotate 设置为 true,将 landscape 设置为 false。(默认值为 autoRotate。)
userTag 关键用户即是在 S2S 调用中作为用户传递的用户(如有)。
alertTitle 标题字符串:用于在用户过早关闭激励式广告体验时所显示的警告对话框标题。
alertText 正文文本的字符串:用于在用户过早关闭激励式广告体验时所显示的警告对话框正文。
closeText “关闭”按钮文本的字符串标题:用于在用户过早关闭激励式广告体验时所显示的警告对话框按钮。
continueText “关闭”按钮文本的字符串标题:用于在用户过早关闭激励式广告体验时所显示的警告对话框按钮。
immersive 沉浸模式。

OnPause 和 OnResume 功能

添加 onPause 和 onResume 等功能的代码,允许因某个应用程序进入后台运行而被暂停的广告恢复播放:

使 OnApplicationPause(bool pauseStatus) 无效 { 如果 (pauseStatus) { Vungle.onPause(); } 其他 { Vungle.onResume(); } }

事件处理

您可以设置事件处理器,用于处理广告展示周围的所有 5 个 Vungle SDK 事件。

● 当 SDK 开始播放视频广告时,会触发以下事件。此时是暂停游戏、声效和动画等内容的最佳时机。

public static event Action<string> onAdStartedEvent;

● 当 SDK 关闭广告时,会触发以下事件。此时是奖励用户并恢复游戏、声效和动画等内容的最佳时机。

public static event Action<string, AdFinishedEventArgs> onAdFinishedEvent;

AdFinishedEventArgs 类包含以下属性,用于检查广告播放效果:

public class AdFinishedEventArgs : EventArgs { //Represents a BOOL whether or not the user clicked the download button. public bool WasCallToActionClicked{ get; set;} //Represents a bool whether or not the video can be considered a completed view. public bool IsCompletedView{ get; set;} //The time in seconds that the user watched the video. public double TimeWatched{ get; set;} }


● 当 SDK 更改了广告可用性状态时,会触发以下事件。isAdPlayable 布尔值表示存在新的可播放 placementID。

public static event Action<string, bool> adPlayableEvent;



● 当 SDK 成功完成初始化时,会触发以下事件。

public static event Action onInitializeEvent;



● 当 SDK 输出日志时,会触发以下事件。

public static event Action<string> onLogEvent;

以上就是全部操作步骤!有关 Vungle Unity 插件的详细信息,请查看我们的其他插件文章,或者查看 Unity 示例应用程序源代码。

有关在测试模式下对应用程序进行测试的注意事项:如果应用程序处于测试模式,您将无法下载广告中的任何应用程序。此外,“管理面板”也不会报告展示次数。这是因为测试广告仅用于验证您的 SDK 集成是否正确。此功能在您的应用程序以活动模式上线后即可使用。

运行 Vungle 示例应用程序

要运行示例应用程序,请下载 Unity 示例应用程序。在 Unity 中创建新项目。打开 Unity,显示出您的项目,然后双击下载的 VunglePlugin.unitypackage 文件,将 Vungle Unity 插件添加到您的应用程序。

点击“全部”选择一切,然后再导入。

在“项目”窗口中,导航到“资产”文件夹,检查此文件夹是否包含已下载项目资产文件夹中的所有文件(如下图中红色所示部分)。如果 Unity 资产文件夹中未包含所有文件,请手动移动这些文件,具体操作如下:右键单击 Unity 中的“资产”文件夹并选择“在查找器中打开”,然后在打开的查找器窗口中将已下载的示例应用程序资产文件夹中的所有内容复制粘贴到 Unity 项目的“资产”文件夹中,必要时可替换相关文件。

Screen_Shot_2017-06-27_at_5.43.12_PM.png

在 Unity 中,选择“项目导航器->资产”,然后双击 MainTitleScreen:

Screen_Shot_2017-06-27_at_6.01.39_PM.png

单击 GameObject,然后选择“检查器->标题 GUI(脚本)”内的 TitleGUI:

Screen_Shot_2017-06-27_at_6.02.57_PM.png

按 Command + Shift + B 打开 Build 设置,点击 iOS 或 Android,然后单击“切换平台”。

Screen_Shot_2017-06-27_at_6.14.34_PM.png

在“Build 设置”窗口中,单击“播放器设置”,在“检查器”中,确保以下红色值在应用程序中是唯一的:

Screen_Shot_2017-06-27_at_6.16.56_PM.png

现在,回到“Build 设置”,然后单击“构建”以生成 Android apk 文件或 Xcode 项目。

 

如何在 Windows 上导出 Xcode 项目

要在 Windows 计算机上从 Unity 导出 Xcode 项目,您必须在计算机上安装 Python 编程语言。无论是只为此目的安装 Python,或是在导出时遇到了问题,请从此处安装最新版本 Python:https://www.python.org/

 

还有其它问题?提交请求

评论