*

*

0/500

Web电商功能布码文档

用户注册

例如,以下代码为调用自定义用户注册事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_user_register',//必填 不可更改项 表示该包分类为用户注册
                   pt_account_id: 'test_user', //必填 用户id
                   pt_gender: 'man',//选填 用户性别
                   pt_age: '18',//选填 用户年龄
                   pt_register_country: 'China', //选填 用户注册时选择的国家信息
                   pt_register_subdivision: 'Beijing', //选填, 用户注册时选择的下属行政地区信息
                   pt_register_city: 'Beijing', //选填,用户注册时选择的城市信息
                   pt_register_properties: {//选填,自定义用户注册属性,字段完全自定义
                       email: 'test_user@ptmind.com',
                       nick_name: 'nick name',
                       mark: 'mark demo'
                   }
               }]);

用户登录

例如,以下代码为调用自定义用户登录事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_user_login',//必填 不可更改项 表示该包分类为用户登录
                   pt_account_id: 'test_user', //必填,用户注册的账号信息
                   pt_account_profiles: {//选填,自定义用户登录属性,字段完全自定义
                       email: 'test_user@ptmind.com',
                       nick_name: 'nick name',
                       mark: 'mark demo'
                   }
               }]);

商品展示信息

使用pt_impression来标识商品展示信息,可自定义多维商品属性以及商品展示属性。 例如,以下代码为调用自定义商品展示信息事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_impression',// 必填 不可更改项 表示该包分类为商品展示信息
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_products: [{//必填,商品属性 包括商品id、名称、品牌、分类等等。值类型为数组
                       pt_product_id: '11', //必填, 商品ID或SKU
                       pt_product_name: '11', //选填,商品名称
                       pt_product_brand: '品牌', //选填,商品品牌
                       pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                       pt_product_variant: 'black', //选填,产品的细分款式
                       pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                       pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                       pt_product_price: 111.11, // 选填,产品的价格
                       pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                       pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                       pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                           prod1: 'prod1',
                           prod2: 'prod2'
                       }
                   }, {...}],
                   pt_impression_properties: {//选填,商品展示属性 比如尺寸宽度等,字段完全自定义
                       size: 'xxx',
                       width: 'xxx_yyy'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

商品详情

使用pt_product_detail来标识商品详情信息,支持自定义商品属性以及商品详细属性。
例如,以下代码为调用自定义商品详情事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_product_detail',//必填 不可更改项 表示该包分类为商品详情信息
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_product_id: '11', //必填, 商品ID或SKU
                   pt_product_name: '11', //选填,商品名称
                   pt_product_brand: '品牌', //选填,商品品牌
                   pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                   pt_product_variant: 'black', //选填,产品的细分款式
                   pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                   pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                   pt_product_price: 111.11, // 选填,产品的价格
                   pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                   pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                   pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                        prod1: 'prod1',
                        prod2: 'prod2'
                   },
                   pt_detail_properties: {//选填,商品详情自定义属性,字段完全自定义
                       prod_detail1: 'mock prod_detail1',
                       prod_detail2: 'mock prod_detail2'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

添加购物车

使用pt_add_cart标识添加购物车事件,支持自定义添加购物车属性以及商品属性。
例如,以下代码为调用自定义添加购物车事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_add_cart',//必填 不可更改项 表示该包分类为添加购物车
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_product_id: '11', //必填, 商品ID或SKU
                   pt_product_name: '11', //选填,商品名称
                   pt_product_brand: '品牌', //选填,商品品牌
                   pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                   pt_product_variant: 'black', //选填,产品的细分款式
                   pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                   pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                   pt_product_price: 111.11, // 选填,产品的价格
                   pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                   pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                   pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                        prod1: 'prod1',
                        prod2: 'prod2'
                   },
                   pt_add_cart_properties: {//选填,添加购物车自定义属性,字段完全自定义
                       cart_prop: 'mock cart_prop',
                       cart_prop: 'mock cart_prop'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

移除购物车

使用pt_remove_cart标识移除购物车事件。支持自定义商品属性以及移除购物车属性。
例如,以下代码为调用自定义移除购物车事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_remove_cart',//必填 不可更改项 表示该包分类为移除购物车
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_product_id: '11', //必填, 商品ID或SKU
                   pt_product_name: '11', //选填,商品名称
                   pt_product_brand: '品牌', //选填,商品品牌
                   pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                   pt_product_variant: 'black', //选填,产品的细分款式
                   pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                   pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                   pt_product_price: 111.11, // 选填,产品的价格
                   pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                   pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                   pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                        prod1: 'prod1',
                        prod2: 'prod2'
                   },
                   pt_remove_cart_properties: {//选填,删除购物车自定义属性,字段完全自定义
                       rm_cart_prop: 'mock rm_cart_prop',
                       rm_cart_prop: 'mock rm_cart_prop'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

生成订单

使用pt_check_out标识生成订单事件,支持自定义多维商品信息以及订单信息。
例如,以下代码为调用自定义生成订单事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_check_out',//必填 不可更改项 表示该包分类为生成订单
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_order_id: 'order_001', //必填,订单ID
                   pt_payment_amount: 11110.1, //选填,支付总金额
                   pr_order_properties: { //选填,与订单相关的自定义信息,字段完全自定义
                       order_prop1: 'mock order_prop1',
                       order_prop2: 'mock order_prop2'
                   },
                   pt_products: [{//值类型为数组
                       pt_product_id: '11', //必填, 商品ID或SKU
                       pt_product_name: '11', //选填,商品名称
                       pt_product_brand: '品牌', //选填,商品品牌
                       pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                       pt_product_variant: 'black', //选填,产品的细分款式
                       pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                       pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                       pt_product_price: 111.11, // 选填,产品的价格
                       pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                       pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                       pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                           prod1: 'prod1',
                           prod2: 'prod2'
                       },
                   { }],
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

付款

使用pt_purchase标识付款事件。支持自定义多维商品信息以及付款属性。
例如,以下代码为调用自定义付款事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_purchase',//必填 不可更改项 表示该包分类为付款
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_order_id: 'order_001', //必填,订单ID
                   pt_payment_amount: 11110.1, //选填,支付总金额
                   pt_payment_type: '11',//选填,支付方式
                   pt_tax: '11', //选填,商品税费
                   pt_shipping: '11', //选填,商品运费
                   pt_purchase_properties: {//选填,与付款相关的自定义信息,字段完全自定义 
                       pur_prop1: "mock pur_prop1",
                       pur_prop2: "mock pur_prop2"
                   },
                   pt_products: [{
                       pt_product_id: '11', //必填, 商品ID或SKU
                       pt_product_name: '11', //选填,商品名称
                       pt_product_brand: '品牌', //选填,商品品牌
                       pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                       pt_product_variant: 'black', //选填,产品的细分款式
                       pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                       pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                       pt_product_price: 111.11, // 选填,产品的价格
                       pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                       pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                       pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                           prod1: 'prod1',
                           prod2: 'prod2'
                       }, {}],
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

退款

使用pt_refund标识退款事件,支持自定义多维商品属性以及退款属性。
例如,以下代码为调用自定义退款事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_refund',//必填 不可更改项  表示该包分类为退款
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_payment_type: '11',//选填,支付方式
                   pt_tax: '11', //选填,商品税费
                   pt_shipping: '11', //选填,商品运费
                   pt_refund_properties: {//选填,与退款相关的自定义信息,字段完全自定义
                       ref_prop_01: 'mock ref_prop_01',
                       ref_prop_02: 'mock ref_prop_02'
                   },
                   pt_products: [{
                        pt_product_id: '11', //必填, 商品ID或SKU
                       pt_product_name: '11', //选填,商品名称
                       pt_product_brand: '品牌', //选填,商品品牌
                       pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                       pt_product_variant: 'black', //选填,产品的细分款式
                       pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                       pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                       pt_product_price: 111.11, // 选填,产品的价格
                       pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                       pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                       pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                           prod1: 'prod1',
                           prod2: 'prod2'
                       } { }],
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

添加收藏夹

使用pt_add_favorite标识添加收藏夹事件,支持自定义商品属性以及添加收藏夹属性。
例如,以下代码为调用自定义商品详情事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_add_favorite',//必填 不可更改项 表示该包分类为添加收藏夹
                   pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_product_id: '11', //必填, 商品ID或SKU
                   pt_product_name: '11', //选填,商品名称
                   pt_product_brand: '品牌', //选填,商品品牌
                   pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                   pt_product_variant: 'black', //选填,产品的细分款式
                   pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                   pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                   pt_product_price: 111.11, // 选填,产品的价格
                   pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                   pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                   pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                        prod1: 'prod1',
                        prod2: 'prod2'
                   },
                   pt_add_favorite_properties: {//选填,与收藏相关的自定义属性信息
                       favor_prop_01: 'mock favor_prop_01',
                       favor_prop_02: 'mock favor_prop_02'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);

