开发指南

Combo SDK 聚合了多家广告平台，但多家广告平台的差异已经被抹掉，游戏侧感知不到。

游戏客户端和游戏服务端只需要对接 Combo SDK 中广告功能的 API 即可。

集成前准备

1. 参考 创建游戏，在世游发行平台完成游戏的创建。
2. 已经获得游戏的 接入参数。
3. 已经获得接入所需的 SDK 资源。
4. 完成 项目配置 和 初始化 工作。
5. 完成 账号与登录 功能的接入。
6. iOS 平台已将接入广告平台所对应的 .xcframework 导入至 Xcode 工程中。
7. iOS 平台已在 Info.plist 中配置请求追踪权限键 — NSUserTrackingUsageDescription。

预加载广告

警告

• PreloadAd 方法用于预加载广告，它只是提前加载广告，但并不会显示广告，只有调用 showAd 接口才会显示广告
• iOS 需要添加 ComboSDKTopOn
• 预加载广告的结果通过回调函数返回，如果预加载失败，建议对相应的错误进行处理
• 此接口需要在登录成功后才能调用
• 推荐游戏在运行时空闲时机可以调用

支持平台

方法签名

public static void PreloadAd(PreloadAdOptions opts, Action<Result<PreloadAdResult>> callback);

代码示例

Show Code

PreloadAdOptions opts = new PreloadAdOptions
{
    placementId = "xxx",
    scenarioId = "scenarioId"
};

ComboSDK.PreloadAd(opts, r) =>
{
    if (r.IsSuccess)
    {
        var preloadResult = r.Data
    }
    else
    {
        var error = r.Error;
        Debug.LogError("预加载广告失败：" + error.DetailMessage);
    }
});

方法参数

Parameters	Required	Type	Description
opts	True	PreloadAdOptions	预加载广告接口传入的参数集
callback	True	Action<Result<PreloadAdResult>>	预加载广告后的回调方法，用于接收 PreloadAd 的结果

PreloadAdOptions

Properties	Supported Platforms	Type	Description
placementId		string	广告位 ID
scenarioId		String	广告场景 ID

提示

请联系世游运营人员获取广告场景 ID。

PreloadAdResult

Properties	Supported Platforms	Type	Description
placementId		string	广告位 ID

Error

Code	Supported Platforms	Description
NETWORK_ERROR		网络错误
SERVER_ERROR		服务端错误
THIRD_PARTY_ERROR		第三方 SDK 错误
UNKNOWN_ERROR		未知错误

提示

错误处理请参阅。

展示广告

警告

• ShowAd 不依赖 preloadAd, 可以直接调用此 API 来显示广告，但为了优化体验，推荐先调用 preloadAd 接口提前加载广告
• iOS 需要添加 ComboSDKTopOn
• 显示广告的结果通过回调函数返回，如果显示广告失败，建议对相应的错误进行处理
• 此接口需要在登录成功后才能调用
• 游戏客户端需要将调用 ComboSDK.ShowAd 方法获取到的 token 参数传给游戏服务端，游戏服务端对 token 进行验证，验证通过后则发放激励奖励

支持平台

方法签名

public static void ShowAd(ShowAdOptions opts, Action<Result<ShowAdResult>> callback);

代码示例

Show Code

ShowAdOptions opts = new ShowAdOptions
{
    placementId = "xxx",
    scenarioId = "scenarioId"
};

ComboSDK.ShowAd(opts, r) =>
{
    if (r.IsSuccess)
    {
        var result = r.Data;
    }
    else
    {
        var error = r.Error;
        Debug.LogError("展示广告失败：" + error.DetailMessage)
    }
});

方法参数

Parameters	Required	Type	Description
opts	True	ShowAdOptions	展示广告接口传入的参数集
callback	True	Action<Result<ShowAdResult>>	显示广告后的回调方法，用于接收 ShowAd 的结果

ShowAdOptions

Properties	Supported Platforms	Type	Description
placementId		String	广告位 ID
scenarioId		String	广告场景 ID

提示

请联系世游运营人员获取广告场景 ID。

ShowAdResult

Properties	Supported Platforms	Type	Description
status		ShowAdStatus (enum)	展示广告的状态: START - 开始显示广告 CLICKED - 广告被点击 CLOSED - 广告被关闭 REWARDED - 广告播放完成，发放奖励
token		string	世游 API 层生成的一个游戏服务端可验证的 JWT Token，验证方法见

Error

Code	Supported Platforms	Description
NETWORK_ERROR		网络错误
SERVER_ERROR		服务端错误
THIRD_PARTY_ERROR		第三方 SDK 错误
UNKNOWN_ERROR		未知错误

提示

错误处理请参阅。