微信小程序开发文档 第45页
analysis.getDailyRetain 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 获取用户访问小程序日留存 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyretaininfo?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 begin_date string 是 开始日期。格式为 yyyymmdd end_date string 是 结束日期,限定查询1天数据,允许设置的最大值为昨日。格式为 yyyymmdd 返回值 Object 返回的 JSON 数据包 属性 类型 说明 ref_date string 日期 visit_uv_new Object 新增用户留存 visit_uv Object 活跃用户留存 visit_uv_new 的结构 属性 类型 说明 key number 标识,0开始,表示当天,1表示1天后。依此类推,key取值分别是:0,1,2,3,4,5,6,7,14,30 value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时) visit_uv 的结构 属性 类型 说明 key number 标识,0开始,表示当天,1表示1天后。依此类推,key取值分别是:0,1,2,3,4,5,6,7,14,30 value number key对应日期的新增用户数/活跃用户数(key=0时)或留存用户数(k>0时) 请求数据示例 { "begin_date" : "20170313", "end_date" : "20170313" } 返回数据示例 { "ref_date": "20170313", "visit_uv_new": [ { "key": 0, "value": 5464 } ], "visit_uv": [ { "key": 0, "value": 55500 } ] } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.analysis.getDailyRetain 需在 config.json 中配置 analysis.getDailyRetain API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 beginDate string...
auth.getPaidUnionId 本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载) wx-server-sdk >= 0.4.0 用户支付完成后,获取该用户的 UnionId,无需用户授权。本接口支持第三方平台代理查询。 注意:调用前需要用户完成支付,且在支付后的五分钟内有效。 调用方式: HTTPS 调用 云调用 HTTPS 调用 请求地址 GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 openid string 是 支付用户唯一标识 transaction_id string 否 微信支付订单号 mch_id string 否 微信支付分配的商户号,和商户订单号配合使用 out_trade_no string 否 微信支付商户订单号,和商户号配合使用 返回值 Object 返回的 JSON 数据包 属性 类型 说明 unionid string 用户唯一标识,调用成功后返回 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 -1 系统繁忙,此时请开发者稍候再试 0 请求成功 40003 openid 错误 89002 没有绑定开放平台帐号 89300 订单无效 使用说明 以下两种方式任选其一。 微信支付订单号(transaction_id): https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&transaction_id=TRANSACTION_ID 微信支付商户订单号和微信支付商户号(out_trade_no 及 mch_id): https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&mch_id=MCH_ID&out_trade_no=OUT_TRADE_NO 返回数据示例 { "unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk", "errcode": 0, "errmsg": "ok" } 云调用 云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。 接口方法 openapi.auth.getPaidUnionId 需在 config.json 中配置 auth.getPaidUnionId API 的权限,详情 请求参数 属性 类型 默认值 必填 说明 openid string 是 支付用户唯一标识 transactionId string 否 微信支付订单号 mchId string 否 微信支付分配的商户号,和商户订单号配合使用 outTradeNo string 否 微信支付商户订单号,和商户号配合使用...
wx.navigateBack(Object object) 关闭当前页面,返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈,决定需要返回几层。 参数 Object object 属性 类型 默认值 必填 说明 delta number 1 否 返回的页面数,如果 delta 大于现有页面数,则返回到首页。 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 // 注意:调用 navigateTo 跳转时,调用该方法的页面会被加入堆栈,而 redirectTo 方法则不会。见下方示例代码 // 此处是A页面 wx.navigateTo({ url: 'B?id=1' }) // 此处是B页面 wx.navigateTo({ url: 'C?id=1' }) // 在C页面内 navigateBack,将返回A页面 wx.navigateBack({ delta: 2 })
wx.navigateTo(Object object) 保留当前页面,跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 wx.navigateBack 可以返回到原页面。小程序中页面栈最多十层。 参数 Object object 属性 类型 默认值 必填 说明 url string 是 需要跳转的应用内非 tabBar 的页面的路径 (代码包路径), 路径后可以带参数。参数与路径之间使用 ? 分隔,参数键与参数值用 = 相连,不同参数用 & 分隔;如 ‘path?key=value&key2=value2’ events Object 否 页面间通信接口,用于监听被打开页面发送到当前页面的数据。基础库 2.7.3 开始支持。 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) object.success 回调函数 参数 Object res 属性 类型 说明 eventChannel EventChannel 和被打开页面进行通信 示例代码 wx.navigateTo({ url: 'test?id=1', events: { // 为指定事件添加一个监听器,获取被打开页面传送到当前页面的数据 acceptDataFromOpenedPage: function(data) { console.log(data) }, someEvent: function(data) { console.log(data) } ... }, success: function(res) { // 通过eventChannel向被打开页面传送数据 res.eventChannel.emit('acceptDataFromOpenerPage', { data: 'test' }) } }) //test.js Page({ onLoad: function(option){ console.log(option.query) const eventChannel = this.getOpenerEventChannel() eventChannel.emit('acceptDataFromOpenedPage', {data: 'test'}); eventChannel.emit('someEvent', {data: 'test'}); // 监听acceptDataFromOpenerPage事件,获取上一页面通过eventChannel传送到当前页面的数据 eventChannel.on('acceptDataFromOpenerPage', function(data) { console.log(data) }) } })
wx.redirectTo(Object object) 关闭当前页面,跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。 参数 Object object 属性 类型 默认值 必填 说明 url string 是 需要跳转的应用内非 tabBar 的页面的路径 (代码包路径), 路径后可以带参数。参数与路径之间使用 ? 分隔,参数键与参数值用 = 相连,不同参数用 & 分隔;如 ‘path?key=value&key2=value2’ success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.redirectTo({ url: 'test?id=1' })
wx.reLaunch(Object object) 基础库 1.1.0 开始支持,低版本需做兼容处理。 关闭所有页面,打开到应用内的某个页面 参数 Object object 属性 类型 默认值 必填 说明 url string 是 需要跳转的应用内页面路径 (代码包路径),路径后可以带参数。参数与路径之间使用?分隔,参数键与参数值用=相连,不同参数用&分隔;如 ‘path?key=value&key2=value2’ success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 wx.reLaunch({ url: 'test?id=1' }) // test Page({ onLoad (option) { console.log(option.query) } })
wx.switchTab(Object object) 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面 参数 Object object 属性 类型 默认值 必填 说明 url string 是 需要跳转的 tabBar 页面的路径 (代码包路径)(需在 app.json 的 tabBar 字段定义的页面),路径后不能带参数。 success function 否 接口调用成功的回调函数 fail function 否 接口调用失败的回调函数 complete function 否 接口调用结束的回调函数(调用成功、失败都会执行) 示例代码 { "tabBar": { "list": [{ "pagePath": "index", "text": "首页" },{ "pagePath": "other", "text": "其他" }] } } wx.switchTab({ url: '/index' })
wx.createWorker(scriptPath) 基础库 1.9.90 开始支持,低版本需做兼容处理 在使用 createWorker 前,请查阅 多线程 文档了解基础知识和配置方法。 创建一个 Worker 线程,并返回 Worker 实例,目前限制最多只能创建一个 Worker,创建下一个 Worker 前请调用 Worker.terminate。 scriptPath 为 worker 的入口文件路径,需填写绝对路径。 Worker Worker 对象的方法列表: 方法 参数 说明 postMessage Object 向 Worker 线程发送的消息。 onMessage callback 监听 Worker 线程向当前线程发送的消息 terminate 结束当前 Worker 线程,仅限在主线程 Worker 实例上调用。 postMessage(message) 说明: 向 Worker 线程发送消息,message 参数为需要发送的消息,必须是一个可序列化的 JavaScript 对象。 onMessage(callback) 回调结果说明: 属性 类型 说明 message Object Worker 线程向当前线程发送的消息 terminate() 说明: 结束当前 worker 线程,仅限在主线程 Worker 对象上调用。 示例代码: 运行以下代码需先进行基础配置,详细请查阅 多线程 文档了解基础知识和配置方法。 const worker = wx.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径,绝对路径 worker.onMessage(function (res) { console.log(res) }) worker.postMessage({ msg: 'hello worker' }) worker.terminate()
wx.arrayBufferToBase64(arrayBuffer) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 将 ArrayBuffer 数据转成 Base64 字符串 示例代码 const arrayBuffer = new Uint8Array([11, 22, 33]) const base64 = wx.arrayBufferToBase64(arrayBuffer) wx.base64ToArrayBuffer(base64) 基础库版本 1.1.0 开始支持,低版本需做兼容处理 将 Base64 字符串转成 ArrayBuffer 数据 示例代码 const base64 = 'CxYh' const arrayBuffer = wx.base64ToArrayBuffer(base64)
wx.reportAnalytics(eventName, data) 自定义分析数据上报接口。使用前,需要在小程序管理后台自定义分析中新建事件,配置好事件名与字段。 参数说明: 参数 类型 必填 说明 eventName String 是 事件名。 data Object 是 上报的自定义数据。key为配置中的字段名,value为上报的数据 示例代码: wx.reportAnalytics('purchase', { price: 120, color: 'red' })