跳到主要内容

广告数据上报

analytics

1. 接口描述

接口功能:上报广告数据

接口声明:analytics(object: Object): Promise<void>

提示

自 SDK 1.4.0 版本起支持此接口,使用时需结合微信授权登录使用

2. 输入参数

字段类型必填说明
report_typestring上报类型,目前支持 "mall"
report_dataIReportData上报内容
IReportData
字段类型必填说明
action_timenumber上报时间,不填默认取当前客户端时间,单位为秒
action_typestring行为类型 如 访问 visit_store,分享 share,加入购物车 add_to_cart 等,详细类型参考表 action_types
click_idstring广告平台会在 URL 增加 click_id,取值方式参考
action_paramIActionParam行为所带的参数
product_paramIProductParam商品结构内容
IActionParam
字段类型必填说明
valuenumber行为所带的参数,转化行为价值(例如金额)
leads_typestring行为来源,目前支持 PHONE(电话直呼),RESERVE(表单预约)
IProductParam
字段类型必填说明
product_yun_typestring商品 goods ,优惠券 coupon, 搜索词 search_term
product_yun_idstring商品 id
product_yun_categorystring商品类目 自定义
product_yun_keywordsstring商品关键词
product_yun_pricenumber商品原价
product_yun_valuenumber商品成交价
product_yun_namestring商品名
product_yun_id_adstring广告商品库中商品 id
product_yun_category_adstring广告商品库中商品类目
action_types
类型值说明
visit_store访问
share分享
consult咨询
claim_offer卡券领取
add_to_cart加入购物车
add_to_wishlist收藏
complete_order下单
purchase支付
search搜索
deliver发货
sign_in签收

3. 输出参数

4. 示例代码

import cloudbase from "@cloudbase/js-sdk";
//初始化SDK实例
const app = cloudbase.init({
env: "xxxx-yyy"
});

// 微信授权登录
const provider = auth.weixinAuthProvider({
appid: "...",
scope: "xxxx"
});

provider.getRedirectResult().then((loginState) => {
if (loginState) {
// 登录成功!
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-迪士尼"
}
}
});
}
});