开始接入
本文介绍如何快速接入世游发行平台,以及接入前的一些准备工作。
创建游戏
世游运营人员请通过 KOA -> 行政办公 -> 金山世游系统权限申请 -> 世游发行平台 发起游戏创建申请。
申请通过后,运营人员可登录 世游发行平台 Console 完成游戏参数、发行版本等信息配置。
接入参数
游戏创建完成后,会在世游发行平台生成游戏基本信息。
在游戏项目的对接过程中,您会使用到以下接入参数:
- 世游发行平台的 Endpoint
- 游戏的唯一标识 Game ID
- 一组 API 密钥 Build Key, Publishable Key, Secret Key
新接入世游发行平台的游戏,请联系对接的运营人员获取这些接入参数。
环境要求
通用环境要求
- Unity 2019.4.38 或更高版本
- API Compatibility 最低
.NET Standard 2.0
导出目标平台工程要求
- Android
- iOS
- Windows
- Android SDK 仅支持 Android 6.0 (API level 23) 及以上版本
- 仅支持 IL2CPP
- 仅支持 arm64
- Gradle 仅支持 7.x 及以下版本(推荐 7.5.1)
- 仅支持 Java 11
- Android Gradle Plugin 支持 7.5.1 及以下版本
- 导出 Android 工程后需要通过 命令行工具 CLI 初始化项目配置
- 仅支持 IL2CPP
- 仅支持 arm64
- 仅支持 Xcode >= 14.0
- 仅支持 iOS >= 12.0
- 不支持 iOS Simulator
- 需要在 Xcode 工程中按需手动导入 XCFrameworks 组件
- 需要在 Xcode 工程中导入通过 命令行工具 CLI 生成的
ComboSDK.json
配置文件
- Windows 11、Windows 10 64-bit
- Windows 分辨率最低支持
1024 x 768
- 支持 IL2CPP 和 Mono
- 需要将通过 命令行工具 CLI 生成的
ComboSDK.json
配置文件导入至 Unity./Assets/ComboSDK/Resources
目录下
获取 Combo SDK
游戏客户端
- Unity
请从 更新日志 中下载最新版本。
游戏服务端
- Go
- Node.js
combo-sdk-go 是世游为 Go 提供的 SDK。
面向游戏服务端提供以下功能:
- 验证世游服务端签发的
Identity Token
和Ad Token
- 请求
Server REST API
并解析响应 - 接收
Server Notifications
并回复响应
SDK 会将 API 的请求响应结构、签名计算与签名验证、HTTP 状态码等实现细节封装起来,提供 Go 的强类型 API,降低游戏侧接入世游系统时出错的可能性,提高接入的速度。
请从 更新日志 中获取最新版本。
combo-sdk-node 是世游为 Node.js 提供的 SDK。
面向游戏服务端提供以下功能:
- 验证世游服务端签发的
Identity Token
和Ad Token
- 请求
Server REST API
并解析响应 - 接收
Server Notifications
并回复响应
SDK 会将 API 的请求响应结构、签名计算与签名验证、HTTP 状态码等实现细节封装起来,提供 JavaScript 和 TypeScript 的 API,降低游戏侧接入世游系统时出错的可能性,提高接入的速度。
请从 更新日志 中获取最新版本。
项目集成
SDK 目前仅支持手动导入。
将获取的 Combo SDK 解压后, 将 com.seayoo.sdk
文件夹拷贝到 Unity 项目的 Packages
目录下。
- 每次替换新版本请删除再替换
Packages/com.seayoo.sdk
- 不要主动删除 Combo SDK 所包含的 meta 文件
- Android
- iOS
- Windows
通过 Unity 导出 Android 工程
Build Settings
- 勾选
Export Project
。
Build Settings -> Player Settings -> Other Settings
Minimum API Level
,确保 API level 设置为 21 或以上版本(Combo SDK 最低兼容 Android 版本为 Android 5.0)。Scripting Backend
,选择IL2CPP
。Target Architectures
,勾选ARM64
,同时取消勾选ARMv7
。
在 Unity 导出 Android 工程时,Combo SDK 会通过 IPostGenerateGradleAndroidProject
进行项目导出的后处理工作,此过程将对导出工程的 AndroidManifest.xml
以及 build.gradle
等文件进行修改,以实现自动化配置相关依赖。详细内容请 参考 FAQ。
开始构建
导出安卓工程后,使用 命令行工具 CLI 进行进一步的 Setup 配置和并完成构建。
更多内容请参阅 命令行工具 CLI。
1. 集成 XCFrameworks 组件
- 请从 iOS 更新日志 中下载 iOS Combo SDK 的最新版本。
iOS Combo SDK 是组件化架构,组件详情如下:
组件名称 | 是否必接 | 组件描述 |
---|---|---|
ComboSDK | 必接 | Combo SDK 核心组件,提供了对外接口和一系列通用功能和工具 |
ComboSDKSeayooAccount | 必接 | 金山世游统一账号认证系统 |
ComboSDKAppStoreConnect | 必接 | 苹果商店内购 - App Store Connect |
ComboSDKSentry | 必接 | Sentry 错误追踪系统 - Sentry iOS 7.31.5 |
ComboSDKSignInWithApple | 可选 | Apple 账号登录 |
ComboSDKGuest | 可选 | 游客账号登录 |
ComboSDKTopOn | 可选 | TopOn 广告聚合平台 - TopOn iOS 6.2.96 |
ComboSDKTrackingIO | 可选 | TrackingIO 广告监测平台 - TrackingIO 1.9.17 |
ComboSDKDouyinUOP | 可选 | 抖音直播联运 - UnionOpenPlatformCore 2.2.1.0 |
ComboSDKUpush | 可选 | 友盟消息推送 SDK U-Push - U-Push |
ComboSDKBDASignal | 可选 | 巨量引擎 SDK - BDASignalSDK |
ComboSDKAgora | 可选 | 小红书分享 SDK - XiaoHongShuOpenSDK |
ComboSDKWeixin | 可选 | 微信开放平台 SDK - WechatOpenSDK |
ComboSDKWeibo | 可选 | 微博开放平台 SDK - Weibo_SDK |
ComboSDKDouyinOpen | 可选 | 抖音开放平台 SDK - DouyinOpenSDK |
ComboSDKSolarEngine | 可选 | 热力引擎 SDK - SolarEngine |
2. 生成 ComboSDK.json
通过 命令行工具 CLI 生成 ComboSDK.json
文件
3. 使用 Unity 导出 Xcode 工程
集成 Combo SDK 后,可通过 Wizard
面板激活 Combo SDK 提供的 iOS PostBuild,会自动装配 ComboSDK.json
文件和 XCFrameworks 组件至 Xcode
Enable iOS PostBuild
默认为关闭状态。- 具体处理信息参考 iOS PostBuild 做了哪些处理
iOS PostBuild 参数说明
Parameter | Required | Type | Description |
---|---|---|---|
enableIOSPostBuild | False | bool | 是否开启 IOS PostBuild,默认为关闭 关闭 - 无法配置地址且不会开启该功能 开启 - 将 ComboSDK.json 和 XCFrameworks 自动装配至 Xcode Project |
ComboSDK.json | False | string | 由命令行工具 CLI 生成的 ComboSDK.json 文件的地址,用于装配 ComboSDK.json 文件 |
XCFrameworks Dir | False | string | 从 iOS 更新日志 中下载 iOS Combo SDK 文件夹的地址,用于集成 XCFrameworks 组件 注意:填入的文件夹路径中只需包含需要的组件 |
初始化
导入 Combo SDK 后,需要通过菜单 ComboSDK/Wizard
配置参数
参数说明
Parameter | Required | Type | Description |
---|---|---|---|
gameId | True | String | 由世游侧为游戏分配,用于标识游戏的业务代号 |
publishableKey | True | String | 由世游侧为游戏分配,游戏侧和世游侧共享的密钥 |
endpoint | False | String | 游戏请求世游服务端的端点 若未指定该参数,则默认使用国内端点 国内 — https://api.seayoo.com 海外 — https://api.seayoo.io |
接入功能
Combo SDK 提供 账号与登录、内购与支付、游戏内广告、游戏内分享、数据分析、权限合规、错误追踪、防沉迷与实名认证 、更新唤起等多种功能。 请在 SDK 初始化完成后,根据项目需要,参考对应的功能文档,接入相应功能。
由于大部分功能都会包含登录,因此我们推荐从 账号与登录 开始接入。