本页内容
1. 接口描述 #
接口URL: https://open.datastory.com.cn/api/datastory.ecommerce.comment.list
请求方式:POST
描述:通过该接口可查看电商商品的评论明细数据详情,包括:评论内容、评论作者名、发表时间等等,具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|---|
appkey | 否 | string | "predeploy" | 权限校验标识 | |
filters | 是 | Array of RequestCommentFilters | (见接口示例) | 查询过滤条件 | |
openStrategy | 否 | boolean | false | 是否接受缓存 | |
page | 否 | integer | 1 | 分页查询的页码,默认1 | |
pageSize | 否 | integer | 20 | 分页查询的单页数据条数,默认20 |
3. 输出参数 #
参数名称 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
code | 否 | integer | 0 | 返回状态码,内部定义 |
data | 否 | Array of ResponseDataOfCommentDetailVo | (见接口示例) | 查询过滤条件 |
msg | 否 | string | "接口返回成功!" | 接口返回信息说明,在接口返回失败时会有 |
openStrategy | 否 | booleam | false | 是否接受缓存 |
success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestCommentFilters #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | "68" | 品牌id |
brandName | 否 | string | "小米" | 品牌名 |
categoryId | 否 | integer | "1123" | 品类ID |
categoryName | 否 | string | "奶粉" | 品类标准名(与品类ID二选一,优先查品类ID) 。注:仅支持末级品类,该参数准备废弃,建议使用spCategoryNames |
spCategoryName | 否 | string | "3c数码" | 品类标准名(查询该品类下所有的子品类) |
spCategoryNames | 否 | array | ["3C数码"] | 品类标准名列表(查询该品类下所有的子品类)。注:优先级高于spCategoryName |
commodityNames | 否 | array | [\"大宝男士磁力净痘洁面泥\"] | 标准商品名称列表 |
publishDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 评论发表时间。注:默认上个自然月的数据,允许缺失时间值 |
shopName | 否 | string | "修丽可官方旗舰店" | 店铺名称 |
siteId | 否 | integer | 5 | 站点ID,天猫:10,京东:5 |
skuId | 否 | integer | "637338326057" | 商品SkuId |
title | 否 | string | 苹果8plus | 商品标题,不传则查询时不限制商品标题 |
trendName | 否 | string | "修护" | 趋势 |
trendType | 否 | string | "人群" | 趋势类型 |
tripleDimension | 否 | string | 效果 | 三元组一级维度 |
tripleProperty | 否 | string | 抗皱/抗氧化 | 三元组二级维度 |
tripleFeature | 否 | string | 抗老 | 三元组特征词 |
limitContentBlacklist | 否 | boolean | false | 是否限制评论内容黑名单(码表维护) |
4.2 ResponseDataOfCommentDetailVo #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
dataset | 否 | [Array of CommentDetailVo,Array of CommentDetailVo] | (见接口请求示例) | 返回数据集,不同接口返回结果的格式不一样 |
dorisTime | 否 | integer | "458" | 查询Doris耗时,单位毫秒 |
meta | 否 | array | "list" | 返回数据格式:list、aggregation、graph |
page | 否 | integer | 1 | 分页查询的页码 |
pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
time | 否 | integer | "955" | 查询总耗时,单位毫秒 |
total | 否 | integer | "34500230" | 查询数据总量 |
4.2.1 CommentDetailVo #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | "1123" | 品牌ID |
brandName | 否 | string | "苹果" | 品牌名称 |
categoryId | 否 | integer | 1 | 品类ID |
categoryName | 否 | string | "洗发水" | 品类名称 |
commentPicture | 否 | string | 评论图片 | |
content | 否 | string | "回购的,真的好用舒适,推荐。" | 评论内容 |
itemId | 否 | string | "09624bdda9a2da035dcd04183aaeeaad" | 评论itemId |
itemTitle | 否 | string | "iPad保护套2020第8代10.2寸2019苹果air3平板mini5软壳air2皮套6/4/2硅胶pro10.5防摔9.7版网红2018新款七八7" | 商品标题 |
itemUrl | 否 | string | "https://detail.tmall.com/item.htm?id=637338326057&skuId=4738865090457&skuId=4738865090495" | 商品url |
keywords | 否 | array | "List [ "非常好", "好用" ]" | 评论内容关键词 |
publishTimestamp | 否 | integer | "1642089600000" | 发表时间 |
score | 否 | number | "4.8" | 评分 |
shopId | 否 | string | "106269063" | 店铺id |
shopName | 否 | string | "秉迪数码专营店" | 店铺名称 |
siteId | 否 | integer | "10" | 站点ID |
siteName | 否 | string | "天猫" | 站点名称 |
skuId | 否 | integer | "637338326057" | 商品SkuId |
userItemId | 否 | string | "63733832" | 评论作者itemId |
userName | 否 | string | "石**燕" | 评论作者名称 |
5. 示例 #
示例1 查看某个品类下的详细评论详情 #
查看某个品类在某个时间段内的详细评论数据。
输入示例
{
"appkey": "predeploy",
"filters": {
"brandName": "小米",
"siteId": 10
},
"openStrategy": false,
"page": 1,
"pageSize": 5
}
输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功!",
"data": {
"meta": {
"datasetType": "list"
},
"dataset": [
{
"categoryId": 3842,
"categoryName": "蓝牙耳机",
"brandId": 13950,
"brandName": "小米",
"skuId": 100000200000019078,
"itemTitle": "小米Redmi Buds 3真无线蓝牙耳机通话降噪红米耳机小米官方旗舰店",
"siteId": 10,
"siteName": "天猫",
"shopId": "104736810",
"shopName": "小米官方旗舰店",
"publishTimestamp": 1649692800000,
"itemId": "655969175894",
"userName": "7**w",
"content": "此用户没有填写评价。",
"score": 0.0,
"keywords": [
"用户"
]
},
{
"categoryId": 3842,
"categoryName": "蓝牙耳机",
"brandId": 13950,
"brandName": "小米",
"skuId": 100000200000019078,
"itemTitle": "小米Redmi Buds 3真无线蓝牙耳机通话降噪红米耳机小米官方旗舰店",
"siteId": 10,
"siteName": "天猫",
"shopId": "104736810",
"shopName": "小米官方旗舰店",
"publishTimestamp": 1649692800000,
"itemId": "655969175894",
"userName": "l**i",
"content": "凑合",
"score": 0.0,
"keywords": []
},
{
"categoryId": 1500,
"categoryName": "双肩包",
"brandId": 13950,
"brandName": "小米",
"skuId": 100000200000004273,
"itemTitle": "小米经典商务双肩包男女潮流时尚笔记本电脑包旅行大容量背包",
"siteId": 10,
"siteName": "天猫",
"shopId": "104736810",
"shopName": "小米官方旗舰店",
"publishTimestamp": 1649692800000,
"itemId": "598688549184",
"userName": "5**子",
"content": "面料材质:感觉还不错我挺喜欢的 容量大小:容量很大,规划的很好",
"score": 0.0,
"keywords": [
"容量",
"规划",
"大小",
"材质",
"面料"
]
},
{
"categoryId": 6009,
"categoryName": "手机",
"brandId": 13950,
"brandName": "小米",
"skuId": 100000200000019484,
"itemTitle": "12期分期现货速发Xiaomi/小米Redmi Note9 5G手机全网通官方旗舰店官网正品新款直降红米note10pro+学生拍照",
"siteId": 10,
"siteName": "天猫",
"shopId": "109435847",
"shopName": "机御旗舰店",
"publishTimestamp": 1649692800000,
"itemId": "632420337038",
"userName": "t**5",
"content": "此用户没有填写评价。",
"score": 0.0,
"keywords": [
"用户"
]
},
{
"categoryId": 6009,
"categoryName": "手机",
"brandId": 13950,
"brandName": "小米",
"skuId": 100000200000019484,
"itemTitle": "12期分期现货速发Xiaomi/小米Redmi Note9 5G手机全网通官方旗舰店官网正品新款直降红米note10pro+学生拍照",
"siteId": 10,
"siteName": "天猫",
"shopId": "109435847",
"shopName": "机御旗舰店",
"publishTimestamp": 1649692800000,
"itemId": "632420337038",
"userName": "a**6",
"content": "此用户没有填写评价。",
"score": 0.0,
"keywords": [
"用户"
]
}
],
"pageSize": 5,
"page": 1,
"total": 140967,
"time": 754
}
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
状态码 | 描述 |
---|---|