com.tencentcloudapi.irp.v20220805.models

Class GoodsBehaviorInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.irp.v20220805.models.GoodsBehaviorInfo

public class GoodsBehaviorInfo
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GoodsBehaviorInfo()
GoodsBehaviorInfo(GoodsBehaviorInfo source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getBehaviorTimestamp() Get 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性
String	getBehaviorType() Get 行为类型： ● expose - 曝光，必须 ● click - 点击，必须 ● stay - 详情页停留时长，强烈建议 ● videoover - 视频播放时长，强烈建议 ● like - 点赞&喜欢，正效果 ● collect - 收藏，正效果 ● share - 转发&分享，正效果 ● reward - 打赏，正效果 ● unlike - 踩&不喜欢，负效果 ● comment - 评论 ● order - 下单 ● buy - 购买成功 ● addcart - 加入购物车 不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为
String	getBehaviorValue() Get 行为类型对应的行为值： ● expose - 曝光，固定填1 ● click - 点击，固定填1 ● stay - 详情页停留时长，填停留秒数，取值[1-86400] ● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400] ● like - 点赞&喜欢，固定填1 ● collect - 收藏，固定填1 ● share - 转发&分享，固定填1 ● reward - 打赏，填打赏金额，没有则填1 ● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1 ● comment - 评论，填评论内容，如“上海加油” ● order - 下单，固定填1 ● buy - 购买成功，固定填1 ● addcart - 加入购物车，固定填1
String	getExtension() Get json字符串，用于行为数据的扩展
String	getGoodsId() Get 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度
String	getGoodsTraceId() Get 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议
String	getModule() Get 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异
Float	getOrderAmount() Get 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征
Long	getOrderGoodsCnt() Get 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征
String	getPage() Get 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异
Long	getPosition() Get 标识行为发生在模块内的具体位置，如1、2、...
String	getReferrerGoodsId() Get 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议
String	getSceneId() Get 行为发生的场景ID，在控制台创建场景后获取
String	getSource() Get 算法来源： ● business 业务自己的算法对照组 ● tencent 腾讯算法 ● other 其他算法 默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证
String	getUserId() Get 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识
StrUserIdInfo[]	getUserIdList() Get 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息
UserPortraitInfo	getUserPortraitInfo() Get 行为发生时用户基础特征信息，用作特征
void	setBehaviorTimestamp(Long BehaviorTimestamp) Set 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性
void	setBehaviorType(String BehaviorType) Set 行为类型： ● expose - 曝光，必须 ● click - 点击，必须 ● stay - 详情页停留时长，强烈建议 ● videoover - 视频播放时长，强烈建议 ● like - 点赞&喜欢，正效果 ● collect - 收藏，正效果 ● share - 转发&分享，正效果 ● reward - 打赏，正效果 ● unlike - 踩&不喜欢，负效果 ● comment - 评论 ● order - 下单 ● buy - 购买成功 ● addcart - 加入购物车 不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为
void	setBehaviorValue(String BehaviorValue) Set 行为类型对应的行为值： ● expose - 曝光，固定填1 ● click - 点击，固定填1 ● stay - 详情页停留时长，填停留秒数，取值[1-86400] ● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400] ● like - 点赞&喜欢，固定填1 ● collect - 收藏，固定填1 ● share - 转发&分享，固定填1 ● reward - 打赏，填打赏金额，没有则填1 ● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1 ● comment - 评论，填评论内容，如“上海加油” ● order - 下单，固定填1 ● buy - 购买成功，固定填1 ● addcart - 加入购物车，固定填1
void	setExtension(String Extension) Set json字符串，用于行为数据的扩展
void	setGoodsId(String GoodsId) Set 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度
void	setGoodsTraceId(String GoodsTraceId) Set 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议
void	setModule(String Module) Set 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异
void	setOrderAmount(Float OrderAmount) Set 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征
void	setOrderGoodsCnt(Long OrderGoodsCnt) Set 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征
void	setPage(String Page) Set 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异
void	setPosition(Long Position) Set 标识行为发生在模块内的具体位置，如1、2、...
void	setReferrerGoodsId(String ReferrerGoodsId) Set 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议
void	setSceneId(String SceneId) Set 行为发生的场景ID，在控制台创建场景后获取
void	setSource(String Source) Set 算法来源： ● business 业务自己的算法对照组 ● tencent 腾讯算法 ● other 其他算法 默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证
void	setUserId(String UserId) Set 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识
void	setUserIdList(StrUserIdInfo[] UserIdList) Set 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息
void	setUserPortraitInfo(UserPortraitInfo UserPortraitInfo) Set 行为发生时用户基础特征信息，用作特征
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoodsBehaviorInfo

