星驿付微信小程序广告 SDK 接入文档

1. 概述

本 SDK 提供 H5 广告和半屏小程序广告两种广告形式的接入能力，支持在小程序内快速集成广告功能，符合微信官方广告规范。其中，半屏小程序广告，需在用户主动触发后展示（如点击按钮）。

2) 集成sdk

2.1. 登录到微信小程序后台，添加以下request合法域名：

1. talogshushu.postar.cn（用于埋点数据上传）

2. jghwucyshtgjcbrnxgwe.gtxygroup.com（用于测试环境获取广告）

3. https://mktcldxylmyxrhgw.postar.cn（用于生产环境获取广告）

半屏广告接入：

2.2 在小程序后台，向弹出半屏广告对应的三方公司申请半屏权限，并进行配置（如果没有配置，则默认弹出全屏广告）：

1、在小程序后台，如图顺序进行配置页面

2、下拉页面看到半屏小程序管理，点击第四步添加进行添加需要弹出半屏的小程序（例如此时交易后需要弹出美团的广告，在这里就需要去向美团申请并添加调用半屏小程序权限）

2.3 导入sdk文件到项目中，文件说明：

文件名	说明	必须	备注
wxSdk.es.js	获取广告	是	使用import方式导入时，需要引入本文件
wxSdk.umd.js	获取广告	是	使用require方式导入时，需要引入本文件
tdanalytics.wx.min.js	数据埋点	是	上传埋点数据使用

2.4 初始化实例：

2.5. SDK 接口说明

2.5.1 接口一：getAdsInfo（params,callbackObj）

2.5.1.1. 获取广告参数说明

参数	类型	必须	备注
params	QueryInfoRequest	是	广告请求参数对象
callbackObj	Object	否	回调函数配置：success返回示例：{ requestTraceId: "de814755d000575d_47c55bd7e178d107", adName: "美团"}

2.5.1.2 QueryInfoRequest 结构

参数	类型	必须	备注
trafficId	string	是	流量主ID，客户唯一标识（数字、字母、特殊字符组成）
orderNumber	string	是	订单流水号（数字、字母、特殊字符组成），最大长度40
geocodes	string	否	当前消费地点（省、市、区(县)）
store	string	否	商户信息（消费商户行业、商户名称）
orderTime	string	否	消费时间（支付时间）
content	string	否	消费内容（商品名称、品类）
amount	string	否	消费金额（精度0.01¥）
payWay	string	否	支付方式（支付渠道、支付工具类型支付渠道（eg：支付宝、微信、银联云闪付））
payEnv	string	否	支付环境 (egH5、微信小程序、App)
device	string	否	设备信息（品牌/机型）
userld	string	否	用户id
channel	string	否	渠道名称

2.5.1.3 callbackObj 回调配置

2.5.2. 接口二：showAd（params,callbackObj）

2.5.2.1. 获取广告参数说明

参数	类型	必须	备注
params	QueryInfoRequest	是	广告请求参数对象
callbackObj	Object	否	回调函数配置

2.5.2.2. QueryInfoRequest 结构

参数	类型	必须	备注
trafficId	string	是	流量主ID，客户唯一标识（数字、字母、特殊字符组成）
orderNumber	string	是	订单流水号（数字、字母、特殊字符组成），最大长度40
requestTraceId	string	是	请求流水，接口一getAdsInfo中返回的请求流水号，有效时间5分钟
geocodes	string	否	当前消费地点（省、市、区(县)）
store	string	否	商户信息（消费商户行业、商户名称）
orderTime	string	否	消费时间（支付时间）
content	string	否	消费内容（商品名称、品类）
amount	string	否	消费金额（精度0.01¥）
payWay	string	否	支付方式（支付渠道、支付工具类型支付渠道（eg：支付宝、微信、银联云闪付））
payEnv	string	否	支付环境 (H5、微信小程序、App)
device	string	否	设备信息（品牌/机型）
userld	string	否	用户id
channel	string	否	渠道名称

callbackObj 回调配置

H5广告接入：完成以上接入流程后，即可展示半屏广告，若还需支持展示H5广告，需要进行以下接入配置：

2.6.1. 登录到微信小程序后台，根据业务需求配置业务域名，用于展示自己的H5页面：

业务域名 | 微信开放⽂档

2.6.2. 添加H5广告所需页面，用于加载并展示H5广告：

在您的⼩程序app.json⽂件中添加如下配置：

并在项目的pages文件夹中添加gtWebView文件文件

gtWebView文件用于打开H5广告使用，文件可参考demo中对应文件

微信小程序广告

星驿付微信小程序广告 SDK 接入文档#

1. 概述#

2) 集成sdk#

2.1. 登录到微信小程序后台，添加以下request合法域名：#

半屏广告接入：#

2.2 在小程序后台，向弹出半屏广告对应的三方公司申请半屏权限，并进行配置（如果没有配置，则默认弹出全屏广告）：#

2.3 导入sdk文件到项目中，文件说明：#

2.4 初始化实例：#

2.5. SDK 接口说明#

2.5.1 接口一：getAdsInfo（params,callbackObj）#

2.5.1.1. 获取广告参数说明#

2.5.1.2 QueryInfoRequest 结构#

2.5.1.3 callbackObj 回调配置#

2.5.2. 接口二：showAd（params,callbackObj）#

2.5.2.1. 获取广告参数说明#

2.5.2.2. QueryInfoRequest 结构#

H5广告接入：完成以上接入流程后，即可展示半屏广告，若还需支持展示H5广告，需要进行以下接入配置：#

2.6.1. 登录到微信小程序后台，根据业务需求配置业务域名，用于展示自己的H5页面：#

2.6.2. 添加H5广告所需页面，用于加载并展示H5广告：#

3) 小程序原生项目，完整示例：#