事件级自定义变量

什么是事件级自定义变量？ #

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

事件级自定义变量能解决什么问题？ #

根据您的产品的功能合理配置事件和变量，可以发挥出事件分析的强大功能，应对变化趋势、维度对比等各种细分问题。最近三个月来自哪个渠道的用户消费金额最高？变化趋势如何？ 上周来自北京的且发生过购买行为的用户，所购买的商品种类的分布情况如何？ 各个时段的人均消费金额分别是多少？

案例一

背景：某互联网电商市场人员，在“双11”做促销活动，在很多渠道都投放了大量的广告来引流促销，其中包括：百度广告、新浪视频、搜狐视频、腾讯新闻、快手等等。

需求：现在他想通过此次活动分析一下，哪些渠道的投放效果会更好，方便在“双12”的时候对部分效果好的渠道加大投入力度，另外也想分析一下，在活动期间哪些主推的产品会更受到用户的青睐。

实现方式：这时就可以使用事件级自定义变量，在关键事件的地方进行埋码和接口的调用，例如在产品购买按钮地方埋点并调用事件级自定义变量的接口，将商品的ID、商品的名称、商品的价格、商品的一级品类、二级品类等信息上传上来，这样就可以多维度的交叉分析得出想要的结果。比如，在查看渠道转化时，根据产品种类进行排序，这样就可以获得不同渠道的购买偏好，这样下次投放时就可以根据不同的渠道制作专门的落地页。

案例二

某广告公司策划人员，想要知道网页上哪一模块的内容会更容易使访客点击悬浮的对话按钮，以此优化网页内容。这样我们就可以使用时间及自定义变量，将不同模块的位置信息使用接口上传，这样我们就可以对比网页上不同模块的转化率了。

如何设置事件级自定义变量？ #

Note:因事件级自定义变量是要对网页源代码进行更改，为避免对您的网站造成影响，建议您联系相关技术人员来进行操作。

事件级自定义变量目前是使用手动埋码的方式进行设置，您可以在您网站的前端代码的任何地方调用这个api。代码示例：

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

字段说明

埋码格式注意

1. 在_pt_sp_2.push()这个方法中，第一个参数固定不可修改，为setCustomVarV2。

2. 第二个参数{key:value}：最多可添加10个key:value，超过不采集数据。图中已设置4个，还有6个可设。

3. Key（属性名）：
   格式：采用数字、字母、下划线组合。如果使用其它非规定字符，将不会采集数据。
   长度限制：64个字符，超出将不会采集数据。添加重复的key，后者会覆盖前者。

4. Value（属性值）：
   数据类型：只有4种，分别为string、int、float、date，如果使用非规定的数据类型，将不会采集数据。
   各种数据类型值的长度限制：
   o 字符串（string）：256字节，超出将不会采集数据。
   o 整数（int）：(-2147483648,2147483647)，使用在此范围外的整数将不会采集数据。
   o 浮点数（float）：(-4294967296,4294967294)，使用在此范围外的浮点数将不会采集数据。
   o 日期（date）：时间格式应为“YYYY-MM-DD HH:MM:SS”，格式不对将不会采集数据。
   还有一种特殊类型值function，如果您需要将原始数据进行处理，使之能够作为被采集的数据，建议您使用function来处理复杂逻辑。这样做的一个好处是，将采集代码与业务代码分离，代码更加清晰便于维护。
   要求：返回值必须为以上4种数据类型。否则将不会采集数据。且function是无参的匿名函数。
   例如可以在渲染商品列表的时候传入数据，添加自定义变量：

_pt_sp_2.push('setCustomVarV2', {
    eventName: '购买',
    productId: 123456,
    productCatalog: '商品品类',
    productName: '商品名称',
    productPrice: function(){
        if(discount){
            let count = productPrice - discount;    
        }
        return count || productPrice;
    }
   createName: '2018-04-23 15:40:46'
})

5. EventName这个key是必要的，值为string类型。长度限制为60字符（1个中文占2个字符）。如果没有eventName，将不会采集数据。如果修改这个值，例如修改例子中的’购买’为’收藏’，将会重新以新的id来采集数据。理论上自定义变量的个数不超过15个，每个自定义变量的用量不超过1000次（该自定义变量最多采集1000次数据），其它属性可以根据需要自由设置，key:value使用规定的格式及数据类型即可。

Note:注意：
① 埋码完成后，当对应元素被点击采集代码被加载后，即开始采集数据。
② 您可以为同一元素添加多个自定义变量，中间使用分号隔开。也可以给具有相同结构的多个元素添加同一个自定义变量。
③ 对于采集包的大小限制——我们根据浏览器的不同做了相应的限制，不同的浏览器限制不同，因此在设置自定义变量时尽量不要设置的太大太长，目前一些主流的浏览器的限制：

不同浏览器注意事项 #

• IE
IE浏览器对URL长度限制是2083（2K+53），超过这个限制，则会自动截断（若是form提交按钮则不起作用）
• Firefox
火狐浏览器的URL长度限制为65536字符，但实际上有效的URL最大长度不少于100,000个字符
• Chrome
谷歌浏览器的URL长度限制超为8182个字符
• Safari
Safari浏览器的URL长度限制为80,000字符
• Opera
Opera浏览器的URL长度限制为190,000字符

声明：Ptmind尊重并保护用户的隐私，禁止使用Ptengine的接口采集传输与用户隐私相关的数据，我们也会定期对采集的数据进行排查，一经发现存在利用Ptengine的接口采集用户隐私相关的数据，我们会立即停止数据采集，所引发的一切法律后果将由使用者自己承担与Ptmind无关。