文档管理中心
API参考快游戏快游戏开放能力账号

账号

注意

该功能依赖 Game SDK 提供服务,Game SDK 可能会收集用户的个人数据。请在快游戏中使用该功能之前,告知用户将收集个人数据,并引导用户阅读相应的隐私政策。

说明

从1078版本开始,接口前缀由hbs调整为qg,原hbs仍支持。

接口定义

展开

接口

描述

qg.gameLogin(Object object)

游戏登录。

qg.gameLoginWithReal(Object object)(1070+)

实现游戏防沉迷登录接口。

qg.savePlayerInfo(Object object)

当用户完成选择区服信息进入游戏后,或者用户的等级发生变化时,游戏可以调用此接口存储用户的角色信息。如果游戏本身不具有游戏等级、角色名称、游戏区服或者游戏公会这些信息则可以不接入此接口。

qg.savePlayerInfoWithReal(Object object)(1070+)

存储用户角色信息。

qg.getCachePlayerId(Object object)(1070+)

获取账户ID。

qg.gameLogin(Object object)

  • 描述

    游戏登录。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    forceLogin

    int

    M

    此参数固定传入“1”,将在玩家未登录华为账号或鉴权失败时主动打开登录页面。

    appid

    string

    M

    在华为开发者联盟上创建快游戏后分配的唯一标识。获取方式请参见获取APP ID

    success

    function

    O

    接口调用成功的回调函数,code为0时表示成功,请参见success回调函数参数

    说明

    登录成功后建议调用校验登录签名接口对登录结果进行校验。

    fail

    function

    O

    接口调用失败的回调函数,返回失败原因,请参见fail回调函数参数

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      playerId

      String

      账号ID,如果游戏不需要华为账号的登录结果进行鉴权,那么当返回playerId的时候就可以使用该值进入游戏。

      displayName

      string

      用户的昵称。

      playerLevel

      integer

      玩家等级。

      isAuth

      integer

      当isAuth为1的时候,应用需要校验返回的参数鉴权签名。

      ts

      string

      时间戳,用于鉴权签名校验。

      gameAuthSign

      string

      玩家的登录签名,用于应用服务端调用校验登录签名接口时,向华为发起登录签名验证。

    • fail回调函数参数
      展开

      参数

      类型

      说明

      code

      number

      返回状态码。code为0时表示成功,其他状态码请参见状态码

      常见错误码处理方式:

      注意

      除了正常登录成功,还必须对弹出登录界面,用户取消登录的场景(错误码7004或2012)做处理,建议返回游戏界面,提供玩家“重新登录”或者“退出游戏”的选择。

      data

      string

      异常时返回的消息内容。

  • 状态码
    展开

    类型

    描述

    通用错误码

    参见通用错误码

    业务错误码

    参见游戏错误码账号错误码

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.gameLogin({
    2. forceLogin:1,
    3. appid:"100453595",
    4. success:function(data){
    5. console.log("Game login success:" + data);
    6. qg.savePlayerInfo({
    7. appid:"100453595",
    8. area:"cn",
    9. rank:"1",
    10. role:"a",
    11. sociaty:"1",
    12. success:function(data){console.log("Save player info success:" + data);},
    13. fail:function(data,code){console.log("Save player info fail:" + data + ", code:" + code);}
    14. });
    15. },
    16. fail:function(data,code){console.log("Game login fail:" + data + ", code:" + code);}
    17. });

qg.gameLoginWithReal(Object object)(1070+)

  • 描述

    根据国家要求对未成年人的游戏时间进行防沉迷监控。调用此接口实现游戏登录即可接入防沉迷的能力。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    forceLogin

    int

    M

    此参数固定传入“1”,将在玩家未登录华为账号或鉴权失败时主动打开登录页面。

    appid

    string

    M

    在华为开发者联盟上创建快游戏后分配的唯一标识。获取方式请参见获取APP ID

    success

    function

    O

    接口调用成功的回调函数,code为0时表示成功,请参见success回调函数参数

    fail

    function

    O

    接口调用失败的回调函数,返回失败原因,请参见fail回调函数参数

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      playerId

      string

      账号ID,如果游戏不需要华为账号的登录结果进行鉴权,那么当返回playerId的时候就可以使用该值进入游戏。

      displayName

      string

      用户的昵称。

      playerLevel

      integer

      玩家等级。

      ts

      string

      时间戳,用于鉴权签名校验。

      gameAuthSign

      string

      鉴权签名。

      hiResImageUri

      string

      高清头像链接,假如没有设置则为空字符串。

      imageUri

      string

      头像链接,假如没有设置则为空字符串。

    • fail回调函数参数
      展开

      参数

      类型

      说明

      code

      number

      返回状态码,具体请参见状态码

      常见错误码处理方式:

      注意

      除了正常登录成功,还必须对弹出登录界面,用户取消登录的场景(错误码7004或者2012)做处理,建议返回游戏界面,提供玩家“重新登录”或者“退出游戏”的选择。

      data

      string

      异常时返回的消息内容。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.gameLoginWithReal({
    2. forceLogin:1,
    3. appid:"100**95",
    4. success:function(data){
    5. console.log("Game login success:" + data);
    6. qg.savePlayerInfoWithReal({
    7. rank:"1",
    8. role:"a",
    9. area:"cn",
    10. sociaty:"1",
    11. success:function(data){console.log("save player info with real success:" + data);},
    12. fail:function(data,code){console.log("save player info with real fail:" + data + ", code:" + code);}
    13. });
    14. },
    15. fail:function(data,code){console.log("game login with real fail:" + data + ", code:" + code);}
    16. });

