小程序小游戏(广告&账号)客户端 API

更新时间:
复制 MD 格式

账号

通过 my.getAuthCode 直接获取 openId(用户唯一 ID)。

my.getAuthCode({
  scopes: 'auth_base',//建议使用默认授权方式
  success: res => {
    const openId = res.openId;
    const token = res.token;
  },
  fail: err => {
    console.log('my.getAuthCode 调用失败', err)
  }
});

广告

my.createRewardedAd

创建全屏广告实例,每次调用该方法都会返回一个全新的实例。

入参

Object object

属性

类型

默认值

必填

描述

adUnitId

String

-

是

广告位 ID,业务自定义即可,不同位置广告区分开即可。

返回值

返回 RewardedAd 实例对象。

const ctx = my.createRewardedAd({
  adUnitId: 'TEST_VIDEO', // 广告单元 ID
});
// 监听广告关闭事件
ctx.onClose((res) => {
  if (res.isEnded) {
    console.log('用户完整观看了广告');
  }
});

支付

my.requestGamePayment

小游戏发起支付。

重要
  • Android 和 iOS 均支持。

  • 由于前端环境存在不确定性,可能无法准确获取支付最终状态。为确保数据一致性并避免“掉单”,请务必结合 服务端 接口查询支付结果,以服务端返回状态为准。

入参

Object object

属性

类型

默认值

必填

描述

customId

String

-

是

游戏开发者自定义的唯一订单号,订单支付成功后通过 服务端 支付结果回调回传,必须具有唯一性,如果不传或重复传相同值,则会报错。

buyQuantity

Number

-

是

道具价格(单位:分)。

itemId

String

-

是

对应价格的商品 ID (提前创建好提供)。

success

Function

-

否

调用成功的回调函数。

fail

Function

-

否

调用失败的回调函数。

complete

Function

-

否

调用结束的回调函数(调用成功/失败均执行)。

success 回调函数

参数

Object res

属性

类型

描述

resultCode

string

结果码。9000 即表示订单处理成功。

重要

请勿仅依据 my.requestGamePayment 的同步返回结果(包括状态码 9000)判定充值成功。为防止出现 掉单 现象,务必以 服务端 回调或订单查询接口的最终结果为准。

系统信息

my.getSystemInfoSync

同步获取手机系统信息的同步接口。

返回值

属性

类型

描述

pixelRatio

Number

设备像素比

screenHeight

Number

屏幕高度。单位:px。

screenWidth

Number

屏幕宽度。单位:px。

windowWidth

Number

可使用窗口宽度。单位:px

windowHeight

Number

可使用窗口高度。 单位:px

model

String

手机型号

system

String

系统版本

platform

String

客户端平台:Android,iOS

language

String

支付宝设置的语言。

枚举值

  • zh-Hans 简体中文

  • en 英文

  • zh-Hant 繁体中文(台湾)

  • zh-HK 繁体中文(香港)

version

String

支付宝客户端版本号

isIphoneXSeries

Boolean

是否 iphoneX 系列

代码示例

const systemInfo = my.getSystemInfoSync();
console.log("getSystemInfoSync:"+JSON.stringify(systemInfo));