北京动漫游戏产业协会发布ICS35.020 L79 HTML5游戏引擎平台对接接口 HTML5gameengineplatformdockinginterface 2019－09－03发布 2019－09－03实施团 体 标 准 T/BAGIA0004—2019 全国团体标准信息平台 T/BAGIA0004—2019 I目录 前言.......................................................................................................................................................................Ⅱ 引言.......................................................................................................................................................................Ⅲ 1范围......................................................................................................................................................................1 2术语和定义.........................................................................................................................................................1 3联机游戏登陆流程.............................................................................................................................................1 4基本API规范...................................................................................................................................................2 全国团体标准信息平台 T/BAGIA0004—2019 II前言 本标准按照GB/T1.1-2009《标准化工作导则第1部分：标准的结构和编写》给出的规则起 草。 请注意本文件的某些内容可能涉及专利。北京动漫游戏产业协会标准化工作委员会不承担识别 这些专利的责任。 本标准由北京动漫游戏产业协会标准化工作委员会提出并归口。 本标准起草单位：北京动漫游戏产业协会、北京触控科技有限公司、厦门雅基软件有限公司、 北京白鹭时代信息技术有限公司、搜游网络科技(北京)有限公司。 本标准主要起草人：林顺、魏超、姜芝菡、李明、王亚伟、申鹰歌、温向东、杨行、鲁海东、 刘春刚、汪家莹等。 本标准由北京动漫游戏产业协会负责解释。 全国团体标准信息平台 T/BAGIA0004—2019 III引言 HTML5游戏引擎平台对接接口标准，涉及HTML5游戏开发调用平台功能接口方案，主要是 服务行业游戏内容生产厂商。该技术标准的制定，可使游戏内容生产厂商只需按照此标准接口开发 流量平台的对接功能，即可使用遵从此标准的引擎，将产品发布到各个流量平台，极大地降低开发 风险和开发成本，标准的推行可使游戏内容生产更加规范高效，也使流量平台可以更好的获取优质 产品，促进游戏产业健康发展。 全国团体标准信息平台 T/BAGIA0004—2019 1HTML5游戏引擎平台对接接口 1范围 本标准规定了HTML5游戏引擎平台功能对接部分功能。主要包括术语和定义、联机游戏登陆流程 和基本API规范。 本标准适用于对外提供的接口调用。 2术语和定义 下列术语和定义适用于本文件。 2.1登录凭证Code 服务端通过登录凭证可换取用户信息以及用户在平台方的唯一标识（openid）。 2.2生命周期Activity 平台环境下游戏运行时执行的行为阶段。 2.3回调函数Callback 在调用接口时传入一个函数，当接口执行完后，传入的函数会被调用，用来完成某些任务，该函数 称为回调函数。 2.4场景Scene 游戏处于某种状态。 2.5符号、代号和缩略语 符号、代号和缩略语见表1。 表1 缩略语 符号、代号 登陆凭证 Code 用户唯一标识 openid 应用程序接口 API 3联机游戏登陆流程 联机游戏登录完整流程见图1。 全国团体标准信息平台 T/BAGIA0004—2019 2 图1 4.基本API规范 4.1登录相关函数 4.1.1game.login(Objectobject) 调用接口获取登录凭证（code）。 参数：Objectobject 属性 类型 必填说明 successfunction否 接口调用成功的回调函数 fail function否 接口调用失败的回调函数 completefunction否 接口调用结束的回调函数（调用成功、失败都会执行） success回调函数返回参数Objectres 属性 类型 说明 errMsgstring 接口返回状态码 code string 开发者后台获取用户信息凭证 示例代码： 全国团体标准信息平台 T/BAGIA0004—2019 3game.login({ success:function(res){ if(res.code){ console.log('登录成功'+res.code) }else{ console.log('登录失败！'+res.errMsg) } } }) 4.1.2game.checkSession(Objectobject) 检查登录态是否过期。 参数：Objectobject 属性 类型 必填 说明 successfunction否 接口调用成功的回调函数 fail function否 接口调用失败的回调函数 completefunction否 接口调用结束的回调函数（调用成功、失败都会执行） 示例代码： game.checkSession({ success(){ //session_key未过期，并且在本生命周期一直有效 }, fail(){ //session_key已经失效，需要重新执行登录流程 } }) 4.2用户信息相关内容 4.2.1game.getUserInfo(Objectobject) 获取用户信息。 参数：Objectobject 属性 类型 必填说明 successfunction否接口调用成功的回调函数 fail function否接口调用失败的回调函数 全国团体标准信息平台 T/BAGIA0004—2019 4completefunction否接口调用结束的回调函数（调用成功、失败都会执行） success回调函数返回参数Objectres 属性 类型 说明 userInfoUserInfo 用户信息对象，不包含openid等敏感信息 rawDatastring 不包括敏感信息的原始数据字符串，用于计算签名 示例代码： game.getUserInfo({ success:function(res){ constuserInfo=res.userInfo constnickName=userInfo.nickName constavatarUrl=userInfo.avatarUrl constgender=userInfo.gender constprovince=userInfo.province constcity=userInfo.city constcountry=userInfo.country } }) 4.2.2[UserInfoButton]game.createUserInfoButton(Objectobject) 创建用户信息按钮。 参数：Objectobject 属性 类型必填说明 type string是按钮的类型 text string否按钮上的文本，仅当type为text时有效 imagestring否按钮的背景图片，仅当type为image时有效 styleObject是按钮的样式 type的合法值 值 说明 text 可以设置背景色和文本的按钮 image只能设置背景贴图的按钮，背景贴图会直接拉伸到按钮的宽高 style的结构 全国团体标准信息平台 T/BAGIA0004—2019 5属性 类型 默认值必填说明 left number 是左上角横坐标 top number 是左上角纵坐标 width number 是宽度 height number 是高度 backgroundColorstring 是背景颜色 borderColor string 是边框颜色 borderWidth number 是边框宽度 borderRadius number 是边框圆角 textAlign string 是文本的水平居中方式 fontSize number 是字号 lineHeight number 是文本的行