openboost-cli 0.1.0__py3-none-any.whl

proboost_cli/schemas/tiktok/tt_commodity_voice_analyze.json

@@ -0,0 +1,36 @@
+{
+  "name": "tt_commodity_voice_analyze",
+  "description": "TT 商品原声/评论口碑分析：按维度分组返回观点摘要、提及次数、占比与说明；需 commodityId。无配置时 data 为空数组。若传 size 则须 ≤30；若传 startTime/endTime 须成对。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "commodityId": {
+        "description": "TT 商品 ID；为空时报「商品编号不能为空」。",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区，与其它商品接口对齐用；本分析以商品 ID 为主。",
+        "type": "string"
+      },
+      "current": {
+        "description": "页码，继承分页模型默认 1；本接口不做列表分页，可不传。",
+        "type": "integer"
+      },
+      "endTime": {
+        "description": "结束时间；须与 startTime 成对。本接口统计不依赖时间筛选。",
+        "type": "string"
+      },
+      "size": {
+        "description": "每页条数，继承模型默认 10；若传入须 ≤30，否则「超出每页最大数据限制」。",
+        "type": "integer"
+      },
+      "startTime": {
+        "description": "开始时间；与 endTime 须同时有或同时无，否则日期校验失败。本接口统计不依赖时间筛选。",
+        "type": "string"
+      }
+    },
+    "required": [
+      "commodityId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_basic_analyze.json

@@ -0,0 +1,24 @@
+{
+  "name": "tt_expert_basic_analyze",
+  "description": "查询达人基础分析趋势（点赞、播放、转发等时间序列）；返回后 tkExpertDetailService.dealTrend 会补充 TT 侧趋势。；无达人数据时可能 100100102。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "analyzeTrendType": {
+        "description": "趋势类型",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区",
+        "type": "string"
+      },
+      "expertId": {
+        "description": "达人编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "expertId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_category_analyze.json

@@ -0,0 +1,29 @@
+{
+  "name": "tt_expert_category_analyze",
+  "description": "TT 商品带货达人类目维度分析：在一级或二级类目粒度下，查看为该商品带货的达人在各子类目上的分布（达人数、销量合计、占比、人均销量）。categoryLevel=2 时必须传 categoryId；无统计时 data 为空数组。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "categoryId": {
+        "description": "类目 ID；当 categoryLevel 为 2 时必填，否则报「类目id不能为空」；为 1 时可不传（含义以联调为准）。",
+        "type": "string"
+      },
+      "categoryLevel": {
+        "description": "类目层级：1 一级类目下钻；2 二级类目下钻。为空时报「类目层级不能为空」；其它取值通常无统计结果。",
+        "type": "integer"
+      },
+      "commodityId": {
+        "description": "TT 商品 ID；为空时报「商品编号不能为空」。",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区，建议与选品站点一致，否则可能无数据或不准。",
+        "type": "string"
+      }
+    },
+    "required": [
+      "commodityId",
+      "categoryLevel"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_detail.json

@@ -0,0 +1,20 @@
+{
+  "name": "tt_expert_detail",
+  "description": "查询 TT 达人详情（粉丝与互动、带货与 GPM、简介与邮箱脱敏等）。；无达人数据时可能 100100102；详情余量不足且无「查看全部」会拦截；成功扣减详情次数。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区；传入 ExpertDTO 用于分表/大区",
+        "type": "string"
+      },
+      "expertId": {
+        "description": "达人编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "expertId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_fans_analyze.json

@@ -0,0 +1,20 @@
+{
+  "name": "tt_expert_fans_analyze",
+  "description": "TT 商品带货达人粉丝档位分析：按粉丝量级分档统计达人数、类目销量合计、占比与人均销量；有数据时通常固定 5 档。档位名称 group 随请求头 Language。无统计时 data 为空数组。态；密钥仅走网关。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "commodityId": {
+        "description": "TT 商品 ID；为空时报「商品编号不能为空」。",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区，建议与选品站点一致，否则可能无数据或不准。",
+        "type": "string"
+      }
+    },
+    "required": [
+      "commodityId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_fans_portrait.json

@@ -0,0 +1,20 @@
+{
+  "name": "tt_expert_fans_portrait",
+  "description": "查询达人粉丝画像（性别比例、年龄结构等，多为服务端序列化后的字符串，结构以联调为准）。；无数据时可能成功且 data 为 null。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区；传入 ExpertDTO.region",
+        "type": "string"
+      },
+      "expertId": {
+        "description": "达人编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "expertId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_expert_info_list.json

@@ -0,0 +1,180 @@
+{
+  "name": "tt_expert_info_list",
+  "description": "分页查询 TT 达人选品列表，支持国家/地区、关键词、类目、粉丝与互动、带货与 GPM、关联商品/店铺等筛选与排序；返回达人基础指标与近 30 日带货相关指标。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "averageLikeNumberEnd": {
+        "description": "均赞数区间上限",
+        "type": "integer"
+      },
+      "averageLikeNumberStart": {
+        "description": "均赞数区间下限",
+        "type": "integer"
+      },
+      "averagePlayNumberEnd": {
+        "description": "均播数区间上限",
+        "type": "integer"
+      },
+      "averagePlayNumberStart": {
+        "description": "均播数区间下限",
+        "type": "integer"
+      },
+      "averageRetweetNumberEnd": {
+        "description": "均转发数区间上限",
+        "type": "integer"
+      },
+      "averageRetweetNumberStart": {
+        "description": "均转发数区间下限",
+        "type": "integer"
+      },
+      "averageReviewsNumberEnd": {
+        "description": "均评论数区间上限",
+        "type": "integer"
+      },
+      "averageReviewsNumberStart": {
+        "description": "均评论数区间下限",
+        "type": "integer"
+      },
+      "commodityId": {
+        "description": "商品 ID；非空时仅保留带过该商品的达人",
+        "type": "string"
+      },
+      "contactable": {
+        "description": "是否可联系等业务筛选，与站内一致",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区，与站内选品一致，用于分国家数据域",
+        "type": "string"
+      },
+      "current": {
+        "description": "当前页码，默认 1；无「查看全部」权限时 current > 3 会报错",
+        "type": "integer"
+      },
+      "dataPeriod": {
+        "description": "数据周期：day / week / month 与 date 联用；last7d / last30d 等见接口文档附录",
+        "type": "string"
+      },
+      "date": {
+        "description": "统计日，ISO 8601 日期时间字符串；与 dataPeriod 为 day/week/month 时配合使用",
+        "type": "string"
+      },
+      "expertCategory": {
+        "description": "达人类目",
+        "type": "string"
+      },
+      "expertGPMEnd": {
+        "description": "达人 GPM 区间上限（小数）",
+        "type": "string"
+      },
+      "expertGPMStart": {
+        "description": "达人 GPM 区间下限（小数）",
+        "type": "string"
+      },
+      "expertIdList": {
+        "description": "达人 ID 列表（批量筛选）",
+        "type": "array"
+      },
+      "expertLiveGPMEnd": {
+        "description": "直播 GPM 区间上限（小数）",
+        "type": "string"
+      },
+      "expertLiveGPMStart": {
+        "description": "直播 GPM 区间下限（小数）",
+        "type": "string"
+      },
+      "expertName": {
+        "description": "达人昵称/账号关键词，空格分词子串匹配",
+        "type": "string"
+      },
+      "expertSalesNumberEnd": {
+        "description": "达人销量区间上限",
+        "type": "integer"
+      },
+      "expertSalesNumberStart": {
+        "description": "达人销量区间下限",
+        "type": "integer"
+      },
+      "expertType": {
+        "description": "达人类型：powerExpert 带货达人 / notPowerExpert 不带货达人",
+        "type": "string"
+      },
+      "fansNumberEnd": {
+        "description": "粉丝数区间上限",
+        "type": "integer"
+      },
+      "fansNumberStart": {
+        "description": "粉丝数区间下限",
+        "type": "integer"
+      },
+      "hasLive": {
+        "description": "是否有直播等筛选",
+        "type": "string"
+      },
+      "hasVideo": {
+        "description": "是否有视频等筛选",
+        "type": "string"
+      },
+      "interactionRateEnd": {
+        "description": "互动率区间上限（百分比口径）",
+        "type": "string"
+      },
+      "interactionRateStart": {
+        "description": "互动率区间下限（百分比口径，与前端一致；服务端会换算为小数）",
+        "type": "string"
+      },
+      "lastPublishDays": {
+        "description": "距离上次发布天数",
+        "type": "integer"
+      },
+      "offset": {
+        "description": "偏移量，可选，高级分页场景",
+        "type": "integer"
+      },
+      "operationType": {
+        "description": "达人类型：1 个人运营 / 2 店铺运营 等，与站内一致",
+        "type": "integer"
+      },
+      "orderType": {
+        "description": "排序类型，如 fansNumberDesc（默认粉丝降序）、expertVideoNumberAsc 等，完整枚举见 ExpertInfoRequest 注释",
+        "type": "string"
+      },
+      "powerSaleGMVEnd": {
+        "description": "带货 GMV 区间上限（小数）",
+        "type": "string"
+      },
+      "powerSaleGMVStart": {
+        "description": "带货 GMV 区间下限（小数）",
+        "type": "string"
+      },
+      "powerSaleNumberEnd": {
+        "description": "带货数区间上限",
+        "type": "integer"
+      },
+      "powerSaleNumberStart": {
+        "description": "带货数区间下限",
+        "type": "integer"
+      },
+      "shopId": {
+        "description": "店铺 ID",
+        "type": "string"
+      },
+      "size": {
+        "description": "每页条数，默认 10，最大 30（超出抛业务异常）",
+        "type": "integer"
+      },
+      "videoNumberEnd": {
+        "description": "视频数区间上限",
+        "type": "integer"
+      },
+      "videoNumberStart": {
+        "description": "视频数区间下限",
+        "type": "integer"
+      }
+    },
+    "required": [
+      "countryRegion"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_sale_channel_sale_channel.json

@@ -0,0 +1,26 @@
+{
+  "name": "tt_sale_channel_sale_channel",
+  "description": "TT 商品近30日成交渠道占比：商品卡、店铺自营、达人带货的销量或销售额及占比（达人部分为残差，三项均为 0 时占比归零）。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区；不能为空（@NotBlank）。",
+        "type": "string"
+      },
+      "productId": {
+        "description": "TT 商品 ID；不能为空（@NotBlank）。",
+        "type": "string"
+      },
+      "saleType": {
+        "description": "统计维度：1 近30日总销量；2 近30日总销售额；不能为空（@NotNull），应传 1 或 2。",
+        "type": "integer"
+      }
+    },
+    "required": [
+      "countryRegion",
+      "productId",
+      "saleType"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_shop_commodity_account_list.json

@@ -0,0 +1,28 @@
+{
+  "name": "tt_shop_commodity_account_list",
+  "description": "按店铺查询各商品类目的数量占比与销量占比列表",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区；传入 ShopDTO.countryRegion",
+        "type": "string"
+      },
+      "dataPeriod": {
+        "description": "数据维度（日/周/月）；请求体字段存在，当前该接口仅映射 shopId、countryRegion，未传入 ShopDTO",
+        "type": "string"
+      },
+      "date": {
+        "description": "数据日期，yyyy-MM-dd（GMT+8）；当前该接口未映射到 ShopDTO",
+        "type": "string"
+      },
+      "shopId": {
+        "description": "店铺编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "shopId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_shop_detail.json

@@ -0,0 +1,28 @@
+{
+  "name": "tt_shop_detail",
+  "description": "查询 TT 店铺详情（名称、类目、评分、在售数、链接与关注状态等）。；TT 详情余量不足且无「查看全部」时会拦截；成功会扣减详情次数。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区",
+        "type": "string"
+      },
+      "dataPeriod": {
+        "description": "数据维度（日/周/月等）；与 date 联用，传入 ShopDTO",
+        "type": "string"
+      },
+      "date": {
+        "description": "数据日期，yyyy-MM-dd（GMT+8）",
+        "type": "string"
+      },
+      "shopId": {
+        "description": "店铺编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "shopId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_shop_info_list.json

@@ -0,0 +1,108 @@
+{
+  "name": "tt_shop_info_list",
+  "description": "分页查询 TT 店铺选品列表；dataPeriod 必填。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区",
+        "type": "string"
+      },
+      "current": {
+        "description": "当前页码，默认 1；无「查看全部」权限时 current > 3 会报错",
+        "type": "integer"
+      },
+      "dataPeriod": {
+        "description": "数据维度（日/周/月等）；paramCheck 要求非空，否则 100100147",
+        "type": "string"
+      },
+      "date": {
+        "description": "统计日期，yyyy-MM-dd（GMT+8）",
+        "type": "string"
+      },
+      "isCrossBorder": {
+        "description": "是否全托管：0 本土 / 1 跨境",
+        "type": "integer"
+      },
+      "mainCategory": {
+        "description": "主营类目",
+        "type": "string"
+      },
+      "onSaleProductAmountEnd": {
+        "description": "在售商品数区间止",
+        "type": "integer"
+      },
+      "onSaleProductAmountStart": {
+        "description": "在售商品数区间起",
+        "type": "integer"
+      },
+      "orderType": {
+        "description": "排序类型，见 ShopInfoRequest 注释",
+        "type": "string"
+      },
+      "relateExpertAmountEnd": {
+        "description": "关联达人数区间止",
+        "type": "integer"
+      },
+      "relateExpertAmountStart": {
+        "description": "关联达人数区间起",
+        "type": "integer"
+      },
+      "reportDateEnd": {
+        "description": "报告日期止",
+        "type": "string"
+      },
+      "reportDateStart": {
+        "description": "报告日期起",
+        "type": "string"
+      },
+      "reportMonthEnd": {
+        "description": "报告月止",
+        "type": "string"
+      },
+      "reportMonthStart": {
+        "description": "报告月起",
+        "type": "string"
+      },
+      "saleAmountEnd": {
+        "description": "销量区间止",
+        "type": "integer"
+      },
+      "saleAmountStart": {
+        "description": "销量区间起",
+        "type": "integer"
+      },
+      "scoreEnd": {
+        "description": "评分区间止（小数）",
+        "type": "string"
+      },
+      "scoreStart": {
+        "description": "评分区间起（小数）",
+        "type": "string"
+      },
+      "shopId": {
+        "description": "店铺 ID",
+        "type": "string"
+      },
+      "shopIdList": {
+        "description": "店铺 ID 列表（批量筛选）",
+        "type": "array"
+      },
+      "shopName": {
+        "description": "店铺名称关键词",
+        "type": "string"
+      },
+      "shopType": {
+        "description": "店铺类型：0 本土 / 2 跨境 等",
+        "type": "string"
+      },
+      "size": {
+        "description": "每页条数，默认 10，最大 30（pbParamCheck）",
+        "type": "integer"
+      }
+    },
+    "required": [
+      "dataPeriod"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_shop_market_info.json

@@ -0,0 +1,28 @@
+{
+  "name": "tt_shop_market_info",
+  "description": "查询店铺市场大盘指标（在售/动销、销量、销售额、排名与环比、关联达人/视频/直播等）。dataPeriod 必填；无命中数据时仍可能成功且各字段多为空。。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区",
+        "type": "string"
+      },
+      "dataPeriod": {
+        "description": "数据维度（日/周/月等）；paramCheck 要求非空，否则业务码 100100147（口径未输入）",
+        "type": "string"
+      },
+      "date": {
+        "description": "统计日期，yyyy-MM-dd（GMT+8）",
+        "type": "string"
+      },
+      "shopId": {
+        "description": "店铺 ID；查询单店大盘时必传（服务端按 shopId + 大区等查分析表）",
+        "type": "string"
+      }
+    },
+    "required": [
+      "dataPeriod"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_shop_sales_trend.json

@@ -0,0 +1,33 @@
+{
+  "name": "tt_shop_sales_trend",
+  "description": "查询店铺销售/评论等趋势（多组 analyzeTrendType，每组含时间序列点）。commodityId 与 shopId 不能同时为空",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "commodityId": {
+        "description": "商品编号；与 shopId 至少填一个；店铺场景通常只传 shopId",
+        "type": "string"
+      },
+      "countryRegion": {
+        "description": "国家/地区",
+        "type": "string"
+      },
+      "month": {
+        "description": "月份（字符串，与业务约定一致）",
+        "type": "string"
+      },
+      "pastDays": {
+        "description": "回溯天数",
+        "type": "integer"
+      },
+      "pastMonth": {
+        "description": "回溯月数",
+        "type": "integer"
+      },
+      "shopId": {
+        "description": "店铺编号；与 commodityId 至少填一个（paramCheck）；本接口将 shopId 作为 entryId 查询店铺销售趋势",
+        "type": "string"
+      }
+    }
+  }
+}

proboost_cli/schemas/tiktok/tt_video_content.json

@@ -0,0 +1,20 @@
+{
+  "name": "tt_video_content",
+  "description": "按视频 ID 查询库中口播/语音转写正文（与 DIY 脚本、系统脚本链路前置的口播原文一致）。；无正文时仍可能成功且 data 为 null 或空字符串。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区（中文名），用于大区视频分表路由；建议与列表/详情等接口保持一致传入",
+        "type": "string"
+      },
+      "videoId": {
+        "description": "视频编号；paramCheck 要求非空，否则业务提示「视频编号不能为空」",
+        "type": "string"
+      }
+    },
+    "required": [
+      "videoId"
+    ]
+  }
+}

proboost_cli/schemas/tiktok/tt_video_detail.json

@@ -0,0 +1,20 @@
+{
+  "name": "tt_video_detail",
+  "description": "查询 TT 视频详情（播放互动、类型、总结/脚本标记、关注状态等）。",
+  "arguments": {
+    "type": "object",
+    "properties": {
+      "countryRegion": {
+        "description": "国家/地区；传入 VideoDTO 用于分表/大区路由，建议与列表等接口一致",
+        "type": "string"
+      },
+      "videoId": {
+        "description": "视频编号；paramCheck 要求非空",
+        "type": "string"
+      }
+    },
+    "required": [
+      "videoId"
+    ]
+  }
+}