帮助中心 >
直播
Object: live
Primary Locator:
- mediaId
1. Schema
liveBasicInfo
| Field | 中文属性 | Type | 中文说明 | English Description |
|---|---|---|---|---|
| mediaId | 媒体ID | string | TikTok 官方直播媒体唯一ID | Official TikTok LIVE media identifier |
| creatorId | 达人ID | string | 直播所属达人ID | Creator ID of the LIVE session |
| creatorNickname | 达人昵称 | string | 直播所属达人昵称 | Creator nickname of the LIVE session |
| startTime | 开始时间 | datetime | 直播开始时间 | Start time of the LIVE session |
| endTime | 结束时间 | datetime | 直播结束时间 | End time of the LIVE session |
| shopName | 合作店铺 | string | 直播对应合作店铺名称 | Cooperating shop name of the LIVE session |
| shopCode | 店铺编码 | string | 直播对应合作店铺编码 | Cooperating shop code of the LIVE session |
| products | 带货商品 | liveProduct[] | 直播关联的带货商品列表 | Products promoted in the LIVE session |
| orders | 带货订单数 | number | 直播带来的订单数量 | Number of orders generated by the LIVE session |
| soldAmount | 商品售出金额 | number | 直播带货商品销售金额 | Sales amount generated by the LIVE session |
| soldItems | 商品售出数量 | number | 直播带货商品售出件数 | Number of sold product items generated by the LIVE session |
| commission | 佣金 | number | 直播产生的达人佣金金额 | Creator commission generated by the LIVE session |
| note | 备注 | string | 用户自定义备注信息 | User-defined note for the LIVE session |
| owners | 跟进人 | string[] | 负责该直播的 BD 人员列表 | BD owners responsible for the LIVE session |
| updateTime | 更新时间 | datetime | 直播数据最近更新时间 | Last updated time of the LIVE session data |
liveProduct
| Field | 中文属性 | Type | 中文说明 | English Description |
|---|---|---|---|---|
| productId | 商品ID | string | 直播关联的商品ID | Product ID linked to the LIVE session |
| productName | 商品名称 | string | 直播关联的商品名称 | Product name linked to the LIVE session |
2. Action Specs
Returns: live[]
huayangtk-cli live --start-time <datetime> --end-time <datetime>
huayangtk-cli live --shop-code <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live --creator-id <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live --product-id <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live --shop-code <string> --product-id <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live list --start-time <datetime> --end-time <datetime>
huayangtk-cli live list --shop-code <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live list --creator-id <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live list --product-id <string> --start-time <datetime> --end-time <datetime>
huayangtk-cli live list --shop-code <string> --product-id <string> --start-time <datetime> --end-time <datetime>
Returns: live
huayangtk-cli live get --media-id <string>
Returns: live
huayangtk-cli live note --media-id <string> --note <string>
