Web SDK 集成指南
最近更新:2023-02-21
展开全部

Web SDK 集成指南

使用提示

本文是 JOperate Web SDK 标准的集成指南文档。

  • 如果您想要快速地测试、请参考本文在几分钟内跑通 Demo。
  • 极光推送文档网站上,有相关的所有指南、API、教程等全部的文档。包括本文档的更新版本,都会及时地发布到该网站上。

产品说明

利用事件模板统计 App 用户的行为事件并上报给极光服务器,极光提供加工过的数据通过 WebPortal 展示给开发者,让开发者更加了解自己的应用在用户手中的使用情况。

主要场景:

统计自定义事件

集成压缩包内容

  • example
    • 是一个 web 页面,通过这个演示了 JOperate SDK 的基本用法,可以用来做参考。

获取应用信息

完成数据源接入后,进入「数据源列表-详情」查看 AppKey 和 scheme。详情参考 WebJS 平台接入

Web SDK 集成指南

每个页面接入下面 js:

<script type="text/javascript" src="https://web-stat.jpush.cn/web/report/html/joperate-web.min.js"></script>
          <script type="text/javascript" src="https://web-stat.jpush.cn/web/report/html/joperate-web.min.js"></script>

        
此代码块在浮窗中显示

引入该 JS 后,就可以使用 Window 上的全局对象 JOperateInterface。

特别提示:请直接使用此链接,不要将此文件下载到您项目中,否则,在我们更新数据结构或 API 接口后有可能会导致统计失效。

SDK 初始化

  • 调用初始化时会在页面接入极光 iframe,所以需要在每个页面 DOM 加载完毕后,或者在收到页面事件 onload 后调用初始化:
window.JOperateInterface.init({ appKey: "9f7248bf870ddec7048e6c0b", // 必填,此 appkey 须已绑定数据源,获取详情参考上文「获取应用信息」 debugMode: true,// 设置是否开启 debug 模式。true 则会打印更多的日志信息。设置 false 则只会输出 w、e 级别的日志 channel: "default-channel",// 渠道名称,默认值为:default-channel })
            window.JOperateInterface.init({
    appKey: "9f7248bf870ddec7048e6c0b", // 必填,此 appkey 须已绑定数据源,获取详情参考上文「获取应用信息」
    debugMode: true,// 设置是否开启 debug 模式。true 则会打印更多的日志信息。设置 false 则只会输出 w、e 级别的日志
    channel: "default-channel",// 渠道名称,默认值为:default-channel
  })

        
此代码块在浮窗中显示

数据校验模式

若需要查看实时上报可以扫码进入数据校验模式,详情参考 数据校验文档

更多 API

其他 API 的使用方法请参考接口文档:Web SDK API

技术支持

邮件联系:support@jiguang.cn

文档内容是否对您有帮助?

Copyright 2011-2022, jiguang.cn, All Rights Reserved. 粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

在文档中心打开