淘宝/天猫的按图搜索商品功能,通过taobao.item_search_img API,为用户和开发者提供了一个全新的搜索体验。这个API允许用户通过上传图片来搜索相似的商品,为购物过程增添了便捷性和趣味性。以下是对taobao.item_search_img API返回值的全面攻略:
一、API返回值概述
taobao.item_search_img API的返回值主要包括以下几个部分:
-
状态码(Status Code):表示API调用的成功与否。通常,200表示成功,其他值则表示不同的错误情况。
-
错误信息(Error Message):如果调用失败,API将返回具体的错误信息,帮助开发者理解失败的原因。
-
搜索结果(Search Results):一个包含搜索到的商品的数组或列表。每个商品信息都包含以下字段:
- 商品ID(Item ID):每个搜索到的商品的唯一标识。
- 商品标题(Title):商品的名称或标题。
- 商品图片(Images):与搜索结果中的商品相关的图片链接数组。
- 商品链接(Permalink):指向商品详情页面的链接。
- 店铺信息(Shop Info):包含提供该商品的店铺的名称、ID、评分等信息。
- 销量(Sales):该商品的累计销量。
- 相似度(Similarity Score):指示搜索到的商品与上传的图片之间的相似度评分。
-
taobao.item_search_img
公共参数
请求地址: https://api-gw.onebound.cn/taobao/item_search_img
名称 类型 必须 描述 key String 是 调用key(必须以GET方式拼接在URL中) secret String 是 调用密钥 api_name String 是 API接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等] cache String 否 [yes,no]默认yes,将调用缓存的数据,速度比较快 result_type String 否 [json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读 lang String 否 [cn,en,ru]翻译语言,默认cn简体中文 version String 否 API版本 请求参数
请求参数:imgid=http://g-search3.alicdn.com/img/bao/uploaded/i4/O1CN01IDpcD81zHbpHs1YgT_!!2200811456689.jpg&cat=&page=1
参数说明:imgid:图片地址(支持淘宝或天猫图片地址,外部地址先调用上传图片(upload_img)接口,返回图片地址)
如:https://img.alicdn.com/imgextra/i3/15353738/TB2HDHAqN9YBuNjy0FfXXXIsVXa_!!15353738-0-beehive-scenes.jpg
page:页数响应参数
Version: Date:
名称 类型 必须 示例值 描述 title
String 0 亲子装短袖t恤社会人衣服全家装一家三口母子母女纯棉夏装上衣潮 宝贝标题 cid
Int 0 50015374 list_type
String 0 外观相似宝贝 列表类型 pic_url
String 0 //g-search3.alicdn.com/img/bao/uploaded/i4/TB26ry1rBsmBKNjSZFsXXaXSVXa_!!2628705716.jpg 宝贝图片 promotion_price
String 0 38.71 优惠价 price
Float 0 39.50 价格 sales
Int 0 7 销量 num_iid
Bigint 0 575727312808 宝贝ID sample_id
Bigint 0 1627115368 商品风格标识ID seller_nick
String 0 专属味道之dzw 掌柜昵称 is_tmall
Bool 0 false post_fee
String 0 0.00 物流费用 area
String 0 广东 东莞 店铺所在地 detail_url
String 0 //item.taobao.com/item.htm?id=575727312808&ns=1#detail 宝贝链接
错误码解释
状态代码(error_code) | 状态信息 | 详细描述 | 是否收费 |
---|---|---|---|
0000 | success | 接口调用成功并返回相关数据 | 是 |
2000 | Search success but no result | 接口访问成功,但是搜索没有结果 | 是 |
4000 | Server internal error | 服务器内部错误 | 否 |
4001 | Network error | 网络错误 | 否 |
4002 | Target server error | 目标服务器错误 | 否 |
4003 | Param error | 用户输入参数错误 | 忽略 |
4004 | Account not found | 用户帐号不存在 | 忽略 |
4005 | Invalid authentication credentials | 授权失败 | 忽略 |
4006 | API stopped | 您的当前API已停用 | 忽略 |
4007 | Account stopped | 您的账户已停用 | 忽略 |
4008 | API rate limit exceeded | 并发已达上限 | 忽略 |
4009 | API maintenance | API维护中 | 忽略 |
4010 | API not found with these values | API不存在 | 忽略 |
4012 | Please add api first | 请先添加api | 忽略 |
4013 | Number of calls exceeded | 调用次数超限 | 忽略 |
4014 | Missing url param | 参数缺失 | 忽略 |
4015 | Wrong pageToken | 参数pageToken有误 | 忽略 |
4016 | Insufficient balance | 余额不足 | 忽略 |
4017 | timeout error | 请求超时 | 否 |
5000 | unknown error | 未知错误 | 否 |
二、API返回值详解
- 商品ID(Item ID):这是每个商品的唯一标识,可以用于后续的商品详情查询、购买等操作。
- 商品标题(Title):商品标题是商品的名称或简短描述,通常包含了商品的主要信息和卖点。
- 商品图片(Images):这是一个图片链接数组,包含了与搜索结果中的商品相关的多张图片。开发者可以根据需要选择使用其中的一张或多张图片。
- 商品链接(Permalink):这是一个指向商品详情页面的链接,用户可以直接点击该链接进入商品详情页面进行查看和购买。
- 店铺信息(Shop Info):这部分信息包含了提供该商品的店铺的名称、ID、评分等。这些信息可以帮助用户了解店铺的信誉和口碑,从而做出更明智的购买决策。
- 销量(Sales):这是该商品的累计销量数据,可以作为用户购买决策的一个参考因素。
- 相似度(Similarity Score):这是一个介于0到1之间的数值,表示搜索到的商品与上传的图片之间的相似度评分。数值越高,表示相似度越高;数值越低,表示相似度越低。开发者可以根据这个评分对搜索结果进行排序或筛选。
三、API使用建议
- 在使用taobao.item_search_img API时,建议首先确保已经注册了淘宝开放平台的账号,并为应用注册了相应的应用程序键(App Key)。
- 在调用API时,请确保传入的参数正确无误,并遵循淘宝开放平台的接口规范。
- 对于返回的搜索结果,建议根据实际需求进行筛选和排序,以提高用户体验和搜索效率。
- 如果在调用API过程中遇到任何问题或错误,请仔细阅读返回的错误信息,并根据提示进行相应的排查和修复。