qg.savePlayerInfo(Object object)

  • 描述

    当用户完成选择区服信息进入游戏后,或者用户的等级发生变化时,游戏可以调用此接口存储用户的角色信息。如果游戏本身不具有游戏等级、角色名称、游戏区服或者游戏公会这些信息则可以不接入此接口。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    appid

    string

    M

    在华为开发者联盟上创建快游戏后分配的唯一标识。获取方式请参见获取APP ID

    rank

    string

    O

    游戏等级:当前玩家在游戏中的等级,需要和玩家在游戏中实际等级保持一致。

    role

    string

    O

    角色名称:玩家在游戏中创建的角色名称,需要和玩家在游戏中的实际角色名称保持一致,如果没有角色名称可不设置此属性。

    area

    string

    O

    游戏区服:玩家登录游戏时选择的区服,需要和玩家实际进入游戏区服名称保持一致,如果没有区服信息可不设置此属性。

    sociaty

    string

    O

    游戏公会:玩家在游戏中所属公会,如果没有加入公会可不设置此属性。

    success

    function

    O

    接口调用成功的回调函数,返回Int类型的retCode状态码。

    fail

    function

    O

    接口调用失败的回调函数。

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.savePlayerInfo({
    2. appid:"100453595",
    3. area:"cn",
    4. rank:"1",
    5. role:"a",
    6. sociaty:"1",
    7. success:function(data){console.log("Save player info success:" + data);},
    8. fail:function(data,code){console.log("Save player info fail:" + data + ", code:" + code);}
    9. });

qg.savePlayerInfoWithReal(Object object)(1070+)

  • 描述

    当用户完成选择区服信息进入游戏后,或者用户的等级发生变化时,游戏可以调用此接口存储用户的角色信息。如果游戏本身不具有游戏等级、角色名称、游戏区服或者游戏公会这些信息则可以不接入此接口。该接口后续将代替 qg.savePlayerInfo。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    rank

    string

    O

    游戏等级:当前玩家在游戏中的等级,需要和玩家在游戏中实际等级保持一致。

    role

    string

    O

    角色名称:玩家在游戏中创建的角色名称,需要和玩家在游戏中的实际角色名称保持一致,如果没有角色名称可不设置此属性。

    area

    string

    O

    游戏区服:玩家登录游戏时选择的区服,需要和玩家实际进入游戏区服名称保持一致,如果没有区服信息可不设置此属性。

    sociaty

    string

    O

    游戏公会:玩家在游戏中所属公会,如果没有加入公会可不设置此属性。

    success

    function

    O

    接口调用成功的回调函数,请参见success回调函数参数

    fail

    function

    O

    接口调用失败的回调函数,请参见fail回调函数参数

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      code

      Integer

      返回状态码,code为0时表示成功,其他状态码请参见状态码

    • fail回调函数参数
      展开

      参数

      类型

      说明

      code

      Integer

      返回状态码,具体请参见状态码

      data

      String

      异常时返回的消息内容。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.savePlayerInfoWithReal({
    2. area: "cn-1", // 玩家区服信息
    3. rank: "100", // 玩家等级
    4. role: "A11", // 角色名称
    5. sociaty: "ss", // 游戏公会
    6. success: function (res) {
    7. console.log("save player info success");
    8. that.getLabel.string = "保存玩家信息成功"+res.code;
    9. },
    10. fail: function (data, code) {
    11. console.log("save player info fail:" + data + ", code:" + code);
    12. that.getLabel.string = data + "," + code;
    13. }
    14. });

qg.getCachePlayerId(Object object)(1070+)

  • 描述

    获取玩家账户ID。

  • 参数
    展开

    参数

    类型

    必填(M)/选填(O)

    说明

    success

    function

    O

    接口调用成功的回调函数,code为0时表示成功,请参见success回调函数参数

    fail

    function

    O

    接口调用失败的回调函数,请参见fail回调函数参数

    complete

    function

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      playerId

      string

      玩家账户ID,不同华为账号登录游戏成功后返回的玩家账户ID。

    • fail回调函数参数
      展开

      参数

      类型

      说明

      code

      number

      返回状态码,具体请参见状态码

      data

      string

      异常时返回的消息内容。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.getCachePlayerId({
    2. success: function (res) {
    3. console.log("game getCachePlayerId: success"+res.playerId);
    4. },
    5. fail(data, code) {
    6. console.log("on gameLoginWithReal fail: " + data + "," + code);
    7. },
    8. complete() {
    9. console.log("on gameLoginWithReal: complete");
    10. }
    11. });

相关链接

搜索
请输入您想要搜索的关键词