广告数据上报
analytics
1. 接口描述
接口功能:上报广告数据
接口声明:analytics(object: Object): Promise<void>
提示
自 SDK 2.5.0 版本起支持此接口
2. 输入参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
report_type | string | 是 | 上报类型,目前支持 "mall" |
report_data | IReportData | 是 | 上报内容 |
IReportData
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
action_time | number | 否 | 上报时间,不填默认取当前客户端时间,单位为秒 |
action_type | string | 是 | 行为类型 如 访问 visit_store,分享 share,加入购物车 add_to_cart 等,详细类型参考表 action_types |
click_id | string | 否 | 广告平台会在 URL 增加 click_id,取值方式参考 |
action_param | IActionParam | 否 | 行为所带的参数 |
product_param | IProductParam | 否 | 商品结构内容 |
IActionParam
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
value | number | 否 | 行为所带的参数,转化行为价值(例如金额) |
leads_type | string | 否 | 行为来源,目前支持 PHONE(电话直呼),RESERVE(表单预约) |
IProductParam
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
product_yun_type | string | 否 | 商品 goods ,优惠券 coupon, 搜索词 search_term |
product_yun_id | string | 否 | 商品 id |
product_yun_category | string | 否 | 商品类目 自定义 |
product_yun_keywords | string | 否 | 商品关键词 |
product_yun_price | number | 否 | 商品原价 |
product_yun_value | number | 否 | 商品成交价 |
product_yun_name | string | 否 | 商品名 |
product_yun_id_ad | string | 否 | 广告商品库中商品 id |
product_yun_category_ad | string | 否 | 广告商品库中商品类目 |
action_types
类型值 | 说明 |
---|---|
visit_store | 访问 |
share | 分享 |
consult | 咨询 |
claim_offer | 卡券领取 |
add_to_cart | 加入购物车 |
add_to_wishlist | 收藏 |
complete_order | 下单 |
purchase | 支付 |
search | 搜索 |
deliver | 发货 |
sign_in | 签收 |
3. 输出参数
无
4. 示例代码
const tcb = require("@cloudbase/node-sdk");
const app = tcb.init({ env: "xxx" });
app.analytics({
report_type: "mall",
report_data: {
action_type: "visit_store",
action_param: {
value: 100
},
product_param: {
product_yun_type: "goods",
product_yun_id: 1,
product_yun_keywords: "优衣库",
product_yun_price: 200,
product_yun_value: 100,
product_yun_name: "优衣库Utee-迪士尼"
}
}
});