接入流程
本文旨在帮助游戏开发者能更顺利的接入聚合登录&官方支付SDK,请游戏开发者根据接入流程一步一步完成对接,降低接入出错的可能。
Step1: 前往Meetgames注册账号
前往Meetgames官网注册账号
Step2: 创建游戏
前往Meetgames控制台 > 进入发行服务 > 聚合登录支付 > 创建游戏
Step3: 获取SDK接入参数
- 方式一:游戏创建完成后,会立即跳转到SDK接入参数页,可以在此页面中获取到
AppID
、AppKey
和AppSecret
三个参数 - 方式二:进入发行服务 > 聚合登录支付 > SDK下载页获取到
AppID
、AppKey
和AppSecret
三个参数
Step3: 确认接入渠道并创建
前往Meetgames控制台 > 进入发行服务 > 聚合登录支付 > 添加渠道
配置包括:
- 平台类型
- 渠道商
- 包名
- 登录方式(建议先开启GUEST进行接入调试,其他登录方式等渠道参数申请完成后启用)
Step4: 根据渠道选择对应SDK进行下载
前往Meetgames控制台 > 进入发行服务 > 聚合登录支付 > SDK下载 > 点击联系运营下载TopSDK
或者直接点此前往下载页,下载对应渠道和功能的SDK。
Step5: SDK接入
请参照接入文档完成SDK接入。
- 安卓原生:根据文档添加依赖,具体步骤参照AndroidStudio接入文档
- Unity:将SDK的unitypackage文件导入项目,具体步骤参照Unity接入文档
- Cocos:将SDK提供的TopSDK.ts文件放到Cocos项目的asset目录下,具体步骤参照Cocos接入文档
- 服务端:提供了用户验证和支付回调验证接口,具体验证方式参照SDK开放服务接口文档
- iOS原生:可跳过此步骤
检查项:
- 检查SDK初始化接口调用时机是否在调用其他SDK接口前
- 检查SDK初始化传入的appId是否正确(使用平台参数中的appId)
Step6: 申请渠道参数
根据已确认需要接入的功能,申请对应的渠道参数,我们整理了部分渠道参数申请指南可供参考
各渠道所需参数如下(各渠道开放平台地址):
渠道 | 功能 | 安卓端参数/配置文件 | iOS端参数/配置文件 | 服务端参数/配置文件 |
---|---|---|---|---|
登录 | android类型OAuth client配置文件 Web类型OAuth client配置文件 | iOS类型OAuth client配置文件 | 无 | |
登录 | App_ID | display_name App_ID | 无 | |
apple | 登录 | 无 | 无 | 无 |
naver | 登录 | Client_ID Client_Secret Client_Name | Client_ID Client_Secret Client_Name Url_Scheme | 无 |
kakao | 登录 | Native app key url scheme | Native app key url scheme | 无 |
line | 登录 | Channel ID | Channel ID | 无 |
snapchat | 登录 | clientId redirectUrl | clientId redirectUrl | 无 |
登录 | api_key api_secret_key callback_url | api_key api_secret_key callback_url | 无 | |
google应用商店支付 | 支付 | 无 | 无 | 服务账号配置json文件 |
苹果应用商店支付 | 支付 | 无 | 无 | App 专用共享密钥 |
onestore商店支付 | 支付 | 无 | 无 | ONESTORE_KEY ONESTORE_KEY-secret |
Huawei应用商店支付 | 支付 | agconnect-services.json文件 | 无 | Client ID Client Secret |
Xiaomi应用商店支付 | 支付 | 无 | 无 | AppName App Id App Secret |
AppsFlyer | 数据 | dev_key | dev_key apple_app_id | 无 |
Firebase | 数据 | google-services.json配置文件 | GoogleService-Info.plist配置文件 | 无 |
检查项:
检查渠道参数是否获取完整(参照上表)
如果接入了Google登录,检查Google登录配置是否正确
- 检查 Google 后台
Configure your OAuth Client
是否创建Android、iOS、Web三种凭证 - 创建 Android 时,确保
package name
为游戏项目的包名;确保SHA-1 signing certificate
为游戏最终签名证书的sha-1
值 - 创建iOS时,确保Bundle ID 为游戏项目的Bundle ID
- 检查 Google 后台
如果接入了Google支付,检查Google支付配置是否正确
- API权限-已关联的Google Cloud项目,确保关联的项目为自己的游戏项目并且为开启状态
Google通用安卓签名配置检查
- 支付与登录的API密钥证书、应用的密钥证书、打包使用的证书,三个必须一致,否则会有无法登录与无法支付的问题
- 配置中涉及到填写
sha-1
值的地方,都要填写最终签名证书的sha-1值 - 不建议使用googleplay后台的签名托管服务,会导致签名混乱(如开启此服务后,操作不可逆)
Step7: Meetgames控制台填写渠道参数
登录Meetgames控制台 > 进入发行服务 > 聚合登录支付 > 渠道列表,选择对应渠道点击配置,进入渠道配置详情页
参数配置包括(各渠道开放平台地址)
配置 | 说明 | 文档 |
---|---|---|
登录方式配置 | 1.将申请的三方登录渠道参数,填写到对应登录方式参数配置处 2.确认登录方式展示顺序(默认为Apple(仅IOS端)、Guest、Google、Facebook) | 渠道参数申请指南 |
支付配置 | 1.配置发货地址(用于接收支付成功通知) 2.配置您申请的支付参数 | 接收发货通知 |
三方数据SDK配置 | 如需接入三放数据统计功能,请切换到三方数据SDK配置页进行配置 | |
协议配置 | 如需开启协议功能,请切换到协议配置页进行配置,建议至少提供服务协议和隐私政策。 |
开关配置包括
配置 | 说明 |
---|---|
游客支付开关 | 是否支持游客进行支付,默认为关闭 |
游客退出登录提醒开关 | 是否展示游客登出提醒绑定窗口,默认为开启 |
协议提醒开关 | 是否开启登录后提醒同意协议窗口,默认为开启(如需开启,请务必完成协议配置) |
静默登录开关 | 是否开启静默登录,默认为关闭(如需开启,请提供静默登录方式) |
欢迎提示开关 | 是否展示登录成功欢迎提示,默认为开启 |
检查项:
- 确认所有渠道参数配置无误
- 如果接入了支付功能,检查回调地址和支付参数是是否配置正确
- 确认在打包之前,已经完成TokSDK所有参数配置,并确保配置正确
Step8: 打包(此步骤为iOS平台需要)
iOS平台打包(详细步骤见:iOS自动接入工具使用说明)
- 导出Xcode工程后,运行SDK包中的打包工具TopSDKTool,并将平台参数(
appId
,appSecret
)正确填入后即可进行自动打包
检查项:
- iOS平台打包前确认打包环境是否为MacOS(iOS打包仅支持MacOS系统)
- 确认SDK包所在的路径是否包含特殊字符(路径必须为纯英文并无特殊字符,且不能包含空格)
- 确认所有渠道参数配置正确
- 如果已经接入过SDK并需重新接入/更新,请先将当前SDK资源从工程中移除后重新按照接入流程进行接入
Step9: 联调&测试
如需测试对应渠道的登录、支付、数据功能,请参照对应的开发文档:
常见渠道测试注意事项:
(1)Facebook登录:
- 在Facebook平台,如果应用属于未发布状态,需要添加测试账号
(2)Google支付测试:
- 进入应用版本-具体发布渠道(如Alpha版)-管理测试人员,可以修改、添加测试人员账号
- 将【加入测试的网址】分享给测试人员访问,二次确认后才可以真正加入测试
(3)Google沙盒支付配置:
- 在 Developer Console 中,转到 Settings > Account details,然后在 License Testing 部分将相应地址添加到 Gmail accounts with testing access 字段并保存
(4)隐私政策:
- 为避免《隐私政策》违反渠道规范导致功能被限制,请参照隐私政策进行对应修改
检查项:
- 建议使用海外机型进行测试,国内外机型存在较大差异,可能导致测试结果不准确(如:国内机型安装google框架存在稳定性问题从而导致google功能使用异常)
- 安装到设备上用于测试的apk包可以和上传到Google Play的不同,但要保证这两个APK包使用相同的包名、签名、versionCode
- 测试时使用的网络环境所属的国家和地区要在应用发布的国家或者地区范围内