data.md 7.29 KB

cddb4710521885893675e11407622e690d1532fb/inner/data.md#">数据模块


cddb4710521885893675e11407622e690d1532fb/inner/data.md#">简介

此模块为开发者提供游戏用到的一些数据信息,例如:config.js配置的GameId,ChannelId、从分享链接进入query携带的参数(share_id/share_key/user_invite_uid/channel_id)、setLogind设置的用户ID(userId)和用户注册时间(regTime)等等,详细请阅读下面的api。

API:

名称 功能说明
PCSDK.data.GameId 获取游戏的GameId,来源于config.js配置的GameId
PCSDK.data.ChannelId 获取游戏渠道ID,来源于config.js配置的ChannelId
PCSDK.data.UserId 获取用户ID,setLoginInfo传递的openId的值
PCSDK.data.RegTime 获取用户注册时间,setLoginInfo传递的regTime的值
PCSDK.data.ShareId 获取进入游戏的分享会话ID,不是从分享会话进入ShareId为0
PCSDK.data.ShareKey 接入SDK的分享视频模块后,从分享会话进去游戏,获取到分享会话的分享key
PCSDK.data.Platform 获取游戏运行平台环境,字符串形式:devtools、ios、android。devtools(开发者调试工具)、ios(苹果设备)、android(安卓设备)
PCSDK.data.SystemId 获取游戏运行平台环境,整数形式:0、1。0(开发者调试工具或ios)、1(安卓设备)
PCSDK.data.QueryUserInviteUid 获取此次分享会话进入游戏,分享来源者用户ID
PCSDK.data.IsCross 获取是否显示/隐藏悬浮框交叉推广位,true:显示,false:隐藏
PCSDK.data.IsDrawer 获取是否显示/隐藏抽屉式交叉推广位,true:显示,false:隐藏
PCSDK.data.IsGuessLike 获取是否显示/隐藏猜你喜欢交叉推广位,true:显示,false:隐藏
  1. ##### GameId
   PCSDK.data.GameId: number

定义:获取游戏的GameId,该值来源于congfig.js中的【GameId】配置。详细阅读config.js的GameId参数详解

示例:

    let gameId = PCSDK.data.GameId;
  1. ##### ChannelId
   PCSDK.data.ChannelId: number

定义:获取游戏的渠道Id,该值来源于congfig.js中的【ChannelId】配置。详细阅读config.js的ChannelId参数详解

示例:

    let channelId = PCSDK.data.ChannelId;
  1. ##### UserId
   PCSDK.data.UserId: number | string

定义:获取用户ID,该值来源于启动打点setLoginInfo设置的openId

示例:

    let userId = PCSDK.data.UserId;
  1. ##### RegTime
   PCSDK.data.RegTime: number

定义:获取用户第一次创角的时间戳,该值来源于启动打点setLoginInfo设置的regTime

示例:

    let regTime = PCSDK.data.RegTime;
  1. ##### ShareId
   PCSDK.data.ShareId: number

定义:接入SDK的分享视频模块,分享出去的链接query会携带share_id参数,从分享会话点入游戏,获取此次分享会话的shareId,不是从分享会话点入游戏ShareId为0

示例:成功结算奖励双倍分享,后台配置的信息:shareId: 680 shareKey: success_double,其他用户从此条分享进入 引入目录

    // shareId的值为:680
    let shareId = PCSDK.data.ShareId;
  1. ##### ShareKey
   PCSDK.data.ShareKey: string

定义:接入SDK的分享视频模块,分享出去的链接query会携带share_key参数,从分享会话点入游戏,获取此次分享会话的shareKey,不是从分享会话点入游戏ShareKey为''

示例:成功结算奖励双倍分享,后台配置的信息:shareId: 680 shareKey: success_double,其他用户从此条分享进入 引入目录

    // shareKey的值为:success_double
    let shareKey = PCSDK.data.ShareKey;
  1. ##### Platform
   PCSDK.data.Platform: string

定义:获取游戏运行平台环境:devtools(开发者调试工具)、ios(苹果设备)、android(安卓设备)

示例:

    let platform = PCSDK.data.Platform;
    switch (platform) {
        case 'devtools':    // 开发者工具

            break;

        case 'ios':         // 苹果设备

            break;

        case 'android':     // 安卓设备

            break;
    }
  1. ##### SystemId
   PCSDK.data.SystemId: number

定义:获取游戏运行平台环境:0(开发者调试工具或ios)、1(安卓设备)

示例:

    let systemId = PCSDK.data.SystemId;
    switch (systemId) {
        case 0:     // 开发者工具 or 苹果设备

            break;

        case 1:     // 安卓设备

            break;
    }
  1. ##### QueryUserInviteUid
    PCSDK.data.QueryUserInviteUid: any

定义:获取此次分享会话进入游戏,分享来源者用户userId

接入SDK的分享视频模块,分享出去的链接query会携带invite_user_uid参数,从分享会话点入游戏,获取此次分享会话的邀请者id: invite_user_uid,不是从分享会话点入游戏QueryUserInviteUid为0。

开发者不接入SDK分享视频模块,游戏分享url的query参数必须要加入以下两个参数channel_id与user_invite_uid:channel_id的值通过ChannelId api获取,user_invite_uid的值可通过UserId api获取,也可以开发者从游戏中得到。 每次分享query请携带:

    `channel_id=${ PCSDK.data.ChannelId }&user_invite_uid=${ PCSDK.data.UserId }`
示例:
    // 从分享会话邀请链接进入,获得的值为邀请者用户id,不是分享会话邀请进入获取值为0
    let inviteUid = PCSDK.data.QueryUserInviteUid;
  1. ##### IsCross
   PCSDK.data.IsCross: boolean

定义:获取是否显示/隐藏交叉悬浮框推广位,true:显示,false:隐藏

示例:获取是否显示交叉悬浮框推广位

    // 设置交叉悬浮框推广位ui的显示隐藏
    let isShow = PCSDK.data.IsCross;
    this.uiCross.visible = isShow;
  1. ##### IsDrawer
   PCSDK.data.IsDrawer: boolean

定义:获取是否显示/隐藏交叉抽屉推广位,true:显示,false:隐藏

示例:

    // 设置交叉抽屉推广位ui的显示隐藏
    let isShow = PCSDK.data.IsDrawer;
    this.uiDrawer.visible = isShow;
  1. ##### IsGuessLike
   PCSDK.data.IsGuessLike: boolean

定义:获取是否显示/隐藏交叉猜你喜欢推广位,true:显示,false:隐藏

示例:

    // 设置交叉猜你喜欢推广位ui的显示隐藏
    let isShow = PCSDK.data.IsGuessLike;
    this.uiGuessLike.visible = isShow;