修改頻道商品配置

更新時間：2025-04-10 11:28:24

介面描述

1、修改频道商品配置
2、接口支持https协议

介面URL

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

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看 2、若參數不正確則會回應400異常

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	Integer	頻道號

請求體參數描述

參數名	必選	類型	說明
productExplainEnabled	false	String	商品講解開關(Y-開，N-關)
productExplainingAutoPushAndSticky	false	String	商品講解中自動推送和置頂開關(Y-開，N-關)
productListSortType	false	String	頻道商品庫列表排序(ASC-升序, DESC-降序[預設])
productTagSortType	false	String	商品標籤排序方式(DEFAULT-預設排序,CUSTOM-自訂排序)
productPushRule	false	String	推送規則(smallCard-小卡片，bigCard-大卡片，chooseCard-推送時選擇)
productHotEffectEnabled	false	String	商品熱賣特效開關
normalProductHotEffectTips	false	String	商品熱賣特效提示
jobProductHotEffectTips	false	String	職位商品熱賣特效提示
financeProductHotEffectTips	false	String	金融商品熱賣特效提示
outLinkProductRedirectEnabled	false	String	外鏈購買，是否直接跳轉(Y-直接跳轉，N-查看商品詳情)
productTagSortOrderIds	false	Array	商品關聯標籤 ID 列表

範例

http://api.polyv.net/live/v4/channel/product/push/rule?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=2974342

請求體json參數：

{
    "productExplainEnabled": "N",
    "productExplainingAutoPushAndSticky":"N",
    "productListSortType":"ASC",
    "productTagSortType":"DEFAULT",    
    "productPushRule": "smallCard",
    "productHotEffectEnabled": "Y",
    "normalProductHotEffectTips": "热卖中",
    "jobProductHotEffectTips": "投送中",
    "financeProductHotEffectTips": "选购中",
    "outLinkProductRedirectEnabled": "Y",
    "productTagSortOrderIds": [1,2,3]
}

回應描述

參數名	類型	說明
code	Integer	狀態碼，與 http 狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛上鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位描述】

Error回應描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道商品设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateProductSetting() 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 jsonStr = "{\"productPushRule\":\"smallCard\",\"productHotEffectEnabled\":\"Y\",\"normalProductHotEffectTips\":\"热卖中\"," +
    "\"jobProductHotEffectTips\":\"投送中\",\"financeProductHotEffectTips\":\"选购中\"}";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, jsonStr, null);
    
    log.info("测试修改频道商品配置，返回值：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "9bedc2b44dcc4fdb8db8352905a17993.74.17270604170410039",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}