com.tencentcloudapi.irp.v20220324.models

Class RecommendContentRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.irp.v20220324.models.RecommendContentRequest

public class RecommendContentRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
RecommendContentRequest()
RecommendContentRequest(RecommendContentRequest 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
String	getBid() Get 业务id
String	getCurrentItemId() Get 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容
Long	getItemCnt() Get 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。
String	getItemTypeRatio() Get 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可
String	getPoolId() Get 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**
String	getRecTraceId() Get 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**
Long	getResponseTimeout() Get 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms
String	getSceneId() Get 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致
UserIdInfo[]	getUserIdList() Get 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果
void	setBid(String Bid) Set 业务id
void	setCurrentItemId(String CurrentItemId) Set 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容
void	setItemCnt(Long ItemCnt) Set 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。
void	setItemTypeRatio(String ItemTypeRatio) Set 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可
void	setPoolId(String PoolId) Set 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**
void	setRecTraceId(String RecTraceId) Set 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**
void	setResponseTimeout(Long ResponseTimeout) Set 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms
void	setSceneId(String SceneId) Set 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致
void	setUserIdList(UserIdInfo[] UserIdList) Set 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果
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

RecommendContentRequest

public RecommendContentRequest()

RecommendContentRequest

public RecommendContentRequest(RecommendContentRequest 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

getBid

public String getBid()

Get 业务id

Returns:

Bid 业务id

setBid

public void setBid(String Bid)

Set 业务id

Parameters:

Bid - 业务id

getSceneId

public String getSceneId()

Get 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致

Returns:

SceneId 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致

setSceneId

public void setSceneId(String SceneId)

Set 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致

Parameters:

SceneId - 场景id：比如有“猜你喜欢”，“热门内容”等推荐模块，每一个模块都有一个scene_id来表示。 在控制台创建场景后获取。需要跟行为上报时的id一致

getUserIdList

public UserIdInfo[] getUserIdList()

Get 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果

Returns:

UserIdList 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果

setUserIdList

public void setUserIdList(UserIdInfo[] UserIdList)

Set 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果

Parameters:

UserIdList - 用户唯一ID数组，每个数组元素详见userId结构体，若不填，则接口返回热门结果

getRecTraceId

public String getRecTraceId()

Get 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**

Returns:

RecTraceId 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**

setRecTraceId

public void setRecTraceId(String RecTraceId)

Set 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**

Parameters:

RecTraceId - 会话id：必须和行为数据上报时所填写的traceId相同，用于行为数据来自于那次在线推荐请求的归因。**注意：此处如果没传，则响应会返回一个全局唯一ID返回给客户，并需客户透传给行为日志上报接口**

getItemCnt

public Long getItemCnt()

Get 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。

Returns:

ItemCnt 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。

setItemCnt

public void setItemCnt(Long ItemCnt)

Set 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。

Parameters:

ItemCnt - 推荐数量：物料优选的结果， 默认50个，目前最多支持200个的内容返回，如果返回个数更多，会影响性能，容易超时。

getPoolId

public String getPoolId()

Get 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**

Returns:

PoolId 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**

setPoolId

public void setPoolId(String PoolId)

Set 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**

Parameters:

PoolId - 物料池id，用于召回该pool_id下的商品，如果有多个，用英文;分割。**注意：此处poolId需和物料上报时的poolIdList对应上**

getCurrentItemId

public String getCurrentItemId()

Get 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容

Returns:

CurrentItemId 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容

setCurrentItemId

public void setCurrentItemId(String CurrentItemId)

Set 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容

Parameters:

CurrentItemId - 来源物料id，即用户当前浏览的物料id，用于在内容详情页获取关联推荐内容

getResponseTimeout

public Long getResponseTimeout()

Get 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms

Returns:

ResponseTimeout 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms

setResponseTimeout

public void setResponseTimeout(Long ResponseTimeout)

Set 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms

Parameters:

ResponseTimeout - 请求响应超时时间，单位ms，默认300ms，数值设置的过小，会影响推荐效果，最小支持250ms

getItemTypeRatio

public String getItemTypeRatio()

Get 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可

Returns:

ItemTypeRatio 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可

setItemTypeRatio

public void setItemTypeRatio(String ItemTypeRatio)

Set 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可

Parameters:

ItemTypeRatio - 返回结果中不同物料类型的比例，比例顺序需严格按照（图文，长视频，短视频，小视频）进行。只允许传[0,100]数字，多个请用**英文冒号**分割，且加起来不能超过100，以及比例数量不能超过**场景绑定的物料类型**（图文，长视频，短视频，小视频）数。**示例：**图文和短视频比例为40%:60%时，则填40:60图文和短视频比例为0%:100%时，则填0:100图文，长视频和短视频的比例为，图文占20%，剩余80%由长视频和短视频随机返回，则填20:80或仅填20均可

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel