跳到主要内容

开始接入

本文介绍如何快速接入世游发行平台,以及接入前的一些准备工作。

创建游戏

世游运营人员请通过 KOA -> 行政办公 -> 金山世游系统权限申请 -> 世游发行平台 发起游戏创建申请。

申请通过后,运营人员可登录 世游发行平台 Console 完成游戏参数、发行版本等信息配置。

接入参数

游戏创建完成后,会在世游发行平台生成游戏基本信息。

在游戏项目的对接过程中,您会使用到以下接入参数:

  1. 世游发行平台的 Endpoint
  2. 游戏的唯一标识 Game ID
  3. 一组 API 密钥 Build Key, Publishable Key, Secret Key
提示

新接入世游发行平台的游戏,请联系对接的运营人员获取这些接入参数。

环境要求

通用环境要求

  • Unity 2019.4.38 或更高版本
  • API Compatibility 最低 .NET Standard 2.0

导出目标平台工程要求

  • 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 初始化项目配置

获取 Combo SDK

游戏客户端

请从 更新日志 中下载最新版本。

游戏服务端

信息

combo-sdk-go 是世游为 Go 提供的 SDK。

面向游戏服务端提供以下功能:

SDK 会将 API 的请求响应结构、签名计算与签名验证、HTTP 状态码等实现细节封装起来,提供 Go 的强类型 API,降低游戏侧接入世游系统时出错的可能性,提高接入的速度。

请从 更新日志 中获取最新版本。

项目集成

SDK 目前仅支持手动导入。

将获取的 Combo SDK 解压后, 将 com.seayoo.sdk 文件夹拷贝到 Unity 项目的 Packages 目录下。

危险
  • 每次替换新版本请删除再替换 Packages/com.seayoo.sdk
  • 不要主动删除 Combo SDK 所包含的 meta 文件

1. 下载 XCFrameworks 组件

信息

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
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
ComboSDKDouyin可选抖音游戏全官服促活分账 SDK
- OSDK

2. 生成 SDK 参数文件

通过 命令行工具 CLI 生成 ComboSDK.json 文件。

提示

若游戏需要集成 ComboSDKDouyinOpen,则还会生成 UOPSDKConfig.json 参数文件。

3. Unity 导出 Xcode 工程

步骤1 中下载的 iOS SDK 产物解压后与 步骤2 中生成的 SDK 参数文件放在同一目录下。

集成 Combo SDK for Unity 后,在 Wizard 面板 Combo SDK Dir 中指定将该目录路径,构建过程中 Combo SDK 会自动装配参数文件和所需的 XCFrameworks 组件至 Xcode 工程中。

提示
  • Enable iOS PostBuild 默认为开启状态。
  • iOS PostBuild 会根据 ComboSDK.json 文件配置自动化装配所需的 XCFramework 组件,因此需要将下载的 所有 iOS XCFrameworks 都放入装配目录中。
  • 若不启用 Combo SDK iOS PostBuild,请自行将参数文件及所需 XCFrameworks 组件导入至 Xcode 工程中,详情请参考 iOS PostBuild 做了哪些处理

img

iOS PostBuild 参数说明

ParameterRequiredTypeDescription
enableIOSPostBuildFalsebool是否开启 IOS PostBuild,默认为关闭
关闭 - 无法配置地址且不会开启该功能
开启 - 将参数文件和 XCFrameworks 自动装配至 Xcode Project
Combo SDK DirFalsestring包含 Combo SDK 参数文件及 XCFrameworks 组件的目录路径

初始化

提示

导入 Combo SDK 后,需要通过菜单 ComboSDK/Wizard 配置参数

参数说明

ParameterRequiredTypeDescription
gameIdTrueString由世游侧为游戏分配,用于标识游戏的业务代号
publishableKeyTrueString由世游侧为游戏分配,游戏侧和世游侧共享的密钥
endpointFalseString游戏请求世游服务端的端点
若未指定该参数,则默认使用国内端点
国内 — https://api.seayoo.com
海外 — https://api.seayoo.io

img

接入功能

Combo SDK 提供 账号与登录内购与支付游戏内广告游戏内分享数据分析权限合规错误追踪防沉迷与实名认证更新唤起等多种功能。 请在 SDK 初始化完成后,根据项目需要,参考对应的功能文档,接入相应功能。

由于大部分功能都会包含登录,因此我们推荐从 账号与登录 开始接入。