You need to enable JavaScript to run this app.
导航
内容定制
  • 文档首页
    • /
  • 内容定制

数据回传

最近更新时间：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内容idString是内容唯一标识，表示从哪条内容推出的这些商品
ProductId商品idString是客户侧的商品唯一标识
Category频道idString是固定传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上报结果Stringsuccess：成功

请求示例

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点击进入商品详情页