public GoodsBehaviorInfo()

GoodsBehaviorInfo

public GoodsBehaviorInfo(GoodsBehaviorInfo source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getUserId

public String getUserId()

Get 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识

Returns:

UserId 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识

setUserId

public void setUserId(String UserId)

Set 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识

Parameters:

UserId - 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识

getGoodsId

public String getGoodsId()

Get 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度

Returns:

GoodsId 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度

setGoodsId

public void setGoodsId(String GoodsId)

Set 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度

Parameters:

GoodsId - 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度

getBehaviorType

public String getBehaviorType()

Get 行为类型：
● expose - 曝光，必须
● click - 点击，必须
● stay - 详情页停留时长，强烈建议
● videoover - 视频播放时长，强烈建议
● like - 点赞&喜欢，正效果
● collect - 收藏，正效果
● share - 转发&分享，正效果
● reward - 打赏，正效果
● unlike - 踩&不喜欢，负效果
● comment - 评论
● order - 下单
● buy - 购买成功
● addcart - 加入购物车
不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为

Returns:

BehaviorType 行为类型：
● expose - 曝光，必须
● click - 点击，必须
● stay - 详情页停留时长，强烈建议
● videoover - 视频播放时长，强烈建议
● like - 点赞&喜欢，正效果
● collect - 收藏，正效果
● share - 转发&分享，正效果
● reward - 打赏，正效果
● unlike - 踩&不喜欢，负效果
● comment - 评论
● order - 下单
● buy - 购买成功
● addcart - 加入购物车
不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为

setBehaviorType

public void setBehaviorType(String BehaviorType)

Set 行为类型：
● expose - 曝光，必须
● click - 点击，必须
● stay - 详情页停留时长，强烈建议
● videoover - 视频播放时长，强烈建议
● like - 点赞&喜欢，正效果
● collect - 收藏，正效果
● share - 转发&分享，正效果
● reward - 打赏，正效果
● unlike - 踩&不喜欢，负效果
● comment - 评论
● order - 下单
● buy - 购买成功
● addcart - 加入购物车
不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为

Parameters:

BehaviorType - 行为类型：
● expose - 曝光，必须
● click - 点击，必须
● stay - 详情页停留时长，强烈建议
● videoover - 视频播放时长，强烈建议
● like - 点赞&喜欢，正效果
● collect - 收藏，正效果
● share - 转发&分享，正效果
● reward - 打赏，正效果
● unlike - 踩&不喜欢，负效果
● comment - 评论
● order - 下单
● buy - 购买成功
● addcart - 加入购物车
不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为

getBehaviorValue

public String getBehaviorValue()

Get 行为类型对应的行为值：
● expose - 曝光，固定填1
● click - 点击，固定填1
● stay - 详情页停留时长，填停留秒数，取值[1-86400]
● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400]
● like - 点赞&喜欢，固定填1
● collect - 收藏，固定填1
● share - 转发&分享，固定填1
● reward - 打赏，填打赏金额，没有则填1
● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1
● comment - 评论，填评论内容，如“上海加油”
● order - 下单，固定填1
● buy - 购买成功，固定填1
● addcart - 加入购物车，固定填1

Returns:

BehaviorValue 行为类型对应的行为值：
● expose - 曝光，固定填1
● click - 点击，固定填1
● stay - 详情页停留时长，填停留秒数，取值[1-86400]
● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400]
● like - 点赞&喜欢，固定填1
● collect - 收藏，固定填1
● share - 转发&分享，固定填1
● reward - 打赏，填打赏金额，没有则填1
● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1
● comment - 评论，填评论内容，如“上海加油”
● order - 下单，固定填1
● buy - 购买成功，固定填1
● addcart - 加入购物车，固定填1

setBehaviorValue

public void setBehaviorValue(String BehaviorValue)

Set 行为类型对应的行为值：
● expose - 曝光，固定填1
● click - 点击，固定填1
● stay - 详情页停留时长，填停留秒数，取值[1-86400]
● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400]
● like - 点赞&喜欢，固定填1
● collect - 收藏，固定填1
● share - 转发&分享，固定填1
● reward - 打赏，填打赏金额，没有则填1
● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1
● comment - 评论，填评论内容，如“上海加油”
● order - 下单，固定填1
● buy - 购买成功，固定填1
● addcart - 加入购物车，固定填1

Parameters:

