Web SDK 配置参考
参数介绍
初始化接口需接收一个Object对象,对象参数如下:
字段 | 描述 | 类型 | 是否必填 | 对应版本 | 说明 |
---|---|---|---|---|---|
appKey | 应用标识码 | String | 与appId不能同时为空 | - | 取值长度 1 - 255 字符 请依据进入不同环境的云图主站申请应用AppKey,不同环境相互不打通。 |
appId | 应用appId | String | 与appKey不能同时为空 | 1.7.16 | 应用sdp_app_id,通过appId与env到配置服务中取云图配置: 1. 如本地配置了appKey参数,则上报云图数据关联到本地配置的appKey 2. 如本地未配置appKey参数,则上报云图数据关联到配置服务中的appKey 3. 如本地和配置服务都未配置appKey,则自动{appid}_web作为应用appkey 注:如果要开启百度统计功能,必须填写appId,并在配置中心云图组件中配置bdSiteId参数,用于将上报数据关联到对应的站点 |
appVer | 应用版本号 | String | 必填 | - | 取值长度 1 - 64 字符 |
env | 环境 | String | 必填 | - | 请查看下方环境变量说明 |
isDebugMode | 是否为调试模式 | Boolean | 可选 | - | false 关闭调试模式(默认) true 开启调试模式,生产环境请关闭调试模式 |
channelId | 渠道ID | String | 可选 | 1.7.17 | 默认值为default 当访问的url中存在utm_source参数时,utm_source的值会作为channelId(优先级更高) |
isLog | 是否控制台打印日志 | Boolean | 可选 | 1.6.1 | 默认值为false,不进行打印 |
isHttps | 是否使用https | Boolean | 可选 | 1.6.1 | 默认值为false,上传走http接口,生产上设置为true走 https 请求接口 |
limitNumber | 上传限制条数 | Number | 可选 | 1.7.0 | 1.7.0版本上传范围为5-100,将触发事情存入localstorage中,达到限制条数,上传数据 |
isVTrack | 是否启用可视化埋点 | Boolean | 可选 | 1.7.2 | 是否加载可视化埋点代码 true 启用全埋点功能 false 不启用全埋点功能(默认) |
isImmediately | 是否开启立即上传 | Boolean | 可选 | 1.7.17 | 不存入localstorage,及时上传数据,默认关闭 此参数开启后,limitNumber限制条数默认会修改为1 |
autoUpload | 定时上传时间间隔 | Number | 可选 | 1.7.17 | 默认20秒自动上传,最小20秒,最多30秒 |
isSPA | 单页面应用页面采集开关 | Boolean | 可选 | 1.7.19 | 默认false,开启后可以自动采集单页面应用的跳转事件 |
isSendYTSdk | 是否将数据推送至云图SDK | Boolean | 可选 | 1.7.20 | 默认false |
isSendBdSdk | 是否将数据上报给百度统计 | Boolean | 可选 | 1.7.20 | 默认false |
isSendYmSdk | 是否将数据上报给友盟统计 | Boolean | 可选 | 1.7.20 | 默认false |
isSendBridge | 是否提供SDK与移动端之间的bridage桥接功能 | Boolean | 可选 | 1.7.20 | 默认false |
bdSiteId | 百度Web SDK的SiteId | String | 当isSendBdSdk为true时,此字段必填 | 1.7.20 | 在百度统计代码中获取 |
ymSiteId | 友盟Web SDK的SiteId | String | 当isSendYmSdk为true时,此字段必填 | 1.7.20 | 在友盟统计代码中获取 |
环境变量
环境参数对照表:
在调试模式下,SDK内部发生异常时,会抛出并打印异常到控制台。
在1.7.18版本后,env参数同时用于配置配置服务的环境,参考下表
环境 | env参数值 | 环境主站域名 | 备注 |
---|---|---|---|
开发 | development或DEVELOPMENT | ||
测试 | test或DEBUG | ||
预生产 | preproduction或PREPRODUCTION | https://yuntu.betas.101.com | 当前已开放,集成环境已取消对外开放,请使用该环境对接开发\测试\集成\预生产环境 |
生产 | product或PRODUCTION | https://yuntu.101.com | 正常使用 |
香港 | hk | ||
美国 | aws-california | ||
中央电教馆 | prod-eduyun或PRODEDUYUN | https://bd-ca-visualization.vlab.eduyun.cn | 该环境已取消,请直接对接云图生产环境 |
伊拉克演练 | pre-iraq-edu或IRAQ | https://bd-ca-visualization.iraq.101.com | 正常使用,对接文档 |
央馆X学习 | ncet-xedu | ||
埃及vod | egvod-pre | https://bd-ca-visualization.egvod-beta.ndaeweb.com | |
巴林生产 | AWSBH | ||
自定义 | CUSTOM | 需填写hostUrl参数才能将数据上报到云图 |
目前只有集成环境和生产环境两个数据库在维护,请接入时测试接入集成,发布接入生产
初始化接口必须在调用其他接口之前调用。