移除收藏夹

使用pt_remove_favorite标识移除收藏夹事件,支持自定义商品属性以及移除收藏夹属性。
例如,以下代码为调用自定义商品详情事件:

_pt_sp_2.push('setEC', [{
                   pt_category: 'pt_remove_favorite',//必填 不可更改项 表示该包分类为移除收藏夹
                    pt_account_id: 'test_user',//选填,用户登录的账号id
                   pt_source: 'search engine', //必填,该字段用户统计当前动作的结果是通过什么方式展现的
                   pt_product_id: '11', //必填, 商品ID或SKU
                   pt_product_name: '11', //选填,商品名称
                   pt_product_brand: '品牌', //选填,商品品牌
                   pt_product_category: '服装/男装/T 恤', //选填,产品所属的类别(例如服装),可用/作为分隔符来指定最多5个层级
                   pt_product_variant: 'black', //选填,产品的细分款式
                   pt_product_list: '11111', //选填, 产品所在的列表或集合(例如搜索结果)
                   pt_product_position: 1, // 选填,产品所在的列表或集合中的位置
                   pt_product_price: 111.11, // 选填,产品的价格
                   pt_product_currency_code: '11', //选填,产品的货币代码(USD, RMB)
                   pt_product_coupon: '11', //选填,与产品关联的优惠券代码
                   pt_product_properties: { //选填,产品相关的自定义属性,字段完全自定义
                        prod1: 'prod1',
                        prod2: 'prod2'
                   },
                   pt_remove_favorite_properties: {//选填,与收藏相关的自定义属性信息
                       rm_favor_prop_01: 'mock rm_favor_prop_01',
                       rm_favor_prop_02: 'mock rm_favor_prop_02'
                   },
                   pt_ad_creative_id: 'PROMO_1234', //选填,促销活动的ID
                   pt_ad_position: '11', //选填,广告素材的位置
                   pt_promo_info: '11',//选填,促销活动的名称
                   pt_promo_properties: {//选填,促销活动相关的自定义属性
                       promo_01: 'promo_01',
                       promo_02: 'promo_02'
                   },
               }]);