JS SDK需求文档&设计文档 js sdk怎么写

一、概述

该文档的主要作用是为了开发人员参考可以参考本文档，了解js sdk的集成方式以及提供的各种不同的api。

注意：不采用ip来标示用户的唯一性，我们通过在cookie中填充一个uuid来标示用户的唯一性。

二、Js sdk执行工作流

在我们的js sdk中按照收集数据的不同分为不同的事件，比如pageview事件等。Js sdk的执行流程如下：

一、分析

1、PC端事件分析

针对我们最终的不同分析模块，我们需要不同的数据，接下来分别从各个模块分析，每个模块需要的数据。用户基本信息就是用户的浏览行为信息分析，也就是我们只需要pageview事件就可以了；浏览器信息分析以及地域信息分析其实就是在用户基本信息分析的基础上添加浏览器和地域这个维度信息，其中浏览器信息我们可以通过浏览器的window.navigator.userAgent来进行分析，地域信息可以通过nginx服务器来收集用户的ip地址来进行分析，也就是说pageview事件也可以满足这两个模块的分析。外链数据分析以及用户浏览深度分析我们可以在pageview事件中添加访问页面的当前url和前一个页面的url来进行处理分析，也就是说pageview事件也可以满足这两个模块的分析。我们还需要设置一个launch事件来记录新用户的访问。

Pc端的各种不同事件发送的数据url格式如下,其中url中后面的参数就是我们收集到的数据：http://mini1/log.gif?requestdata

a)Launch事件

当用户第一次访问网站的时候触发该事件，不提供对外调用的接口，只实现该事件的数据收集。

a)Pageview事件

当用户访问页面/刷新页面的时候触发该事件。该事件会自动调用，也可以让程序员手动调用。

1、其他api方法

在这里只介绍设置会员id的方法，其他的辅助方法到时候编写js的时候再介绍。

a)设置会员id

1、集成方式

Js sdk的集成分为两种方式，第一种是直接使用script标签引入js，第二种是在页面加载完成后执行js代码，js代码再进行js的加载。如下：

1、数据参数说明

在各个不同事件中收集不同的数据发送到nginx服务器，但是实际上这些收集到的数据还是有一些共性的。下面将所用可能用到的参数描述如下：

keys:{

pageView:"e_pv",

launch:"e_l",

sid:"sid",

uuid:"uuid",

mid:"mid",

preVisitTime:"previsit",

},