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

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

目录

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

开始之前……

    1. 对于 Android,Vungle Unity 插件需要 Java 1.7,并支持 iOS 7+。

      注意事项——Unity 5.3 和 5.3.1 中有一个故障,阻止 Unity 为 Windows 8.1 构建应用程序。 Unity 已发布了一个补丁解决这个问题,我们建议您使用以下版本: 5.3.1p1、5.3.1p2 和 5.3.1p3 。不要使用 UNITY 版本 5.3 或 5.3.1!

    2. Vungle Unity 插件:
      ——面向 iOS,支持 Unity 4 和 Unity 5.4.1 或更高版本。
      ——面向 Android,支持 Unity 5 和 Unity 4。 
      ——面向 Windows(Universal 8.1 或 Phone 8.1),支持 Unity 4 和更高版本。
      ——面向 Windows(Windows 10 UWP),支持 Unity 5.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 广告:对于使用 Windows 特别的 N 或 KN 版本的用户而言,必须为 Vungle 广告安装 "Media feature pack for Windows 10 N and KN Editions" 以便工作。

    5. 集成需要 Vungle 账户,因此,如果您没有 Vungle 账户,请创建 Vungle 帐户

    6. 如果您尚未执行此操作,请前往我们的 dashboard将您的应用程序添加到帐户中。您需要这样做,这样您才可以得到您的 App ID,然后将其添加到您装有我们的 SDK 的应用程序上。例如,在下方图像中,App ID 用红色圆圈标记,并可以在您的应用程序页面上找到。

      在更新的应用程序中,应用程序 ID 可以与报告 API ID 相匹配。对于使用“搜索”创建的应用程序,应用程序 ID 和报告 API ID 可能有所不同。(为了协调这一点,报告 API “密匙”可在用户帐户详情页上找到。)

The Vungle Unity 插件未包含在上述链接的示例代码中,因此请确保您已先从 Vungle dashboard 上下载了该插件。 一旦下载完成...

安装 Vungle Unity 插件

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

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

确保您定位的是您的构建设置中的正确平台。

为了避免下一步中的编译错误,请确保您的项目构建设置 (cmd + Shift + B)定位的是 iOS、Android 或 Windows 平台

面向 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 插件,以确保调用 'playAd' 时包含的 Vungle SDK 已及时完成配置以向用户呈现广告。

初始化

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

//您的 App ID 可在您的应用程序页面上的 Vungle Dashboard 中找到
Vungle.init ("Test_Android", "Test_iOS", "Test_Windows");

播放广告

播放广告是另一行程序。

//简单扼要!
Vungle.playAd();

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

// 播放有着更多选项的广告。使用 Dictionary<string,object> 设置选项。
public static void playAdWithOptions( Dictionary<string,object> options );

选项​​字典接受下面的密匙:

密匙 说明
奖励推广

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

Dictionary<string, object> options = new Dictionary<string, object> ();
options ["incentivized"] = true;
Vungle.playAdWithOptions (options);
方向

设置广告的方向。

  • 对于 iOS,请使用 VungleAdOrientation
public enum VungleAdOrientation
{
    Portrait = 1,
    LandscapeLeft = 2,
    LandscapeRight = 3,
    PortraitUpsideDown = 4,
    Landscape = 5,
    全部 = 6,
    AllButUpsideDown = 7
}
  • 对于 Android,为 matchVideo 设置为,为 autoRotate 设置为
  • 对于 Windows,为 autoRotate 设置为,为 landscape 设置为。(默认值为 autoRotate。)
userTag 关键用户是 S2S 调用中作为用户通过的用户(如有)。
展示位置 提示单个广告播放的广告展示位置详细信息的元数据。 这用于在为您的应用程序的性能检索报表数据时,筛选不同的广告体验。
alertTitle 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框标题的字符串。
alertText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框正文文本的字符串。
closeText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框关闭按钮文本的字符串标题。
continueText 在用户过早关闭奖励推广的广告体验时,用作呈现的警告对话框关闭按钮文本的字符串标题。
沉浸

沉浸模式

key1..8 我们在此构建了 8 个密匙

OnPause and OnResume 功能

为启用因应用程序用作背景暂停广告的 onPause and onResume 功能添加代码,以恢复播放:

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

事件处理

Vungle Unity 插件允许应用程序订阅广告介绍周围的 4 个事件:

// Vungle 广告已准备好显示时触发
公用 静态事件 Action<bool> adPlayableEvent;
// Vungle 广告开始时触发
公用 静态事件 Action onAdStartedEvent;
// Vungle 广告完成并提供有关事件的全部信息时触发
公用 静态事件 Action&lt;AdFinishedEventArgs&gt; onAdFinishedEvent;

AdFinishedEventArgs 类别包含以下参数。

公用类别 AdFinishedEventArgs : EventArgs
{
	//  如果用户点击“下载”按钮转至商店
	公用 bool WasCallToActionClicked;

	//  如果至少 80% 的视频已经观看
	公用 bool IsCompletedView;

	//观看 Vungle 广告的时间
	公用 双倍 TimeWatched;

	// Vungle 广告的总时间
	公用 双倍 TotalDuration;
}
// SDK 发送日志事件时触发
公用 静态事件 Action&lt;string&gt;onLogEvent;

注意:下面的三个事件已弃用:

//已弃用:请转而使用 adPlayableEvent 事件。
公用 静态事件 Action onCachedAdAvailableEvent;

//已弃用:请转而使用 onAdFinishedEvent 事件。
公用 静态事件 Action onAdEndedEvent;
	
//已弃用:请转而使用 onAdFinishedEvent 事件。
公用 静态事件 Action&lt;双倍,双倍&gt;onAdViewedEvent;

订阅这些事件很容易,并通过 VungleManager 对象完成。在 C# 里面,添加事件监听器会看起来像这样:

//每次事件被触发时就会不同步地调用已封装功能
Vungle.adPlayableEvent += (isAdAvailable) => {
	if (isAdAvailable) {
DebugLog(“广告就要显示了!”);
} 其他 {
DebugLog(“此时无广告可用。”);
} };

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

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

运行 Vungle 示例应用程序

要运行我们的示例应用程序,请导航到 Assets -->Plugins --> Vungle --> demo 文件夹并双击 VungleCombo.unity 加载应用程序。确保 VungleCombo 显示在 Hierarchy 窗口下,然后点击构建和运行

如何在 Windows 上导出 Xcode 项目

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

 

还有其它问题?提交请求

评论