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