重要说明

TGSDK 从 1.8.7 版本开始 Android 平台 SDK 将完全适配 Android X

对于 Unity 平台来说，由于上述原因 TGSDK Unity 平台 SDK 将仅支持 Unity 2018 及以上版本。

对于 Unity 平台项目出 iOS 包则不受影响，iOS 包仍然支持 Unity 5.x 以后的版本。

如果您的 Unity 项目因种种原因实在无法升级，那么您可以从这里下载到以前版本的 TGSDK 广告 SDK。

适用于国内安卓环境的旧版本在这里，

适用于 Google Play 环境的旧版本在这里

旧版本的接入文档请访问这里

我们同步制作了 Unity 接入 TGSDK 的教学视频，请点击观看

目录

1、导入 TGSDK 到工程

将下载到的 unitypackage 文件双击导入你的 Unity 项目中。

导入后可以在 Assets/TGSDK/Example 目录下看到一个名为 Example 的场景。

你甚至可以新建一个空白的 Unity 项目，然后双击导入我们的 TGSDK ，通过展示这个场景来构建一个简单的演示项目程序来体验 TGSDK 的广告服务。

你也可以通过 Assets/TGSDK/Example/ExampleScript.cs 中的源代码来学习 TGSDK 的使用方法。

有关 Google AdMob 广告对接的重要说明

如果你的产品使用的是 TGSDK 的国内安卓渠道广告 SDK 包，且你的产品只发行与中国国内，并不使用 Google AdMob 广告商插件，那么请忽略这个小节的内容

【注意】如果你的产品是在 Google Play 上面发型，接入了 TGSDK 针对 GooglePlay 的广告 SDK，并且使用 Google AdMob 的广告插件

【注意】那么请你严格按照这个小节的内容指示去做，否则 Google AdMob 广告插件会使你的产品运行出现崩溃问题！！！

根据 Google AdMob 最新对接文档 要求，

你项目的 AndroidManifest.xml 文件中必须配置如下节点：

        <meta-data
            android:name="com.google.android.gms.ads.APPLICATION_ID"
            android:value="ca-app-pub-8385434067230970~7710989445"/>

否则你的项目在使用 Google AdMob 广告的过程中会出现崩溃。

正如我们附带的示例工程的 AndroidManifest.xml 文件所示，我们配置了这个节点，并且节点中的值是 android:value="ca-app-pub-8385434067230970~7710989445"

这个是我们在 Google AdMob 注册的测试用的广告账户应用 ID，只方便用来做测试，不能够用于线上生产环境。

【注意！！！】当你的产品准备正式上线时，请联系我们的运营人员，获取针对你这款应用使用的广告账户 ID，

并在从我们运营人员那里获取到广告账户 ID 后，需要你正确的替换掉对应的值，以确保你可以正确的使用 Google AdMob 广告服务。

有关移动安全联盟 MSA 获取 OAID 设备号 SDK 对接的说明

由于 Android 10 系统对于获取设备号的限制，越来越多的广告厂商使用移动安全联盟（MSA）推广的统一设备号 OAID SDK 作为获取设备标识的替代方式。

为了更好的适配 Android 10 系统，也建议您的产品今早接入移动安全联盟（MSA）的 OAID 设备号获取 SDK。

为了保证兼容性，TGSDK 广告聚合变现 SDK 默认没有附带移动安全联盟（MSA）的 OAID 设备号获取 SDK，但是提供了该 SDK 的下载，您可以

到这里下载 1.0.10 版本

到这里下载 1.0.13 版本

到目前（2020 年 4 月）位置，最新版本为 1.0.13，但目前主流使用的是 1.0.10 版本，推荐您尽快接入。

接入方法很简单，只需将下载的 aar 引入您的项目中即可。

2、初始化 TGSDK

从 Yomob官方网站 为产品注册好账户后，你将会从网站得到你的产品对应的 AppID 使用这个参数来初始化 TGSDK

using Together;

TGSDK.Initialize("Your application ID from yomob");

3、预加载广告资源

为了有充裕的时间来加载广告资源，建议尽早调用预加载 API 来开始广告的加载工作。甚至你可以在初始化 TGSDK 的同时就开始调用广告预加载 API 来预加载广告。

using Together;

TGSDK.PreloadAd();

4、播放广告

