商品庫

一、功能概述

本模組提供直播間商品展示與互動功能，包括取得商品列表、商品標籤等。

二、Api 方法

2.1 取得商品庫的商品列表

Api 方法： getProductListByShowId(params?: GetProductListParams): Promise<ProductListData>

參數說明：

• params：undefined，GetProductListParams 類型，選傳

回傳值說明： 商品列表資料，Promise<ProductListData> 類型

範例：

// 获取商品列表
const res = await watchCore.product.getProductListByShowId();
console.log('商品列表', res.content);

2.2 根據標籤 ID 取得商品列表

Api 方法： getProductListByTagId(params: GetProductListByTagParams): Promise<ProductListPageData>

參數說明：

• params：查詢參數，GetProductListByTagParams 類型，必傳

回傳值說明： 分頁商品列表資料，Promise<ProductListPageData> 類型

範例：

// 获取指定标签的商品
const res = await watchCore.product.getProductListByTagId({
  tagId: '123456'
});
console.log('商品总数', res.totalItems);
console.log('当前页码', res.pageNumber);
console.log('总页数', res.totalPages);
console.log('商品列表', res.contents);

2.3 取得商品標籤列表

Api 方法： getProductLabelList(params: GetProductLabelListParams): Promise<ProductLabelListData>

參數說明：

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

回傳值說明： 商品標籤列表資料，Promise<ProductLabelListData> 類型，詳細類型說明如下

範例：

// 获取商品分类标签
const res = await watchCore.product.getProductLabelList({});
console.log('标签总数', res.totalItems);
console.log('当前页码', res.pageNumber);
console.log('总页数', res.totalPages);
console.log('标签列表', res.contents);

2.4 發送商品點擊購買事件

說明： 使用者點擊商品購買按鈕時呼叫，用於統計埋點與顯示購買效果

Api 方法： sendClickBuy(good: ProductData): void

參數說明：

• good：商品資料，ProductData 類型，必傳

範例：

// 用户点击购买商品
watchCore.product.sendClickBuy(productData);

三、模組事件

3.1 上架商品事件

說明： 當商品被上架時觸發

Event 事件： ProductEvents.OnShelfProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.OnShelfProduct, (data) => {
  console.log('商品已上架', data.productData);
});

3.2 下架商品事件

說明： 當商品被下架時觸發

Event 事件： ProductEvents.OffShelfProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.OffShelfProduct, (data) => {
  console.log('商品已下架', data.productData);
});

3.3 刪除商品事件

說明： 當商品被刪除時觸發

Event 事件： ProductEvents.DeleteProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.DeleteProduct, (data) => {
  console.log('商品已删除', data.productData);
});

3.4 新增商品事件

說明： 當新商品被新增時觸發

Event 事件： ProductEvents.AddProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.AddProduct, (data) => {
  console.log('商品已添加', data.productData);
});

3.5 修改商品事件

說明： 當商品資訊被修改時觸發

Event 事件： ProductEvents.ChangeProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.ChangeProduct, (data) => {
  console.log('商品已修改', data.productData);
});

3.6 移動商品事件

說明： 當商品位置被移動時觸發

Event 事件： ProductEvents.MoveProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.MoveProduct, (data) => {
  console.log('商品已移动', data.productData);
});

3.7 修改排序事件

說明： 當商品排序被修改時觸發

Event 事件： ProductEvents.ChangeRankProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.ChangeRankProduct, (data) => {
  console.log('商品排序已修改', data.productData);
});

3.8 重新整理商品列表事件

說明： 當商品列表需要重新整理時觸發

Event 事件： ProductEvents.RefreshProductList

範例：

watchCore.product.eventEmitter.on(ProductEvents.RefreshProductList, () => {
  console.log('商品列表已刷新');
});

3.9 推送商品事件

說明： 當商品被推送給使用者時觸發

Event 事件： ProductEvents.PushProduct

回呼參數： Object 物件，詳細類型說明如下

範例：

watchCore.product.eventEmitter.on(ProductEvents.PushProduct, (data) => {
  console.log('商品已推送', data.productData);
});

3.10 商品點擊次數事件

說明： 當商品被點擊時觸發，包含點擊次數資訊

Event 事件： ProductEvents.ProductClickTimes

回呼參數： ProductClickTimesData

範例：

watchCore.product.eventEmitter.on(ProductEvents.ProductClickTimes, (data) => {
  console.log('商品点击次数', data);
});