查詢頻道商品配置

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

介面描述

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

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

範例

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

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	請求失敗時為空，請求成功時為商品設定資訊【詳見data欄位說明】

data欄位說明

參數名	類型	說明
productExplainEnabled	String	商品講解開關(Y-開，N-關)
productExplainingAutoPushAndSticky	String	商品講解中自動推送和置頂開關(Y-開，N-關)
productPushRule	String	推送規則(smallCard-小卡片，bigCard-大卡片，chooseCard-推送時選擇)
productListSortType	String	頻道商品庫列表排序(ASC-升序, DESC-降序[預設])
productTagSortType	String	商品標籤排序方式(DEFAULT-預設排序,CUSTOM-自訂排序)
productHotEffectEnabled	String	商品熱賣特效開關(Y-開，N-關)
normalProductHotEffectTips	String	一般商品熱賣提示
jobProductHotEffectTips	String	職位商品熱賣提示
financeProductHotEffectTips	String	金融商品熱賣提示
pushingProduct	Object	推送中的商品【詳見ChannelProductPushingStatusVO】
productTagSortOrderIds	Array	商品關聯標籤列表
productTagSortOrderIdNames	Array	商品關聯標籤名稱列表

ChannelProductPushingStatusVO

參數名	類型	說明
productId	Integer	商品ID
pushRule	String	推送規則

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 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
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "9bedc2b44dcc4fdb8db8352905a17993.71.17270604205500043",
    "data": {
        "productPushRule": "smallCard",
        "productHotEffectEnabled": "Y",
        "normalProductHotEffectTips": "热卖中",
        "jobProductHotEffectTips": "投送中",
        "financeProductHotEffectTips": "选购中"
    },
    "success": true
}

異常範例

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