Class: TencentCloud::Irp::V20220324::RecommendContentRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20220324/models.rb

Overview

RecommendContent请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bid = nil, sceneid = nil, useridlist = nil, rectraceid = nil, itemcnt = nil, poolid = nil, currentitemid = nil, responsetimeout = nil, itemtyperatio = nil) ⇒ RecommendContentRequest

Returns a new instance of RecommendContentRequest.



542
543
544
545
546
547
548
549
550
551
552
# File 'lib/v20220324/models.rb', line 542

def initialize(bid=nil, sceneid=nil, useridlist=nil, rectraceid=nil, itemcnt=nil, poolid=nil, currentitemid=nil, responsetimeout=nil, itemtyperatio=nil)
  @Bid = bid
  @SceneId = sceneid
  @UserIdList = useridlist
  @RecTraceId = rectraceid
  @ItemCnt = itemcnt
  @PoolId = poolid
  @CurrentItemId = currentitemid
  @ResponseTimeout = responsetimeout
  @ItemTypeRatio = itemtyperatio
end

Instance Attribute Details

#BidObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def Bid
  @Bid
end

#CurrentItemIdObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def CurrentItemId
  @CurrentItemId
end

#ItemCntObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def ItemCnt
  @ItemCnt
end

#ItemTypeRatioObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def ItemTypeRatio
  @ItemTypeRatio
end

#PoolIdObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def PoolId
  @PoolId
end

#RecTraceIdObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def RecTraceId
  @RecTraceId
end

#ResponseTimeoutObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def ResponseTimeout
  @ResponseTimeout
end

#SceneIdObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def SceneId
  @SceneId
end

#UserIdListObject

Parameters:

  • Bid:

    业务id

  • SceneId:

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

  • UserIdList:

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

  • RecTraceId:

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

  • ItemCnt:

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

  • PoolId:

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

  • CurrentItemId:

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

  • ResponseTimeout:

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

  • ItemTypeRatio:

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



540
541
542
# File 'lib/v20220324/models.rb', line 540

def UserIdList
  @UserIdList
end

Instance Method Details

#deserialize(params) ⇒ Object



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/v20220324/models.rb', line 554

def deserialize(params)
  @Bid = params['Bid']
  @SceneId = params['SceneId']
  unless params['UserIdList'].nil?
    @UserIdList = []
    params['UserIdList'].each do |i|
      useridinfo_tmp = UserIdInfo.new
      useridinfo_tmp.deserialize(i)
      @UserIdList << useridinfo_tmp
    end
  end
  @RecTraceId = params['RecTraceId']
  @ItemCnt = params['ItemCnt']
  @PoolId = params['PoolId']
  @CurrentItemId = params['CurrentItemId']
  @ResponseTimeout = params['ResponseTimeout']
  @ItemTypeRatio = params['ItemTypeRatio']
end