DislikeInfo
不喜欢信息
被如下接口引用：ReportFeedUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 过滤的类别： ● author 作者名 （如当前类型不满足，请提单沟通解决方案） 示例值：author |
| Value | String | 是 | Type对应字段名的值，如：需要过滤的作者名 示例值：123 |
DocItem
信息流内容
被如下接口引用：ReportFeedItem。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ItemId | String | 是 | 内容唯一id，建议限制在128字符以内 示例值：1001 |
| ItemType | String | 是 | 内容类型： ● article -图文 ● text -纯文本 ● video -视频 ● short_video -时长15秒以内的视频 ● mini_video -竖屏视频 ● image -纯图片 （如当前类型不满足，请登录控制台进入对应项目，在物料管理->物料类型管理中添加） 示例值：article |
| Status | Integer | 是 | 内容状态： ● 1 - 上架 ● 2 - 下架 Status=2的内容不会在推荐结果中出现 需要下架内容时，把Status的值修改为2即可 示例值：1 |
| PublishTimestamp | Integer | 是 | 内容生成时间，秒级时间戳（1639624786），需大于0，用作特征和物料管理 示例值：1639624786 |
| ExpireTimestamp | Integer | 否 | 内容过期时间，秒级时间戳（1639624786），如未填，则默认PublishTimestamp往后延一年，用作特征，过期则不会被推荐，强烈建议 示例值：1642668637 |
| CategoryLevel | Integer | 否 | 类目层级数，例如3级类目，则填3，和CategoryPath字段的类数据匹配，强烈建议 示例值：3 |
| CategoryPath | String | 否 | 类目路径，一级二级三级等依次用英文冒号联接，和CategoryLevel字段值匹配，如体育：“足球:巴塞罗那”。用于物料池管理，强烈建议 示例值：体育:足球:巴塞罗纳 |
| Tags | String | 否 | 内容标签，多个标签用英文冒号联接，用作特征，强烈建议 示例值：科技:娱乐 |
| Author | String | 否 | 作者名，需保证作者名唯一，若有重名需要加编号区分。用于召回过滤、规则打散，强烈建议 示例值：广州天气 |
| SourceId | String | 否 | 内容来源类型，客户自定义，用于物料池管理 示例值：1 |
| Title | String | 否 | 内容标题，主要用于语义分析 示例值：广州未来24小时有雨 |
| Content | String | 否 | 正文关键片段，建议控制在500字符以内，主要用于语义分析 示例值：广州未来24小时有雨，请做好防范 |
| ContentUrl | String | 否 | 正文详情，主要用于语义分析，当内容过大时建议用ContentUrl传递，与Content可二选一 示例值：https://sm.ms/** |
| VideoDuration | Integer | 否 | 视频时长，时间秒，大于等于0，小于 3600 * 10。视频内容必填，其它内容非必填，用作特征 示例值：60 |
| Country | String | 否 | 国家，ISO 3166-1 alpha-2编码，参考ISO 3166-1 alpha-2，中国：“CN”，用作特征 示例值：CN |
| Province | String | 否 | 省份，ISO 3166-2行政区编码，如中国参考ISO_3166-2:CN，广东省：“CN-GD”，用作特征 示例值：CN-GD |
| City | String | 否 | 城市地区，统一用国家最新标准地区行政编码，如：2020年行政区编码，其他国家统一用国际公认城市简称或者城市编码，用作特征 示例值：440100 |
| AuthorFans | Integer | 否 | 作者粉丝数，用作特征 示例值：10 |
| AuthorLevel | String | 否 | 作者评级，用作特征 示例值：高级 |
| CollectCnt | Integer | 否 | 内容累计收藏次数，用作特征 示例值：10 |
| PraiseCnt | Integer | 否 | 内容累积点赞次数，用作特征 示例值：11 |
| CommentCnt | Integer | 否 | 内容累计评论次数，用作特征 示例值：12 |
| ShareCnt | Integer | 否 | 内容累计分享次数，用作特征 示例值：13 |
| RewardCnt | Integer | 否 | 内容累积打赏数，用作特征 示例值：14 |
| Score | Float | 否 | 内容质量评分，用作特征 示例值：9.7 |
| Extension | String | 否 | json字符串，用于物料池管理的自定义扩展，需要base64加密 示例值："" |
FeedBehaviorInfo
信息流行为
被如下接口引用：ReportFeedBehavior。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识 示例值：3154571 |
| ItemId | String | 是 | 内容唯一id 示例值：2824324234 |
| BehaviorType | String | 是 | 行为类型： ● expose - 曝光，必须 ● click - 点击，必须 ● stay - 详情页停留时长，强烈建议 ● videoover - 视频播放时长，强烈建议 ● like - 点赞&喜欢，正效果 ● collect - 收藏，正效果 ● share - 转发&分享，正效果 ● reward - 打赏，正效果 ● unlike - 踩&不喜欢，负效果 ● comment - 评论 不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为 示例值：expose |
| BehaviorValue | String | 是 | 行为类型对应的行为值： ● expose - 曝光，固定填1 ● click - 点击，固定填1 ● stay - 详情页停留时长，填停留秒数，取值[1-86400] ● videoover - 视频播放时长，填播放结束的秒数，取值[1-86400] ● like - 点赞&喜欢，固定填1 ● collect - 收藏，固定填1 ● share - 转发&分享，固定填1 ● reward - 打赏，填打赏金额，没有则填1 ● unlike - 踩&不喜欢，填不喜欢的原因，没有则填1 ● comment - 评论，填评论内容，如“上海加油” 示例值：expose |
| BehaviorTimestamp | Integer | 是 | 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性 示例值：1652705901 |
| SceneId | String | 是 | 行为发生的场景ID，在控制台创建场景后获取 示例值：db5ccd_765291 |
| ItemTraceId | String | 是 | 推荐追踪ID，使用推荐结果中返回的ItemTraceId填入。 注意：如果和推荐结果中的ItemTraceId不同，会影响行为特征归因，影响推荐算法效果 示例值：9994f7bc21231288365e0f773 |
| ItemType | String | 否 | 内容类型，跟内容上报类型一致，用于效果分析，不做内容校验，强烈建议 示例值：article |
| ReferrerItemId | String | 否 | 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议 示例值：2824324234 |
| UserIdList | Array of UserIdInfo | 否 | 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息 |
| Source | String | 否 | 算法来源： ● business 业务自己的算法对照组 ● tencent 腾讯算法 ● other 其他算法 默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证 示例值：tencent |
| Country | String | 否 | 行为发生时的国家，ISO 3166-1 alpha-2编码，参考ISO 3166-1 alpha-2，中国：“CN”，用作特征 示例值：CN |
| Province | String | 否 | 行为发生时的省份，ISO 3166-2行政区编码，如中国参考ISO_3166-2:CN，广东省：“CN-GD”，用作特征 示例值：CN-GD |
| City | String | 否 | 行为发生时的城市地区，统一用国家最新标准地区行政编码，如：2020年行政区编码，其他国家统一用国际公认城市简称或者城市编码，用作特征 示例值：440100 |
| IP | String | 否 | 行为发生时的客户端ip，用作特征 示例值：127.0.0.1 |
| Network | String | 否 | 行为发生时的客户端网络类型，用作特征 示例值：wifi |
| Platform | String | 否 | 行为发生时的客户端平台，ios/android/h5，用作特征 示例值：android |
| AppVersion | String | 否 | 行为发生时的客户端app版本，用作特征 示例值：1.0 |
| OsVersion | String | 否 | 行为发生时的操作系统版本，用作特征 示例值：7.2 |
| DeviceModel | String | 否 | 行为发生时的机型，用作特征 示例值：xiaomi |
| Extension | String | 否 | json字符串，用于行为数据的扩展，需要base64加密 示例值："" |
FeedUserInfo
信息流用户信息
被如下接口引用：ReportFeedUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识 示例值：2824324234 |
| UserIdList | Array of UserIdInfo | 否 | 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息 |
| Tags | String | 否 | 用户标签，多个标签用英文冒号联接，用作特征，强烈建议 |
| DislikeInfoList | Array of DislikeInfo | 否 | 过滤列表，会在推荐结果里过滤掉这类内容 |
| Age | Integer | 否 | 用户年龄 示例值：22 |
| Gender | Integer | 否 | 用户性别： 0 - 未知 1 - 男 2 - 女 示例值：1 |
| Degree | String | 否 | 用户学历 ：小学，初中，高中，大专，本科，硕士，博士 示例值：本科 |
| School | String | 否 | 用户毕业学校全称 示例值：xx大学 |
| Occupation | String | 否 | 用户职业 示例值：销售 |
| Industry | String | 否 | 用户所属行业 示例值：互联网 |
| ResidentCountry | String | 否 | 用户常驻国家，ISO 3166-1 alpha-2编码，参考ISO 3166-1 alpha-2，中国：“CN” 示例值：CN |
| ResidentProvince | String | 否 | 用户常驻省份，ISO 3166-2行政区编码，如中国参考ISO_3166-2:CN，广东省：“CN-GD” 示例值：CN-GD |
| ResidentCity | String | 否 | 用户常驻城市，统一用国家最新标准地区行政编码，如：2020年行政区编码， 示例值：444100 |
| RegisterTimestamp | Integer | 否 | 用户注册时间，秒级时间戳（1639624786） 示例值：1639624786 |
| MembershipLevel | String | 否 | 用户会员等级 示例值：10 |
| LastLoginTimestamp | Integer | 否 | 用户上一次登录时间，秒级时间戳（1639624786） 示例值：1639624786 |
| LastLoginIp | String | 否 | 用户上一次登录的ip 示例值：127.0.0.1 |
| LastModifyTimestamp | Integer | 否 | 用户信息的最后修改时间戳，秒级时间戳（1639624786） 示例值：1639624786 |
| Extension | String | 否 | json字符串，用于画像数据的扩展，需要base64加密 |
GoodsBehaviorInfo
电商行为
被如下接口引用：ReportGoodsBehavior。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 是 | 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识 示例值：3154571 |
| GoodsId | String | 是 | 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度 示例值：2824324234 |
| BehaviorType | String | 是 | 行为类型： ● expose - 曝光，必须 ● click - 点击，必须 ● stay - 详情页停留时长，强烈建议 ● videoover - 视频播放时长，强烈建议 ● like - 点赞&喜欢，正效果 ● collect - 收藏，正效果 ● share - 转发&分享，正效果 ● reward - 打赏，正效果 ● unlike - 踩&不喜欢，负效果 ● comment - 评论 ● order - 下单 ● buy - 购买成功 ● addcart - 加入购物车 不支持的行为类型，可以映射到未被使用的其他行为类型。如实际业务数据中有私信行为，没有收藏行为，可以将私信行为映射到收藏行为 示例值：expose |
| BehaviorValue | String | 是 | 行为类型对应的行为值： ● 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 示例值：expose |
| BehaviorTimestamp | Integer | 是 | 行为发生的时间戳： 秒级时间戳，尽量实时上报，最长不超过半小时否则会影响推荐结果的准确性 示例值：1652705901 |
| SceneId | String | 是 | 行为发生的场景ID，在控制台创建场景后获取 示例值：db5ccd_765291 |
| Source | String | 是 | 算法来源： ● business 业务自己的算法对照组 ● tencent 腾讯算法 ● other 其他算法 默认为tencent，区分行为来源于哪个算法，用于Poc阶段的效果对比验证 示例值：tencent |
| Page | String | 否 | 标识行为发生在app内哪个页面，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如首页，发现页，用户中心等 用作上下文特征，刻画不同场景用户行为分布的差异 示例值：fpage |
| Module | String | 否 | 标识行为发生在页面的哪一区块，取值客户自定，可以是明文或id，建议传明文便于理解、分析，如横幅、广告位、猜你喜欢等 用作上下文特征，刻画不同模块用户行为分布的差异 示例值：guess_you_like |
| GoodsTraceId | String | 否 | 推荐追踪ID，使用推荐结果中返回的GoodsTraceId填入。 注意：如果和推荐结果中的GoodsTraceId不同，会影响行为特征归因，影响推荐算法效果。强烈建议 示例值：9994f7bc21231288365e0f773 |
| ReferrerGoodsId | String | 否 | 相关推荐场景点击进入详情页的内容id，该字段用来注明行为发生于哪个内容的详情页推荐中，相关推荐场景强烈建议 示例值：2824324234 |
| OrderGoodsCnt | Integer | 否 | 订单商品购买个数，当behaviorType=order，buy或addcart时有值，用作特征 示例值：2 |
| OrderAmount | Float | 否 | 订单总金额，当behaviorType=order或buy时有值（单位：元，统一货币体系，如统一为RMB，美元等），用作特征 示例值：9.97 |
| UserIdList | Array of StrUserIdInfo | 否 | 用户设备ID数组，可传入用户的多个类型ID，详见UserIdInfo结构体，建议补齐，用于构建用户画像信息 |
| UserPortraitInfo | UserPortraitInfo | 否 | 行为发生时用户基础特征信息，用作特征 |
| Position | Integer | 否 | 标识行为发生在模块内的具体位置，如1、2、... 用作上下文特征，刻画不同位置用户行为分布的差异 示例值：1 |
| Extension | String | 否 | json字符串，用于行为数据的扩展 示例值："" |
GoodsInfo
电商物料内容
被如下接口引用：ReportGoodsInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| GoodsId | String | 是 | 商品唯一ID，skuId或spuId，客户根据需求自行决定商品主键粒度。建议限制在128字符以内 示例值：1001 |
| GoodsType | String | 是 | 商品物料展示类型： ● article -图文 ● text -纯文本 ● video -视频 ● short_video -时长15秒以内的视频 ● mini_video -竖屏视频 ● image -纯图片 （如当前类型不满足，请提单沟通解决方案） 示例值：article |
| Status | Integer | 是 | 商品状态： ● 1 - 上架 ● 2 - 下架 Status=2的内容不会在推荐结果中出现 需要下架内容时，把Status的值修改为2即可 示例值：1 |
| PublishTimestamp | Integer | 是 | 商品生成时间，秒级时间戳（1639624786），需大于0，用作特征和物料管理 示例值：1639624786 |
| ExpireTimestamp | Integer | 否 | 商品过期时间，秒级时间戳（1639624786），如未填，则默认PublishTimestamp往后延一年，用作特征，过期则不会被推荐，强烈建议 示例值：1642668637 |
| SpuId | String | 否 | spu((Standard Product Unit))维度id，商品聚合信息的最小单位，强烈建议 示例值：2413123 |
| CategoryLevel | Integer | 否 | 类目层级数，例如3级类目，则填3，和CategoryPath字段的类数据匹配，强烈建议 示例值：3 |
| CategoryPath | String | 否 | 类目路径，一级二级三级等依次用英文冒号联接，和CategoryLevel字段值匹配，如体育：“女装:裙子:半身裙”。用于物料池管理，强烈建议 示例值：女装:裙子:半身裙 |
| Title | String | 否 | 商品标题，主要用于语义分析，强烈建议 示例值：修身连衣裙 |
| Tags | String | 否 | 商品标签，多个标签用英文冒号联接，用作特征，强烈建议 示例值：科技:娱乐 |
| Brand | String | 否 | 商品对应的品牌，取值用户自定义，可以是品牌id或品牌明文，用作特征以及打散/过滤规则，强烈建议 示例值：huawei |
| ShopId | String | 否 | 商品所属店铺ID，取值客户自定义，用作特征，强烈建议 示例值：123212 |
| OrgPrice | Float | 否 | 商品原始价格（单位：元，统一货币体系，如统一为RMB或美元等），用作特征，强烈建议 示例值：9.9 |
| CurPrice | Float | 否 | 商品当前价格（单位：元，统一货币体系，如统一为RMB或美元等），用作特征，强烈建议 示例值：9.5 |
| SourceId | String | 否 | 商品来源类型，客户自定义，用于物料池管理 示例值：1 |
| Content | String | 否 | 商品正文关键片段，建议控制在500字符以内，主要用于语义分析 示例值：修身可爱连衣裙 |
| ContentUrl | String | 否 | 商品正文详情，主要用于语义分析，当内容过大时建议用ContentUrl传递，与Content可二选一 示例值：https://sm.ms/** |
| PicUrlList | Array of String | 否 | 商品封面url，不超过10个，用作特征 示例值：http://p3.itc.cn/images01/20201021/080c89113d5a4b52b19f803582467 |
| Country | String | 否 | 卖家所在国家，ISO 3166-1 alpha-2编码，参考ISO 3166-1 alpha-2，中国：“CN”，用作特征 示例值：CN |
| Province | String | 否 | 卖家所在省份，ISO 3166-2行政区编码，如中国参考ISO_3166-2:CN，广东省：“CN-GD”，用作特征 示例值：CN-GD |
| City | String | 否 | 卖家所在城市地区，统一用国家最新标准地区行政编码，如：2020年行政区编码，其他国家统一用国际公认城市简称或者城市编码，用作特征 示例值：440100 |
| FreeShipping | Integer | 否 | 商品是否包邮；1:包邮；2:不包邮；3:满足条件包邮，用作特征 示例值：1 |
| ShippingPrice | Float | 否 | 商品邮费（单位：元，统一货币体系，如统一为RMB或美元等），用作特征 示例值：10.1 |
| PraiseCnt | Integer | 否 | 商品累计好评次数，用作特征 示例值：1231 |
| CommentCnt | Integer | 否 | 商品累计评论次数，用作特征 示例值：232 |
| ShareCnt | Integer | 否 | 商品累计分享次数，用作特征 示例值：12 |
| CollectCnt | Integer | 否 | 商品累计收藏次数，用作特征 示例值：23 |
| OrderCnt | Integer | 否 | 商品累积成交次数，用作特征 示例值：12 |
| Score | Float | 否 | 商品平均客户评分，取值范围用户自定，用作特征 示例值：3.6 |
| Extension | String | 否 | json字符串，用于物料池管理的自定义扩展 示例值："" |
RecGoodsData
推荐返回的内容信息
被如下接口引用：DescribeGoodsRecommend。
| 名称 | 类型 | 描述 |
|---|---|---|
| GoodsId | String | 推荐返回的商品ID 示例值：20220324V08431** |
| Score | Float | 推荐结果分，取值范围[0,1000000] 注意：此字段可能返回 null，表示取不到有效值。 示例值：6.1 |
| GoodsTraceId | String | 推荐追踪id，本次推荐内容产生的后续行为上报均要用该GoodsTraceId上报。每次接口调用返回的GoodsTraceId不同 注意：此字段可能返回 null，表示取不到有效值。 示例值：9588983c6db7a36734d628537fb26463 |
| Position | Integer | 商品所在位置 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
RecItemData
推荐返回的内容信息
被如下接口引用：FeedRecommend。
| 名称 | 类型 | 描述 |
|---|---|---|
| ItemId | String | 推荐的内容ID 示例值：20220324V08431** |
| ItemType | String | 内容类型，同内容上报类型一致 注意：此字段可能返回 null，表示取不到有效值。 示例值：article |
| ItemTraceId | String | 推荐追踪id，本次推荐内容产生的后续行为上报均要用该ItemTraceId上报。每次接口调用返回的ItemTraceId不同 注意：此字段可能返回 null，表示取不到有效值。 示例值：2824324234 |
| Score | Float | 推荐预测分，分值越高被推荐的理由越充分，取值范围[0,1000000]，用于做二次排序的参考 注意：此字段可能返回 null，表示取不到有效值。 示例值：6.1 |
StrUserIdInfo
用户信息
被如下接口引用：DescribeGoodsRecommend, ReportGoodsBehavior。
| 名称 | 类型 | 必选 | 描述 |
|---|
UserIdInfo
用户ID信息
被如下接口引用：FeedRecommend, ReportFeedBehavior, ReportFeedUser。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 用户ID类型： ● qq: qq号码 ● qq_md5：qq的md5值 ● imei：设备imei ● imei_md5：imei的md5值 ● idfa: Apple 向用户设备随机分配的设备标识符 ● idfa_md5：idfa的md5值 ● oaid：安卓10之后一种非永久性设备标识符 ● oaid_md5：md5后的oaid ● wx_openid：微信openid ● qq_openid：QQ的openid ● phone：电话号码 ● phone_md5：md5后的电话号码 ● phone_sha256：SHA256加密的手机号 ● phone_sm3：国密SM3加密的手机号 （如当前类型不满足，请提单沟通解决方案） 示例值：qq_md5 |
| Value | String | 是 | 用户ID值 示例值：9748a023ecbe626bb066c75a0cb27d5b |
UserPortraitInfo
用户基础画像
被如下接口引用：DescribeGoodsRecommend, ReportGoodsBehavior。
| 名称 | 类型 | 必选 | 描述 |
|---|