BehaviorValue - 行为类型对应的行为值：
● expose - 曝光，固定填1
● click - 点击，固定填1
● stay - 详情页停留时长，填停留秒数，取值[1-86400]
● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400]
● like - 点赞&喜欢，固定填1
● collect - 收藏，固定填1
● share - 转发&分享，固定填1
● reward - 打赏，填打赏金额，没有则填1
● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1
● comment - 评论，填评论内容，如“上海加油”
● order - 下单，固定填1
● buy - 购买成功，固定填1
● addcart - 加入购物车，固定填1

getBehaviorTimestamp

public Long getBehaviorTimestamp()

Get 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性

Returns:

BehaviorTimestamp 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性

setBehaviorTimestamp

public void setBehaviorTimestamp(Long BehaviorTimestamp)

Set 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性

Parameters:

BehaviorTimestamp - 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性

getSceneId

public String getSceneId()

Get 行为发生的场景ID，在控制台创建场景后获取

Returns:

SceneId 行为发生的场景ID，在控制台创建场景后获取

setSceneId

public void setSceneId(String SceneId)

Set 行为发生的场景ID，在控制台创建场景后获取

Parameters:

SceneId - 行为发生的场景ID，在控制台创建场景后获取

getSource

public String getSource()

Get 算法来源：
● business 业务自己的算法对照组
● tencent 腾讯算法
● other 其他算法
默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证

Returns:

Source 算法来源：
● business 业务自己的算法对照组
● tencent 腾讯算法
● other 其他算法
默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证

setSource

public void setSource(String Source)

Set 算法来源：
● business 业务自己的算法对照组
● tencent 腾讯算法
● other 其他算法
默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证

Parameters:

Source - 算法来源：
● business 业务自己的算法对照组
● tencent 腾讯算法
● other 其他算法
默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证

getPage

public String getPage()

Get 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异

Returns:

Page 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异

setPage

public void setPage(String Page)

Set 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异

Parameters:

Page - 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异

getModule

public String getModule()

Get 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异

Returns:

Module 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异

setModule

public void setModule(String Module)

Set 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异

Parameters:

Module - 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异

getGoodsTraceId

public String getGoodsTraceId()

Get 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议

Returns:

GoodsTraceId 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议

setGoodsTraceId

public void setGoodsTraceId(String GoodsTraceId)

Set 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议

Parameters:

GoodsTraceId - 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议

getReferrerGoodsId

public String getReferrerGoodsId()

Get 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议

Returns:

ReferrerGoodsId 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议

setReferrerGoodsId

public void setReferrerGoodsId(String ReferrerGoodsId)

Set 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议

Parameters:

ReferrerGoodsId - 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议

getOrderGoodsCnt

public Long getOrderGoodsCnt()

Get 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征

Returns:

OrderGoodsCnt 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征

setOrderGoodsCnt

public void setOrderGoodsCnt(Long OrderGoodsCnt)

Set 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征

Parameters:

OrderGoodsCnt - 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征

getOrderAmount

public Float getOrderAmount()

Get 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征

Returns:

OrderAmount 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征

setOrderAmount

public void setOrderAmount(Float OrderAmount)

Set 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征

Parameters:

OrderAmount - 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征

getUserIdList

public StrUserIdInfo[] getUserIdList()

Get 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息

Returns:

UserIdList 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息

setUserIdList

public void setUserIdList(StrUserIdInfo[] UserIdList)

Set 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息

Parameters:

UserIdList - 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息

getUserPortraitInfo

public UserPortraitInfo getUserPortraitInfo()

Get 行为发生时用户基础特征信息，用作特征

Returns:

UserPortraitInfo 行为发生时用户基础特征信息，用作特征

setUserPortraitInfo

public void setUserPortraitInfo(UserPortraitInfo UserPortraitInfo)

Set 行为发生时用户基础特征信息，用作特征

Parameters:

UserPortraitInfo - 行为发生时用户基础特征信息，用作特征

getPosition

public Long getPosition()

Get 标识行为发生在模块内的具体位置，如1、2、... 用作上下文特征，刻画不同位置用户行为分布的差异

Returns:

Position 标识行为发生在模块内的具体位置，如1、2、... 用作上下文特征，刻画不同位置用户行为分布的差异

setPosition

public void setPosition(Long Position)

Set 标识行为发生在模块内的具体位置，如1、2、... 用作上下文特征，刻画不同位置用户行为分布的差异

Parameters:

Position - 标识行为发生在模块内的具体位置，如1、2、... 用作上下文特征，刻画不同位置用户行为分布的差异

getExtension

public String getExtension()

Get json字符串，用于行为数据的扩展

Returns:

Extension json字符串，用于行为数据的扩展

setExtension

public void setExtension(String Extension)

Set json字符串，用于行为数据的扩展

Parameters:

Extension - json字符串，用于行为数据的扩展

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel