使用方式

一、取得商品標籤列表

Api 方法： getProductTagList(params?: PageOptions): Promise<PageContent<ProductTag>>

參數說明：

• params：取得參數，PageOptions 類型，選傳，預設 {}

回傳值說明： Promise<PageContent<ProductTag>> 類型

範例：

const data = await productTarget.getProductTagList({ pageNumber: 1 });
console.log('标签列表', data.contents);

二、取得商品列表

該方法可透過 商品序號、標籤 id + 關鍵詞 兩種方式取得商品列表，

Api 方法： getProductList(params?: GetProductListParams): Promise<ProductListResult>

參數說明：

• params：取得參數，GetProductListParams 類型，選傳，預設 {}，詳細類型說明如下

回傳值說明： Promise<ProductListResult> 類型，詳細類型說明如下

範例：

// 通过商品序号获取：获取 12 号商品之后的商品列表
const data = await productTarget.getProductList({ displayNumber: 12 });

// 通过标签 id 或关键词获取：获取标签 id 为 8 的商品列表，并根据关键词 '水果' 进行搜索，页数为第 2 页
const data = await productTarget.getProductList({ tagId: 8, keyword: '水果', page: 2 });

三、取得商品列表（發起端）

Api 方法： getLaunchProductList(params: GetLaunchProductListParams): Promise<LaunchProductListResult>

參數說明：

• params：取得參數，GetLaunchProductListParams 類型，必傳，詳細類型說明如下

回傳值說明： Promise<LaunchProductListResult> 類型，詳細類型說明如下

四、取得商品資料

Api 方法： getProductData(productId: number): Promise<ProductData>

參數說明：

• productId：商品 id，number 類型，必傳

回傳值說明： Promise<ProductData> 類型

五、發送商品點擊事件

當觀眾點擊商品時，呼叫該方法發送商品點擊事件

Api 方法： sendProductClickEvent(params: SendProductClickParams): Promise<void>

參數說明：

• params：發送參數，SendProductClickParams 類型，必傳，詳細類型說明如下

範例：

await productTarget.sendProductClickEvent({
  productId: 123,
  name: '商品名称',
  productType: 'normal',
});

六、關閉目前正在推送中的商品

當需要關閉 UI 層的推送節點時，呼叫該方法關閉目前正在推送中的商品

Api 方法： closeProductPush(): void

範例：

await productTarget.closeProductPush();

七、取得商品講解開關

取得目前頻道是否開啟商品講解

Api 方法： getProductExplainEnabled(): Promise<boolean>

回傳值說明： Promise<boolean> 類型

範例：

const enabled = await productTarget.getProductExplainEnabled();
console.log('商品讲解开关', enabled);

八、產生商品講解頁面位址

Api 方法： generateProductExplainPageUrl(params?: T): Promise<null | string>

參數說明：

• params：url 攜帶參數，T 類型，選傳

回傳值說明： Promise<null | string> 類型

範例：

const url = await productTarget.generateProductExplainPageUrl({ productId: 123 });
console.log('商品讲解页面地址', url);

九、取得目前頻道是否開啟點擊「外鏈購買」商品的封面/標題區域直接跳轉外鏈

Api 方法： getOutLinkProductRedirectEnabled(): Promise<boolean>

回傳值說明： Promise<boolean> 類型

範例：

const enabled = await productTarget.getOutLinkProductRedirectEnabled();
console.log('商品点击直接跳转外链开关', enabled);

十、取得商品支付訂單是否開啟

Api 方法： getProductPayOrderEnabled(): Promise<boolean>

回傳值說明： Promise<boolean> 類型

範例：

const enabled = await productTarget.getProductPayOrderEnabled();
console.log('商品支付订单是否开启', enabled);

十一、取得商品熱賣配置

Api 方法： getProductHotSaleConfig(): Promise<undefined | ProductHotSaleConfig>

回傳值說明： Promise<undefined | ProductHotSaleConfig> 類型

範例：

const config = await productTarget.getProductHotSaleConfig();
console.log('商品热卖配置', config);

十二、取得目前推送中的商品資料

Api 方法： getCurrentPushingProduct(productId?: number): Promise<undefined | ProductData>

參數說明：

• productId：可選，指定商品ID，如果不提供則取得目前配置中的推送商品，number 類型，選傳

回傳值說明： Promise<undefined | ProductData> 類型

範例：

const productData = await productTarget.getCurrentPushingProduct();
console.log('当前推送中的商品数据', productData);

十三、開始商品講解

Api 方法： startExplain(productId: number): undefined | Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

回傳值說明： undefined | Promise<void> 類型

範例：

await productTarget.startExplain(123);

十四、重新開始商品講解

Api 方法： restartExplain(productId: number): undefined | Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

回傳值說明： undefined | Promise<void> 類型

範例：

await productTarget.restartExplain(123);

十五、結束商品講解

Api 方法： endExplain(productId: number): undefined | Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

回傳值說明： undefined | Promise<void> 類型

範例：

await productTarget.endExplain(123);

十六、刪除商品講解

Api 方法： deleteExplain(productId: number): Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

範例：

await productTarget.deleteExplain(123);

十七、取得目前正在講解的商品 id

Api 方法： getCurrentProductExplain(): Promise<null | number>

回傳值說明： Promise<null | number> 類型

範例：

const productId = await productTarget.getCurrentProductExplain();
console.log('当前正在讲解的商品 id', productId);

十八、商品開價

Api 方法： openProductPrice(productId: number): Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

範例：

await productTarget.openProductPrice(123);

十九、商品隱藏價格

Api 方法： hideProductPrice(productId: number): Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

範例：

await productTarget.hideProductPrice(123);

二十、取得商品設定

Api 方法： getProductSetting(): Promise<ProductSetting>

回傳值說明： 商品設定，Promise<ProductSetting> 類型，詳細類型說明如下

二十一、推送商品

Api 方法： pushProduct(productId: number, rule?: ProductPushRule): Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

• rule：推送規則，ProductPushRule 類型，選傳

範例：

await productTarget.pushProduct(123, ProductPushRule.SmallCard);

二十二、取消推送商品

Api 方法： cancelPushProduct(productId: number): Promise<void>

參數說明：

• productId：商品 id，number 類型，必傳

範例：

await productTarget.cancelPushProduct(123);

二十三、批次刪除商品

Api 方法： batchDeleteProduct(productIds: number[]): Promise<void>

參數說明：

• productIds：商品 id 列表，number[] 類型，必傳

範例：

await productTarget.batchDeleteProduct([123, 456]);

二十四、批次上架商品

Api 方法： batchOnShelfProduct(productIds: number[]): Promise<void>

參數說明：

• productIds：商品 id 列表，number[] 類型，必傳

範例：

await productTarget.batchOnShelfProduct([123, 456]);

二十五、批次下架商品

Api 方法： batchOffShelfProduct(productIds: number[]): Promise<void>

參數說明：

• productIds：商品 id 列表，number[] 類型，必傳

範例：

await productTarget.batchOffShelfProduct([123, 456]);

二十六、判斷目前使用者是否支援直接購買商品

Api 方法： getSupportToDirectBuy(): Promise<boolean>

回傳值說明： Promise<boolean> 類型

範例：

const supported = await productTarget.getSupportToDirectBuy();
console.log('是否支持直接购买', supported);