> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/v-4/channel/product-setting/get_product_setting.md).

# 查询频道商品配置

### 接口描述

```
1、查询频道商品配置
2、接口支持https协议
```

### 接口URL

```
https://api.polyv.net/live/v4/channel/product/push/rule
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=https:/api.polyv.net/live/v4/channel/product/push/rule/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |

### 示例

```requestUrl
https://api.polyv.net/live/v4/channel/product/push/rule?appId=frlr1zazn3&sign=4049473DAEBBEFF778DABD1A25E3409B&channelId=2779045&timestamp=1642732753732
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                          |
| ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                            |
| status  | String  | 响应状态文本信息                                                                                                                                                    |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                           |
| data    | Object  | 请求失败时为空，请求成功时为商品设置信息 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/v4/channel/get_product_setting.md?id=data字段说明)】 |

#### data字段说明

| 参数名                         | 类型     | 说明                                                                         |
| --------------------------- | ------ | -------------------------------------------------------------------------- |
| productPushRule             | String | 推送规则（smallCard：小卡片，bigCard：大卡片，chooseCard：推送时选择）                           |
| productLinkJumpTipEnabled   | String | 商品跳转提示语开关                                                                  |
| productLinkJumpTipDetail    | Object | 商品跳转提示语设置【详见[productLinkJumpTipDetail字段说明](#productLinkJumpTipDetail参数描述)】 |
| productHotEffectEnabled     | String | 商品热卖特效开关                                                                   |
| normalProductHotEffectTips  | String | 普通商品热卖提示                                                                   |
| jobProductHotEffectTips     | String | 职位商品热卖提示                                                                   |
| financeProductHotEffectTips | String | 金融商品热卖提示                                                                   |

#### productLinkJumpTipDetail字段说明

| 参数名                 | 类型     | 说明        |
| ------------------- | ------ | --------- |
| ordinaryProductTip  | String | 普通商品跳转提示语 |
| financialProductTip | String | 金融商品跳转提示语 |
| jobProductTip       | String | 职位商品跳转提示语 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道商品设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetProductSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/product/push/rule";
    String channelId = "2779045";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道商品配置，返回值：{}", response);
    //do somethings
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "code": 200,
    "status": "success",
    "requestId": "9bedc2b44dcc4fdb8db8352905a17993.71.17270604205500043",
    "data": {
        "productPushRule": "smallCard",
        "productLinkJumpTipEnabled": "N",
        "productLinkJumpTipDetail": {
            "ordinaryProductTip": "查看了",
            "financialProductTip": "购买4444了",
            "jobProductTip": "投递了"
        },
        "productHotEffectEnabled": "Y",
        "normalProductHotEffectTips": "热卖中",
        "jobProductHotEffectTips": "投送中",
        "financeProductHotEffectTips": "选购中"
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```