JS SDK · 方舟智能运营

--- description: JS SDK 用于由 HTML 、 Css 及 Javascript 制作成的网站 --- # JS SDK ### 一、SDK简介 EA系统是易观基于方舟平台一款触达用户的产品，加强了产品的用户体验和提升了产品的转化率，EA的 JS SDK 是此系统中重要的支撑点，它提供了： * 触达用户的弹窗功能，支持弹窗样式： * 文本样式，支持标题、正文、按钮。 * 图文混合样式，最上面是标题，下面是正文、图片、按钮。 * 图文混合样式，最上面是图片，下面是标题、正文、按钮。 #### JS SDK 浏览器版本支持支持IE 9 以上所有浏览器 ### 二、快速开始 1、将以下 JS 代码复制到您项目页面中的`<head>`和`</head>`标签之间 >[info]以下初始化JS代码必须放置在方舟SDK初始化代码之前 ```javascript <script> (function(config){ window.AnalysysAgentModalConfig = config || [] })({ appKey: '/*设置为实际APPKEY*/', //在EA系统中选择要集成的项目，并在项目属性中查看AppKey configURL: '/*设置为实际数据获取地址*/' // 配置您的数据获取地址 }) </script> //引用JSSDK文件的script标签必须在初始化代码之下 <script type="text/javascript" src="https://ea-ch.analysysdata.com/ark/sdk/AnalysysAgentEA_JS_SDK.min.js"></script> ``` ### 配置参数 appKey appkey 为EA系统中集成的项目 AppKey。 * 类型:String。取值长度 1 - 255 字符。 configURL configURL 为自定义数据获取地址，参数设置后，将从该地址获取数据信息。 * value 类型：String。数据上传地址，格式为 scheme://host + :port(不包含/后的内容)。scheme 必须以 http:// 或 https:// 开头，host 只支持域名和 IP，取值长度 1 - 255字符，port 端口号必须携带，eg：[https://ea-ch.analysysdata.com](https://ea-ch.analysysdata.com) 。 isH5 isH5(可选，默认为false) 设置弹窗是否是 H5 模式，false-弹窗 web模式，true-弹窗 H5 模式。为弹窗设置为H5弹窗，用于页面是嵌入app的情况下使用。如果是页面只是在浏览器的 H5 模式使用，则不需要配置，弹窗可自动识别。 * 类型:Boolean。取值为 true 或者 false 。 isTest 设置调试模式（可选，默认为false），在接入的时候可以设置为true，在网页console可以看到接入的输出，用于判断接入是否正确。 * 类型:Boolean。取值为 true 或者 false 。 2、替换方舟SDK >[info]方舟SDK替换成EA服务器上的方舟SDK，以下代码放在EA初始化之后 **异步集成** ```javascript <script> (function(c) { window.AnalysysAgent = window.AnalysysAgent || {} var a = window.AnalysysAgent || {} var ans = ['identify', 'alias', 'reset', 'track', 'profileSet', 'profileSetOnce', 'profileIncrement', 'profileAppend', 'profileUnset', 'profileDelete', 'registerSuperProperty', 'registerSuperProperties', 'unRegisterSuperProperty', 'clearSuperProperties', 'getSuperProperty', 'getSuperProperties', 'pageView', 'getDistinctId'] a['config'] = c a['param'] = [] function factory (b) { return function () { a['param'].push([b, arguments]) return window.AnalysysAgent } } for (var i = 0; i < ans.length; i++) { a[ans[i]] = factory(ans[i]) } if (c.name) { window[c.name] = a } var date = new Date(); var time = new String(date.getFullYear()) + new String(date.getMonth() + 1) + new String(date.getDate()); var d = document, c = d.createElement('script'), n = d.getElementsByTagName('script')[0]; c.type = 'text/javascript'; c.async = true; c.id = 'ARK_SDK'; c.src = '/*设置为JS SDK实际存放地址*/' +'?v=' +time; //JS SDK存放地址 n.parentNode.insertBefore(c, n); })({ appkey: '/*设置为实际APPKEY*/', //APPKEY uploadURL: '/*设置为实际地址*/'//上传数据的地址 }) </script> ``` **同步集成** ```javascript //建议在script标签设置id为ARK_SDK,该ID用来引导可视化模块与热图模块的加载 <script type="text/javascript" id="ARK_SDK" src="/*设置为JS SDK实际存放地址*/"></script> //初始化JS SDK <script> window.AnalysysAgent.init({ appkey: '/*设置为实际APPKEY*/', //APPKEY uploadURL: '/*设置为实际地址*/'//上传数据的地址 }) </script> ``` ### 三 SDK接口 ### 1、上传公众号的ID 接口定义： ``` window.AnalysysEaManager.setWeChatId(unionId, appId, openId) ``` 参数说明： | 参数 | 说明 | 必填 | 备注 | | :-----: | :-----------: | -- | ------ | | unionId | 企业unionID | 是 | 可为空字符串 | | appId | 小程序、公众号的appID | 是 | | | openId | 用户openId | 是 | | 返回值：无 ### 四、备注 1、监听事件 window.AnalysysModal(data) 说明 ```javascript /** * 上报的数据data * 类型： Aarry；上报事件集合。 * eg: [{xwho: 'zA8zsrc71000013', xwhen: 1580895315502, xwhat: '$pageview', xcontext: {$url: 'https://ea-ch.analysysdata.com'} }] * @param data */ window.AnalysysModal = function (data) { } ```