热门活动
全部活动
1. 接口描述
接口请求域名： irp.tencentcloudapi.com 。
获取电商类推荐结果
默认接口请求频率限制：2000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGoodsRecommend。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-05。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| InstanceId | 是 | String | 实例ID，在控制台获取 示例值：3154571c_d511 |
| SceneId | 是 | String | 场景ID，在控制台创建场景后获取 示例值：20787a_13428 |
| UserId | 是 | String | 用户唯一ID，客户自定义用户ID，作为一个用户的唯一标识，需和行为数据上报接口中的UserId一致，否则影响特征关联 示例值：2824324234 |
| UserIdList.N | 否 | Array of StrUserIdInfo | 用户设备ID数组，可传入用户的多个类型ID，用于关联画像信息 |
| GoodsCnt | 否 | Integer | 推荐返回数量，默认10个，最多支持50个的内容返回。如果有更多数量要求，提单沟通解决 示例值：10 |
| CurrentGoodsId | 否 | String | 当场景是相关推荐时该值必填，场景是非相关推荐时该值无效 示例值：f458988816c956727db5d9f |
| UserPortraitInfo | 否 | UserPortraitInfo | 用户的实时特征信息，用作特征 |
| BlackGoodsList.N | 否 | Array of String | 本次请求针对该用户需要过滤的物品列表(不超过100个) 示例值：123321 |
| Extension | 否 | String | json字符串，扩展字段 示例值："" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataList | Array of RecGoodsData | 推荐返回的商品信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取电商推荐结果
获取电商推荐结果
输入示例
输出示例
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| OperationDenied | 操作被拒绝。 |
| UnauthorizedOperation | 未授权操作。 |
