SDK接入(重要)

概述

在接入天幕SDK前请做好以下准备:

  1. 是否有天幕账号,若无,请先注册天幕账号,已有账号请登录;

  2. 添加游戏,在控制台页面可见当前账号已加入的主体,请进入对应主体中的【游戏管理】后台进行添加。

下面对接入流程进行详细说明,共有两个步骤,十分钟左右即可搞定SDK接入。

Step1.下载SDK

在【游戏管理】页面,点击操作中的【下载/接入SDK】开始接入

天幕提供了登录以及无登录两种版本SDK文件

登录功能版SDK由天幕集成封装OPPO登录功能,可供开发者调用,接入后才可以使用天幕的所有功能,蓝色的下载按钮即可下载此版本SDK。

无登录功能版SDK需要由开发者自行接入OPPO登录并发送uid提供给天幕方可使用天幕的功能。蓝色按钮下方的文字按钮即可下载此版本SDK。 无登录版天幕SDK接入说明请见下方

请勿多个游戏使用同一个SDK,每个游戏会对应一个单独的SDK文件;

如果接入时报错:小程序session解析错误

请检查接入的SDK与小游戏本身是否对应(SDK及SDK所在项目的appid/secretkey,与小游戏实际是否一致)

Step2.接入SDK

1、所有版本SDK接入流程说明

小游戏引入SDK时请务必注意如下事项:

  • SDK必须放在主包中加载,切勿分包加载(在game.js 中第一行引入sdk文件)

  • 在laya引擎中,文件名必须为.min.js结尾,否则会导致编译报错

  • 请开发者在游戏中在合理时机尽快触发登录(.login),否则因未获取用户uid导致天幕所有功能无法使用

将下载的sdk文件放置到小游戏工程中,在小游戏game.js中引入SDK,并在需要使用sdk功能的地方调用。

请注意:

  • 在cocos引擎中,如果打包之前没有game.js文件,则只需将SDK文件放在主包中一起打包,这样就可以直接调用了,无需引入SDK文件(还可以在qg.d.ts中定义tmSDK变量)

植入方式

  • TypeScript或ES6 JavaScript语法植入方式:import 'tm_sdk_oppo.min.js';

  • ES5 JavaScript使用commonJs规范的植入方式:require('tm_sdk_oppo.min.js');

2、无登录版SDK使用说明

以下流程仅使用了无登录版SDK的开发者需要阅读。

  1. 下载无登录版本的SDK,在接入该SDK后,开发者需要自行接入OPPO登录流程并获取playerId

  2. SDK初始化

  3. 开发者通过自己的服务端接口获取到playerId后调用SDK接口,发送playerId。(若不发送playerId将导致天幕功能无法使用

hbs.tmSDK.sendUserInfo({ openId: '开发者传入从华为中获取的用户playerId', gender: 1 }); 
// gender可选传入,默认值为1,默认代表男生 

强烈建议在登录获取到playerId以后第一时间发送给天幕,避免数据统计、买卖量助手等功能出现异常。

获取playerId接口:https://developer.huawei.com/consumer/cn/doc/development/quickApp-References/quickgame-api-account#gameLogin

【注意事项】

1、 无登录版本SDK,以下接口或功能无法使用

  • .login(天幕-登录/获取用户信息)

  • .updateUserInfo(天幕更新用户信息)

2、无playerId无法使用数据统计功能、买量助手功能,请接入SDK后及时发送playerId避免数据统计、买卖量助手等功能无法使用或功能异常。

最后更新于