通过 Yomob 官方网站 为注册的应用建立广告场景，获得相应的广告场景 ID 后，通过场景 ID 参数来判断广告是否已经准备好，如果对应场景的广告已经准备好，则可以调用播放 API 来播放对应场景的广告。

using Together;

if (TGSDK.CouldShowAd("Your scene ID from yomob")) {
    TGSDK.ShowAd("Your scene ID from yomob");
}

5、高级用法

开启 Debug 模式

开启 debug 模式后可以看到更多 Log 输出，方便定位遇到的问题。但需要注意

在生产环境请勿使用 Debug 模式，另外，如果需要启动 Debug 模式，请在调用初始化 API 前设置 Debug 模式的开启

using Together;

TGSDK.SetDebugModel(true);

设置广告预加载事件监听

在调用 PreloadAd 方法预先加载广告资源的过程中会产生一些事件通知，通过绑定回调函数来捕捉这些事件通知。示例：

// 使用 lambda 表达式
// 广告配置数据获取成功
TGSDK.PreloadAdSuccessCallback = (string ret) => {
};
// 广告配置数据获取失败
TGSDK.PreloadAdFailedCallback = (string error) => {
};
// 奖励视频广告已经准备好
TGSDK.AwardVideoLoadedCallback = (string ret) => {
};
// 插屏视频广告已经准备好
TGSDK.InterstitialVideoLoadedCallback = (string ret) => {
};
// 静态插屏广告已经准备好
TGSDK.InterstitialLoadedCallback = (string ret) => {
};


// 使用 Action<string>
public void OnPreloadAdSuccess(string ret) {
}
TGSDK.PreloadAdSuccessCallback = OnPreloadAdSuccess;

public void OnPreloadAdFailed(string error) {
}
TGSDK.PreloadAdFailedCallback = OnPreloadAdFailed;

public void OnAwardVideoLoadedCallback(string ret) {
}
TGSDK.AwardVideoLoadedCallback = OnAwardVideoLoadedCallback;

public void OnInterstitialVideoLoadedCallback(string ret) {
}
TGSDK.InterstitialVideoLoadedCallback = OnInterstitialVideoLoadedCallback;

public void OnInterstitialLoadedCallback(string ret) {
}
TGSDK.InterstitialLoadedCallback = OnInterstitialLoadedCallback;

【注意】PreloadAdSuccessCallback 只表示成功的获取了广告配置数据，并不代表广告本身加载完成，请不要根据此回调作为判断是否可以播放广告的依据

设置广告播放行为事件监听

在调用 ShowAd 方法播放广告的过程中会产生相应的事件通知，通过绑定回调函数可以捕捉这些事件通知，示例：

// 使用 lambda 表达式
// 广告成功开始播放回调
TGSDK.AdShowSuccessCallback = (string scene, string name) => {
};
// 广告播放失败回调
TGSDK.AdShowFailedCallback = (string scene, string name, string error) => {
};
// 广告关闭回调，是否奖励则在第三个参数award中
TGSDK.AdCloseCallback = (string scene, string name, bool award) => {
};
// 广告被用户点击的回调
TGSDK.AdClickCallback = (string scene, string name) => {
};

// 使用 Action<string>
public void OnAdShowSuccess(string scene, string name) {
}
TGSDK.AdShowSuccessCallback = OnAdShowSuccess;

public void OnAdShowFailed(string scene, string name, string error) {
}
TGSDK.AdShowFailedCallback = OnAdShowFailed;

public void OnAdClose(string scene, string name, bool award) {
}
TGSDK.AdCloseCallback = OnAdClose;

public void OnAdClick(string scene, string name) {
}
TGSDK.AdClickCallback = OnAdClick;

广告播放测试工具

请不要在生产环境使用此功能，此功能仅供测试

在测试阶段，你可以使用广告播放测试工具 API 来替代正常的广告播放 API，这样更方便你整体检测广告的加载情况和广告的运行情况

使用广告播放测试工具接口

TGSDK.ShowTestView("Your scene id from Yomob");

来替代广告播放接口

TGSDK.ShowAd("Your scene id from Yomob");

将会弹出如下图所示的 UI 界面，从中你可以检查广告插件的运行情况并通过点击准备好播放的广告插件来播放指定广告商的广告。

TGSDK_showTestView TGSDK_showTestView