ProductShowLog - 商品曝光--内容定制-火山引擎

文档中心

导航

ProductShowLog - 商品曝光

最近更新时间：2024.05.28 18:13:35首次发布时间：2024.05.28 18:13:35

结合实际场景上报商品曝光行为数据，进而作用于火山引擎内容定制的推荐系统。

使用场景

上报场景	应上报event	API	上报时机
相关推荐卡片的上方-直接展现的内容	product_show	商品曝光	商品展现第一个像素即上报
相关推荐卡片的上方-直接展现的内容	click_product	商品点击	点击进入商品详情页
相关推荐卡片的上方-点击“更多”按钮之后的“立即拥有”页面	product_show	商品曝光	商品展现第一个像素即上报
相关推荐卡片的上方-点击“更多”按钮之后的“立即拥有”页面	click_product	商品点击	点击进入商品详情页
页面底部浮窗-点击“立即拥有”之后的页面	product_show	商品曝光	商品展现第一个像素即上报
页面底部浮窗-点击“立即拥有”之后的页面	click_product	商品点击	点击进入商品详情页

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=ProductShowLog&Version=2021-01-01
请求头：ServiceName:content

效果示例

示例一：相关推荐卡片上方

示例二：详情页底部浮窗

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ProductShowLog	要执行的操作，取值：ProductShowLog。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号。
AccessToken	String	是	AT6zTZuXzffKpQamerBKVv8mp9xxx2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。
GroupId	String	是	7366891164987048482	内容id，内容唯一标识，表示从哪条内容推出的这些商品。
ProductId	String	是	ProductId	商品id，客户侧的商品唯一标识。
Category	String	是	product	频道id，固定传product。
EntranceForm	String	是	related_product	进入方式。 related_product：详情页相关推荐卡片的上方-直接展现的内容； related_product_more：相关推荐卡片的上方-点击“更多”按钮之后的“立即拥有”页面； shopping_cart：页面底部浮窗-点击“立即拥有”之后的页面。
EventTime	Long	是	1716457710	事件发生时间，10位时间戳，单位：秒。表示商品是在什么时候被曝光或者点击的。
Dt	String	否	iphone15	设备型号，如iphone15、Galaxy。主要用于推荐分析，提升推荐效果。
DeviceBrand	String	否	Apple	设备厂商，如Apple、Samsung。主要用于推荐分析，提升推荐效果。
Os	String	否	iOS	操作系统，如 Android、iOS。主要用于推荐分析，提升推荐效果。
OsVersion	String	否	4.0.4	操作系统版本，如4.0.4。主要用于推荐分析，提升推荐效果。
ClientVersion	String	否	1.0.1	应用的版本号，比如1.0.1。主要用于数据排查，提升业务指标。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Result	String	success	上报结果，success：成功。

请求示例

GET /?Action=ProductShowLog&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzffKpQamerBKVv8mp9xxx2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&GroupId=7366891164987048482&ProductId=ProductId&Category=product&EntranceForm=related_product&EventTime=1716457710 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=ProductShowLog&Version=2021-01-01
X-Date: 20240523T101142Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240523/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240523181159128172052088DBE8B2",
    "Action": "ProductShowLog",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。