最近更新时间:2023.02.28 17:57:49
首次发布时间:2021.12.17 14:43:14
客户需要参考本文档,并结合实际场景上报商品曝光、商品点击这些行为数据,进而作用于火山引擎内容定制的推荐系统。
请求方法
GET/POST(Content-Type: application/x-www-form-urlencoded)
请求url
商品曝光 https://mercury.volcengineapi.com/?Action=ProductShowLog&Version=2021-01-01 商品点击 https://mercury.volcengineapi.com/?Action=ProductClickLog&Version=2021-01-01
请求header
ServiceName:content
参数 | 描述 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
Partner | 渠道号 | String | 是 | |
AccessToken | 用户唯一标识 | String | 是 | |
GroupId | 内容id | String | 是 | 内容唯一标识,表示从哪条内容推出的这些商品 |
ProductId | 商品id | String | 是 | 客户侧的商品唯一标识 |
Category | 频道id | String | 是 | 固定传product |
EntranceForm | 进入方式 | String | 是 | related_product:详情页相关推荐卡片的上方-直接展现的内容related_product_more:相关推荐卡片的上方-点击“更多”按钮之后的“立即拥有”页面shopping_cart:页面底部浮窗-点击“立即拥有”之后的页面 |
EventTime | 事件发生时间 | long | 是 | 10位时间戳,单位:秒, 表示商品是在什么时候被曝光或者点击的。 |
Dt | 设备型号 | String | 是 | 如iphone5s、Galaxy。主要用于推荐分析,提升推荐效果 |
DeviceBrand | 设备厂商 | String | 是 | 如Apple、Samsung。主要用于推荐分析,提升推荐效果 |
Os | 操作系统 | String | 是 | 如 Android、IOS。主要用于推荐分析,提升推荐效果。 |
OsVersion | 操作系统版本 | String | 是 | 如4.0.4。主要用于推荐分析,提升推荐效果。 |
ClientVersion | 应用的版本号 | String | 是 | 比如1.0.1。主要用于数据排查,提升业务指标 |
参数 | 描述 | 类型 | 说明 |
---|---|---|---|
Result | 上报结果 | String | success:成功 |
public static void main(String[] args) { //初始化一个service LogService logService = LogServiceImpl.getInstance(); //设置ak,sk 此为请求的凭证 logService.setAccessKey("xxx"); logService.setSecretKey("xxx"); //初始化一个request ProductClickLogRequest req = new ProductClickLogRequest(); //商品曝光 //ProductShowLogRequest req = new ProductShowLogRequest(); req.setPartner("xxx"); req.setAccessToken("xxx"); req.setGroupId("6938426748178530823"); req.setProductId("2021102615430865626"); req.setCategory("product"); req.setEntranceForm("related_product"); req.setEventTime(LocalDateTime.now().toEpochSecond(ZoneOffset.of("+8"))); req.setDt("iphone6s"); req.setOs("iOS"); req.setOsVersion("12"); req.setClientVersion("7.3.25"); req.setDeviceBrand("Apple"); try { LogResponse response = logService.productClickLog(req); //商品曝光 //LogResponse response = logService.productShowLog(req); System.out.println(JSON.toJSONString(response)); } catch (Exception e) { e.printStackTrace(); } }
{ "ResponseMetadata": { "Action": "ProductClickLog", "Region": "cn-north-1", "RequestId": "20220720133852010212044019131F6A54", "Service": "content", "Version": "2021-01-01" }, "Result": "success" }
示例一:相关推荐卡片上方
示例二:详情页底部浮窗
上报场景 | 应上报event | 上报时机 |
---|---|---|
相关推荐卡片的上方-直接展现的内容 | product_show | 商品展现第一个像素即上报 |
click_product | 点击进入商品详情页 | |
相关推荐卡片的上方-点击“更多”按钮之后的“立即拥有”页面 | product_show | 商品展现第一个像素即上报 |
click_product | 点击进入商品详情页 | |
页面底部浮窗-点击“立即拥有”之后的页面 | product_show | 商品展现第一个像素即上报 |
click_product | 点击进入商品详情页 |