采集端API

埋点事件 setCustomEvent

功能：调用一次发送一个事件采集包，可以统计按钮点击、注册成功、加入购物车等数据，可以埋到到业务逻辑中统计数据。 比如统计注册量，可以把埋点事件代码部署到ajax的成功回调的函数里面。

格式：
_pt_sp_2.push('setCustomEvent',{ eventName:'事件名称', isActiveElement:是否交互元素})
参数eventName：事件名称，String类型，固定字段必选。
参数isActiveElement:是否交互元素，Number，可选，1:交互元素，0:非交互元素。默认是0。

示例：

_pt_sp_2.push('setCustomEvent',{
eventName:'测试手动事件',
isActiveElement:1
})

自定义变量 setCustomVar

格式：_pt_sp_2.push('setCustomVarV2',{eventName: '事件级自定义变量'})

功能：在事件的基础上，您可以通过代码埋点部署增加额外的自定义变量。比如对于 “加入购物车” 这个事件，我们可以采集商品种类或者商品价格的数据，对应的变量分别是 “加入购物车的商品种类” 和 “加入购物车的商品价格”。此功能需要开通特定的套餐或者连接DataDeck使用。

参数：

setCustomVarV2为固定字段，必选

第二个参数为json格式对象。第一个key为eventName，自定义变量名称，固定字段，必选，长度限制60字符。其余的key：value 无特殊要求，支持自定义，最多个支持10组数据。value的数据类型如下：

字符串（string）：256字节，超出将不会采集数据。

整数（int）：(-2147483648,2147483647)，使用在此范围外的整数将不会采集数据。

浮点数（float）：(-4294967296,4294967294)，使用在此范围外的浮点数将不会采集数据。

日期（date）：时间格式应为“YYYY-MM-DD HH:MM:SS” 格式不对将不会采集数据。

示例：

_pt_sp_2.push('setCustomVarV2',{
eventName: '购买',
productId: 123456,
productCatalog: '商品品类',
productName: '商品名称',
productPrice: 123.45,
createDate: '2018-04-23 15:40:46'
})

设置跨域不断访次setCrossDomainLink

格式：_pt_sp_2.push('setCrossDomainLink,allManual/halfManual ');

功能：设置手动跨域功能。比如A域名和B域名部署了同一套监测代码，访客从A域名跳转到B域名，这种跨域行为无法共享cookie信息导致访次断开，会影响转化数据。为了使访次不断开，可以使用此功能完成访次的拼接。此API的原理是提取cookie信息作为a标签href属性的锚点信息。完成布码后，从A跳转到B时，您会发现B页面的URL多了一个锚点，这便是采集系统的访次信息。如果您网站的跳转不是a标签href方式跳转，则无法使用此功能。

参数：

allManual，全手动模式。在需要跨域处理的a标签内，添加onclick="pt_domain"属性。如果用户已设定onclick事件，例如：onclick="test()"，可以在其末尾添加pt_domain，例如：onclick="test();pt_domain"。没有该属性的a标签，不会做跨域处理。

halfManua，半手动模式。用户不需要对a标签修改，页面所有a标签都会增加跨域处理。

设置页面title setVPT

格式：_pt_sp_2.push('setVPT,虚拟tilte');

功能：设置虚拟title。有时候页面没有title标签，在产品展示时会显示not set。为了避免这种情况，可以使用此功能，手动设置页面标题。

示例：

_pt_sp_2.push('setVPT,ptmind');

如果页面原title：ptengine

使用setVPT后为，在产品内展示的title：ptmind

setVPV

格式：_pt_sp_2.push('setVPV,虚拟url');

功能：设置虚拟url。需要注意的是，使用此功能会默认把URL转为小写，如果您的URL有大写字母可能会有一些影响。

示例：

_pt_sp_2.push('setVPV,http://www.baidu.com/your');

原URL：http://www.baidu.com

setVPV 后为：http://www.baidu.com/your

setURL

格式：_pt_sp_2.push('setURL,锚点');

功能：设置url锚点(#)后面的信息。

示例：

_pt_sp_2.push('setURL,btnSave');

原URL为：http://www.baidu.com

使用setURL后产品内展示的URL：http://www.baidu.com#btnSave

setPVTag

格式：_pt_sp_2.push('setPVTag,URL/锚点信息,replace');

功能：用来发送一次PV数据包。对于单页面应用结构的网站URL切换可以模拟pv。在页面不发生实际跳转，URL和页面内容却有可能发生改变的情况下，可以通过调用该函数，采集单页面结构无刷新页面的URL数据。该方法会生成一个虚拟的URL，使后续采集的数据都会对应到新的URL上。

参数1：如果参数2（replace）没有设置，则该值为原URL中，需要增加的锚点信息。生成的虚拟URL为元URL+锚点信息。

如果参数2设置为replace，则该值为改变后的完整URL。生成的虚拟URL为此值设定的新URL。

参数2：replace

示例1：

原URL为：http://www.ptmind.com

想要生成的虚拟URL为：http://www.ptmind.com#login

则需要创建以下函数。
_pt_sp_2.push('setPVTag,login');

示例2：

原URL为： http://www.ptmind.com

想要生成的虚拟URL为：http://www.ptmind.com/login

则需要创建以下函数。

_pt_sp_2.push('setPVTag,http://www.ptmind.com/login,replace');

设置抽样率 setSampleRate

格式：_pt_sp_2.push('setSampleRate, 抽样率');

功能：设置采集的抽样率。如果您网站的数据量大，不想全量采集，可以使用此功能设置抽样。

参数1：设置抽样率，必选。例如：如果设定成1000，表示抽样率为千分之一，一万个页面浏览量里只收集10个访问数据。

示例：_pt_sp_2.push('setSampleRate, 1000');

不以广告参数新建访次 setIgnoreCampaign

格式：_pt_sp_2.push('setIgnoreCampaign,true');

功能：采集系统默认把包含广告参数的页面作为新的访次的进入页，即使您一直刷新这些页面，每次刷新都会算作一个新访次的入口页。

参数：如果该值为true，则忽略广告(utm)参数，不以广告参数来新建访次。采集端默认为false，不忽略广告(utm)参数，每次访问包含广告参数的页面，会算作一次新的访问。

开启iframe内的事件采集功能 setIframe

格式：_pt_sp_2.push('setIframe, true');

功能：开启iframe内的事件采集功能。

参数：如果该值为true，则采集端开启iframe内的事件采集，否则不开启。采集端默认关闭iframe内的事件采集。