summaryrefslogtreecommitdiff
path: root/data/zh_cn/imagesearch/2021-05-01/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/imagesearch/2021-05-01/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/imagesearch/2021-05-01/api-docs.php')
-rw-r--r--data/zh_cn/imagesearch/2021-05-01/api-docs.php1861
1 files changed, 559 insertions, 1302 deletions
diff --git a/data/zh_cn/imagesearch/2021-05-01/api-docs.php b/data/zh_cn/imagesearch/2021-05-01/api-docs.php
index 095119a..c3d481e 100644
--- a/data/zh_cn/imagesearch/2021-05-01/api-docs.php
+++ b/data/zh_cn/imagesearch/2021-05-01/api-docs.php
@@ -1,35 +1,14 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'ImageSearch',
- 'version' => '2021-05-01',
- ],
- 'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'SearchByUrl',
- 'SearchByPic',
- 'GetProductInfoByIds',
- ],
- ],
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'ImageSearch', 'version' => '2021-05-01'],
+ 'directories' => ['GetProductInfoByIds', 'SearchByPic', 'SearchByUrl'],
'components' => [
'schemas' => [],
],
'apis' => [
- 'SearchByUrl' => [
- 'summary' => '本文为您介绍SearchByUrl接口的语法及示例，用于向淘宝联盟版在线调用。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetProductInfoByIds' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -40,15 +19,193 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'PicUrl',
+ 'name' => 'ItemIds',
+ 'in' => 'formData',
+ 'schema' => ['description' => '商品ID串，用\',\'分割，最大40个。', 'type' => 'string', 'required' => true, 'example' => '111,22,33'],
+ ],
+ [
+ 'name' => 'Pid',
'in' => 'formData',
+ 'schema' => ['description' => 'PID。具体请参考[PID](https://mos.m.taobao.com/union/pub/site/help?spm=a219t.11817172.PortalLayout.d52e56935.27ac6a15wlAEHe)。'."\n"
+ .'> 使用V1.1.0及以上版本的SDK可用该字段。', 'type' => 'string', 'required' => false, 'example' => 'mm_xxx_xxx_xxx'],
+ ],
+ [
+ 'name' => 'Fields',
+ 'in' => 'formData',
+ 'schema' => ['description' => '需要返回的字段list。不同的字段用逗号分割。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。', 'type' => 'string', 'required' => false, 'example' => 'Url,UserType'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '图片URL。必须是HTTP或HTTPS开头。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '错误码。'."\n"
+ ."\n"
+ .'- 0：成功，'."\n"
+ .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
+ 'Data' => [
+ 'description' => '识别结果集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Auctions' => [
+ 'description' => '识别结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '查询结果内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '查询结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputItemId' => ['description' => '商品信息-商品ID。'."\n"
+ .'> SDK1.2.3使用，和搜索传入的ItemIds相同。', 'type' => 'string', 'example' => '123000123'],
+ 'ItemId' => ['description' => '商品信息-商品ID。'."\n"
+ .'> SDK1.2.3使用，动态商品ID。', 'type' => 'string', 'example' => 'Oqz93kougf9bkN7f4ACMtJ'],
+ 'Title' => ['description' => '商品信息-商品标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'ShortTitle' => ['description' => '商品信息-商品短标题（移动端建议使用）。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'SubTitle' => ['description' => '商品信息-商品子标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'PicUrl' => ['description' => '商品信息-商品主图。', 'type' => 'string', 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg'],
+ 'ReservePrice' => ['description' => '商品信息-一口价通常显示为划线价。'."\n", 'type' => 'string', 'example' => '150'],
+ 'ZkFinalPrice' => ['description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。', 'type' => 'string', 'example' => '98'],
+ 'PriceAfterCoupon' => ['description' => '商品信息-券后价。', 'type' => 'string', 'example' => '90'],
+ 'UserType' => ['description' => '店铺信息-卖家类型。'."\n"
+ ."\n"
+ .'- 1：天猫，'."\n"
+ .'- 0：淘宝。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Provcity' => ['description' => '商品信息-宝贝所在地。', 'type' => 'string', 'example' => '广东 深圳'],
+ 'Nick' => ['description' => '店铺信息-卖家昵称。'."\n", 'type' => 'string', 'example' => '衣服专卖店'],
+ 'SellerId' => ['description' => '店铺信息-卖家id。', 'type' => 'string', 'example' => '32590610'],
+ 'CategoryName' => ['description' => '商品信息-一级类目名称。', 'type' => 'string', 'example' => '连衣裙'],
+ 'Volume' => ['description' => '商品信息-30天销量。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ 'LevelOneCategoryName' => ['description' => '商品信息-叶子类目名称。', 'type' => 'string', 'example' => '童装/婴儿装/亲子装'],
+ 'CouponTotalCount' => ['description' => '优惠券信息-优惠券总量。', 'type' => 'string', 'example' => '10000'],
+ 'CouponRemainCount' => ['description' => '优惠券信息-优惠券剩余量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CouponStartTime' => ['description' => '优惠券信息-优惠券开始时间。', 'type' => 'string', 'example' => '2021-05-01'],
+ 'CouponEndTime' => ['description' => '优惠券信息-优惠券结束时间。', 'type' => 'string', 'example' => '2021-06-01'],
+ 'CouponStartFee' => ['description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
+ .'如：满299元减20元。', 'type' => 'string', 'example' => '98.000000'],
+ 'CouponAmount' => ['description' => '优惠券（元），若属于预售商品，该优惠券付尾款可用，付定金不可用。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'CouponInfo' => ['description' => '优惠券信息-优惠券满减信息。', 'type' => 'string', 'example' => '满98.0元减5.0元'],
+ 'CommissionRate' => ['description' => '商品信息-佣金比率。'."\n"
+ .'如：1550表示15.5%。', 'type' => 'string', 'example' => '180'],
+ 'CouponShareUrl' => ['description' => '链接-宝贝+券二合一页面链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'DeeplinkCouponShareUrl' => ['description' => '优惠券-手淘唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'Url' => ['description' => '链接-宝贝推广链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'DeeplinkUrl' => ['description' => '链接-宝贝推广的深度唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'ShopTitle' => ['description' => '店铺信息-店铺名称。', 'type' => 'string', 'example' => 'xx旗舰店'],
+ 'MaxCommission' => [
+ 'description' => '商品信息-高佣信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxCommissionRate' => ['description' => '商品信息-最优佣金率。 如：20.4表示佣金率为20.4%。', 'type' => 'string', 'example' => '20.4'],
+ 'MaxCommissionClickUrl' => ['description' => '商品信息-链接-最优佣金率宝贝推广链接。', 'type' => 'string', 'example' => 'https://s.click.taobao.com/t?e=xxxx'],
+ 'MaxCommissionCouponShareUrl' => ['description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。', 'type' => 'string', 'example' => 'https://s.click.taobao.com/t?e=xxxx'],
+ ],
+ ],
+ ],
+ ],
+ 'RankScore' => ['description' => '商品相似性的排名分数。取值范围：0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.34'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'PidNotExist', 'errorMessage' => 'The parameter specified Pid not exist', 'description' => ''],
+ ['errorCode' => 'InvalidPid', 'errorMessage' => 'The parameter Pid no specified', 'description' => ''],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
+ ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
+ ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
+ ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The specified instance name is invalid.', 'description' => '实例名错误'],
+ ['errorCode' => 'InvalidItemIds', 'errorMessage' => 'ItemIds parameter overflow number max 40.', 'description' => ''],
+ ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
+ ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
+ ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
+ ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
+ ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
+ ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
+ ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
+ ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
+ ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
+ ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
+ ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
+ ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
+ ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The specified parameter PicUrl is not valid.', 'description' => '无效的PicUrl参数'],
+ ['errorCode' => 'NotRegisterBeforeInvoke', 'errorMessage' => 'Need register token: pid before invoke.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
+ ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
+ ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => '​The request is timeout.', 'description' => ''],
+ ],
+ ],
+ 'title' => '根据ID查询商品',
+ 'summary' => '本文为您介绍GetProductInfoByIds接口的语法及示例，用于向淘宝联盟版在线调用。',
+ 'description' => '## 使用说明'."\n"
+ .'本接口用于向淘宝联盟版在线调用。'."\n"
+ .'> 推荐使用SDK1.2.3及以上版本，返回动态商品ID。'."\n"
+ ."\n"
+ .'## QPS限制'."\n"
+ .'查询操作默认5QPS。'."\n",
+ 'extraInfo' => '## 错误码'."\n"
+ .'请参见[错误码](~~66619~~)。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:GetProductInfoByIds',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"InputItemId\\": \\"123000123\\",\\n \\"ItemId\\": \\"Oqz93kougf9bkN7f4ACMtJ\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"xxx套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"150\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CouponTotalCount\\": \\"10000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 8,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.34\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ ],
+ 'SearchByPic' => [
+ 'summary' => '本文为您介绍SearchByPic接口的语法及示例，用于向淘宝联盟版在线调用。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'PicContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '图片内容。'."\n"
+ .' - 图片大小要求不超过4 MB。'."\n"
+ .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
+ .' - 传输等待时间不超过5秒。'."\n"
+ .' - 图片中不能包含旋转信息。'."\n"
+ .'> - 如使用SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段无需处理。'."\n"
+ ."\n", 'type' => 'string', 'required' => true, 'example' => 'xxx', 'isFileTransferUrl' => true],
+ ],
[
'name' => 'CategoryId',
'in' => 'formData',
@@ -61,34 +218,14 @@
'maximum' => '88888888',
'minimum' => '0',
'example' => '88888888',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- '9',
- '20',
- '21',
- '22',
- '88888888',
- ],
+ 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'],
],
],
[
'name' => 'Pid',
'in' => 'formData',
- 'schema' => [
- 'description' => 'PID。具体请参考[PID](https://help.alimama.com/?spm=a219t.23786078.0.0.290575a55P1LBx#!/search/index?spm=&keyWord=PID&knowledgeId=5625118&categoryId=1000040170)。'."\n"
- .'> 使用V1.1.0及以上版本的SDK可用该字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mm_xxx_xxx_xxx',
- ],
+ 'schema' => ['description' => 'PID。具体请参考[PID](https://mos.m.taobao.com/union/pub/site/help?spm=a219t.11817172.PortalLayout.d52e56935.27ac6a15wlAEHe)。'."\n"
+ .'> 使用V1.1.0及以上版本的SDK可用该字段。', 'type' => 'string', 'required' => false, 'example' => 'mm_xxx_xxx_xxx'],
],
[
'name' => 'UserType',
@@ -96,7 +233,7 @@
'schema' => [
'description' => '卖家类型。'."\n"
."\n"
- .'- 1：天猫；'."\n"
+ .'- 1：天猫，'."\n"
."\n"
.'- 0：淘宝。',
'type' => 'integer',
@@ -105,84 +242,42 @@
'maximum' => '1',
'minimum' => '0',
'example' => '0',
- 'enum' => [
- '0',
- '1',
- ],
+ 'enum' => ['0', '1'],
],
],
[
'name' => 'Crop',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否需要进行主体识别。默认true。'."\n"
- .' - 为true时，由系统进行主体识别。建议使用此方式。'."\n"
- .'- 为false时，则不进行主体识别，以整张图进行搜索。'."\n"
- ."\n\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n"
+ .' - 为true时，由系统进行主体识别。建议使用此方式。'."\n"
+ .'- 为false时，则不进行主体识别，以整张图进行搜索。'."\n"
+ ."\n\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Region',
'in' => 'formData',
- 'schema' => [
- 'description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n"
- .'> 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '280,486,232,351',
- ],
+ 'schema' => ['description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n"
+ .'> 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'],
],
[
'name' => 'Start',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回结果的起始位置。取值范围：0~499。默认值为0。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '499',
- 'minimum' => '0',
- 'example' => '0',
- 'default' => '0',
- ],
+ 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'Num',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回结果的数目。取值范围：1~20。默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '20',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '返回结果的数目。取值范围：1~20。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Fields',
'in' => 'formData',
- 'schema' => [
- 'description' => '需要返回的字段list。不同的字段用逗号分隔。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。可从下面值中选择填写ItemId,Title,PicUrl,ReservePrice,ZkFinalPrice,UserType,Provcity,Nick,SellerId,Volume,LevelOneCategoryName,CategoryName,CouponTotalCount,CouponRemainCount,CouponStartTime,CouponEndTime,CouponStartFee,CouponAmount,CouponInfo,CommissionRate,CouponShareUrl,Url,ShopTitle。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Url,UserType',
- ],
+ 'schema' => ['description' => '需要返回的字段list。不同的字段用逗号分割。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。', 'type' => 'string', 'required' => false, 'example' => 'Url,UserType'],
],
[
'name' => 'RelationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '渠道ID。用于淘宝联盟中的渠道区分。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1125526',
- ],
+ 'schema' => ['description' => '渠道ID。用于淘宝联盟中的渠道区分。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1125526'],
],
],
'responses' => [
@@ -192,26 +287,13 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => ' 错误码。'."\n"
- ."\n"
- .'- 0：成功，'."\n"
- ."\n"
- .'- 非0：失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => ' 错误码。'."\n"
+ ."\n"
+ .'- 0：成功，'."\n"
+ ."\n"
+ .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'sucess'],
'Data' => [
'description' => '识别结果集合。',
'type' => 'object',
@@ -227,195 +309,59 @@
'description' => '查询结果。',
'type' => 'object',
'properties' => [
- 'ItemId' => [
- 'description' => '商品信息-商品ID。',
- 'type' => 'string',
- 'example' => '0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz',
- ],
- 'Title' => [
- 'description' => '商品信息-商品标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'ShortTitle' => [
- 'description' => '商品信息-商品短标题（移动端建议使用）。',
- 'type' => 'string',
- 'example' => 'yyy套装',
- ],
- 'SubTitle' => [
- 'description' => '商品信息-商品子标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'PicUrl' => [
- 'description' => '商品信息-商品主图。',
- 'type' => 'string',
- 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg',
- ],
- 'ReservePrice' => [
- 'description' => '商品信息-一口价通常显示为划线价。'."\n",
- 'type' => 'string',
- 'example' => '158',
- ],
- 'ZkFinalPrice' => [
- 'description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。',
- 'type' => 'string',
- 'example' => '98',
- ],
- 'PriceAfterCoupon' => [
- 'description' => '商品信息-券后价。',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'UserType' => [
- 'description' => '店铺信息-卖家类型。'."\n"
- ."\n"
- .'- 1：天猫，'."\n"
- ."\n"
- .'- 0：淘宝。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Provcity' => [
- 'description' => '商品信息-宝贝所在地。',
- 'type' => 'string',
- 'example' => '广东 深圳',
- ],
- 'Nick' => [
- 'description' => '店铺信息-卖家昵称。'."\n",
- 'type' => 'string',
- 'example' => '衣服专卖店',
- ],
- 'SellerId' => [
- 'description' => '店铺信息-卖家ID。',
- 'type' => 'string',
- 'example' => '32590610',
- ],
- 'Volume' => [
- 'description' => '商品信息-30天销量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- 'LevelOneCategoryName' => [
- 'description' => '商品信息-叶子类目名称。',
- 'type' => 'string',
- 'example' => '童装/婴儿装/亲子装',
- ],
- 'CategoryName' => [
- 'description' => '商品信息-一级类目名称。',
- 'type' => 'string',
- 'example' => '连衣裙',
- ],
- 'CouponTotalCount' => [
- 'description' => '优惠券信息-优惠券总量。',
- 'type' => 'string',
- 'example' => '100000',
- ],
- 'CouponRemainCount' => [
- 'description' => '优惠券信息-优惠券剩余量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CouponStartTime' => [
- 'description' => '优惠券信息-优惠券开始时间。',
- 'type' => 'string',
- 'example' => '2021-05-01',
- ],
- 'CouponEndTime' => [
- 'description' => '优惠券信息-优惠券结束时间。',
- 'type' => 'string',
- 'example' => '2021-06-01',
- ],
- 'CouponStartFee' => [
- 'description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
- .'如：满299元减20元。',
- 'type' => 'string',
- 'example' => '98.000000',
- ],
- 'CouponAmount' => [
- 'description' => '优惠券（元），若属于预售商品，该优惠券付尾款可用，付定金不可用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'CouponInfo' => [
- 'description' => '优惠券信息-优惠券满减信息。',
- 'type' => 'string',
- 'example' => '满98.0元减5.0元',
- ],
- 'CommissionRate' => [
- 'description' => '商品信息-佣金比率。'."\n"
- .'如：1550表示15.5%。',
- 'type' => 'string',
- 'example' => '180',
- ],
- 'CouponShareUrl' => [
- 'description' => '链接-宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => '//uland.taobao.com/cxxxxxx',
- ],
- 'DeeplinkCouponShareUrl' => [
- 'description' => '优惠券-手淘唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'Url' => [
- 'description' => '链接-宝贝推广链接。',
- 'type' => 'string',
- 'example' => '//s.click.taobao.com/t?xxxxxx',
- ],
- 'DeeplinkUrl' => [
- 'description' => '链接-宝贝推广的深度唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'ShopTitle' => [
- 'description' => '店铺信息-店铺名称。',
- 'type' => 'string',
- 'example' => 'xx旗舰店',
- ],
+ 'ItemId' => ['description' => '商品信息-商品ID。', 'type' => 'string', 'example' => 'casdcascascasc-dsasdasdasdasdas'],
+ 'Title' => ['description' => '商品信息-商品标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'ShortTitle' => ['description' => '商品信息-商品短标题（移动端建议使用）。', 'type' => 'string', 'example' => 'yyy套装'],
+ 'SubTitle' => ['description' => '商品信息-商品子标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'PicUrl' => ['description' => '商品信息-商品主图。', 'type' => 'string', 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg'],
+ 'ReservePrice' => ['description' => '商品信息-一口价通常显示为划线价。', 'type' => 'string', 'example' => '158'],
+ 'ZkFinalPrice' => ['description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。', 'type' => 'string', 'example' => '98'],
+ 'PriceAfterCoupon' => ['description' => '商品信息-券后价。', 'type' => 'string', 'example' => '90'],
+ 'UserType' => ['description' => '店铺信息-卖家类型。'."\n"
+ ."\n"
+ .'- 1：天猫，'."\n"
+ ."\n"
+ .'- 0：淘宝。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Provcity' => ['description' => '商品信息-宝贝所在地。', 'type' => 'string', 'example' => '广东 深圳'],
+ 'Nick' => ['description' => '店铺信息-卖家昵称。', 'type' => 'string', 'example' => '衣服专卖店'],
+ 'SellerId' => ['description' => '店铺信息-卖家ID。', 'type' => 'string', 'example' => '32590610'],
+ 'Volume' => ['description' => '商品信息-30天销量。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ 'LevelOneCategoryName' => ['description' => '商品信息-叶子类目名称。', 'type' => 'string', 'example' => '童装/婴儿装/亲子装'],
+ 'CategoryName' => ['description' => '商品信息-一级类目名称。', 'type' => 'string', 'example' => '连衣裙'],
+ 'CouponTotalCount' => ['description' => '优惠券信息-优惠券总量。', 'type' => 'string', 'example' => '100000'],
+ 'CouponRemainCount' => ['description' => '优惠券信息-优惠券剩余量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CouponStartTime' => ['description' => '优惠券信息-优惠券开始时间。', 'type' => 'string', 'example' => '2021-05-01'],
+ 'CouponEndTime' => ['description' => '优惠券信息-优惠券结束时间。', 'type' => 'string', 'example' => '2021-06-01'],
+ 'CouponStartFee' => ['description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
+ .'如：满299元减20元。', 'type' => 'string', 'example' => '98.000000'],
+ 'CouponAmount' => ['description' => '优惠券（元）若属于预售商品，该优惠券付尾款可用，付定金不可用。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'CouponInfo' => ['description' => '优惠券信息-优惠券满减信息。', 'type' => 'string', 'example' => '满98.0元减5.0元'],
+ 'CommissionRate' => ['description' => '商品信息-佣金比率。'."\n"
+ .'如：1550表示15.5%。', 'type' => 'string', 'example' => '180'],
+ 'CouponShareUrl' => ['description' => '链接-宝贝+券二合一页面链接。', 'type' => 'string', 'example' => '//uland.taobao.com/xxxxxxx'],
+ 'DeeplinkCouponShareUrl' => ['description' => '优惠券-手淘唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'Url' => ['description' => '链接-宝贝推广链接。', 'type' => 'string', 'example' => '//s.click.taobao.com/t?xxxxxx'],
+ 'DeeplinkUrl' => ['description' => '链接-宝贝推广的深度唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'ShopTitle' => ['description' => '店铺信息-店铺名称。', 'type' => 'string', 'example' => 'xx旗舰店'],
'MaxCommission' => [
'description' => '商品信息-高佣信息。',
'type' => 'object',
'properties' => [
- 'MaxCommissionRate' => [
- 'description' => '商品信息-最优佣金率。 如：20.4表示佣金率为20.4%。',
- 'type' => 'string',
- 'example' => '20.4',
- ],
- 'MaxCommissionClickUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝推广链接。',
- 'type' => 'string',
- 'example' => 'https://s.click.taobao.com/t?e=xxxx',
- ],
- 'MaxCommissionCouponShareUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => 'https://s.click.taobao.com/t?e=xxxx',
- ],
+ 'MaxCommissionRate' => ['description' => '商品信息-最优佣金率。'."\n"
+ .'如：20.4表示佣金率为20.4%。', 'type' => 'string', 'example' => '20.4'],
+ 'MaxCommissionClickUrl' => ['description' => '商品信息-链接-最优佣金率宝贝推广链接。', 'type' => 'string', 'example' => 'https://s.click.taobao.com/t?e=xxxx'],
+ 'MaxCommissionCouponShareUrl' => ['description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。', 'type' => 'string', 'example' => 'https://uland.taobao.com/coupon/xxxx'],
],
],
],
],
- 'RankScore' => [
- 'description' => '商品相似性的排名分数。取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.337',
- ],
+ 'RankScore' => ['description' => '商品相似性的排名分数。取值范围：0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.337'],
],
],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'PicInfo' => [
'description' => '类目预测、主体识别结果等信息。',
'type' => 'object',
@@ -424,30 +370,16 @@
'description' => '主体多类目信息。',
'type' => 'object',
'properties' => [
- 'Region' => [
- 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。',
- 'type' => 'string',
- 'example' => '280,486,232,351',
- ],
+ 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
'MultiCategoryId' => [
- 'description' => '主体预测区域的类目预测结果结合。',
+ 'description' => '主体预测区域的类目预测结果集合。',
'type' => 'array',
'items' => [
'description' => '主体预测区域的类目预测结果。',
'type' => 'object',
'properties' => [
- 'CategoryId' => [
- 'description' => '图片类目。具体请参考[类目参考](~~179184~~)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '88888888',
- ],
- 'Score' => [
- 'description' => '预测的类目得分。取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.34',
- ],
+ 'CategoryId' => ['description' => '图片类目。具体请参考[类目参考](~~179184~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
+ 'Score' => ['description' => '预测的类目得分。取值范围：0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.34'],
],
],
],
@@ -460,11 +392,7 @@
'description' => '主体识别结果。',
'type' => 'object',
'properties' => [
- 'Region' => [
- 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。',
- 'type' => 'string',
- 'example' => '280,486,232,351',
- ],
+ 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
],
],
],
@@ -476,122 +404,37 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'PidNotExist',
- 'errorMessage' => 'The parameter specified Pid not exist',
- ],
- [
- 'errorCode' => 'InvalidPid',
- 'errorMessage' => 'The parameter Pid no specified',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'The request has invalid parameters.',
- ],
- [
- 'errorCode' => 'InstanceStatusError',
- 'errorMessage' => 'Your instance is unavailable.',
- ],
- [
- 'errorCode' => 'TimeoutForTransferImage',
- 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.',
- ],
- [
- 'errorCode' => 'NoSpecifiedSearchPic',
- 'errorMessage' => 'The search image is not specified.',
- ],
- [
- 'errorCode' => 'InvalidCategory',
- 'errorMessage' => 'The specified category is invalid.',
- ],
- [
- 'errorCode' => 'OverflowMaxResultNum',
- 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.',
- ],
- [
- 'errorCode' => 'OverflowMaxReturnNum',
- 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.',
- ],
- [
- 'errorCode' => 'InvalidStartParameter',
- 'errorMessage' => 'The specified parameter start is inavlid.',
- ],
- [
- 'errorCode' => 'InvalidNumParameter',
- 'errorMessage' => 'The specified parameter num is invalid.',
- ],
- [
- 'errorCode' => 'InvalidIntAttr',
- 'errorMessage' => 'The specified int_attr field is invalid.',
- ],
- [
- 'errorCode' => 'UnsupportedPicFormat',
- 'errorMessage' => 'The specified image format is invalid.',
- ],
- [
- 'errorCode' => 'InvalidFilterClause',
- 'errorMessage' => 'The specified filtering condition is invalid.',
- ],
- [
- 'errorCode' => 'IncorrectOrientation',
- 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.',
- ],
- [
- 'errorCode' => 'UnsupportedPicPixels',
- 'errorMessage' => 'The specified pixels is not supported.',
- ],
- [
- 'errorCode' => 'SearchTimeout',
- 'errorMessage' => 'The request is timed out.',
- ],
- [
- 'errorCode' => 'NoSpecifiedPicContent',
- 'errorMessage' => 'The parameter PicContent no specified.',
- ],
- [
- 'errorCode' => 'InvalidCustomContent',
- 'errorMessage' => 'The specified parameter CustomContent is not valid.',
- ],
- [
- 'errorCode' => 'InvalidPicContent',
- 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.',
- ],
- [
- 'errorCode' => 'InvalidPicUrl',
- 'errorMessage' => 'The specified parameter PicUrl is not valid.',
- ],
- [
- 'errorCode' => 'NotRegisterBeforeInvoke',
- 'errorMessage' => 'Need register token: pid before invoke.',
- ],
+ ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
+ ['errorCode' => 'InvalidPid', 'errorMessage' => 'The parameter Pid no specified', 'description' => ''],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
+ ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
+ ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
+ ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
+ ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
+ ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
+ ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
+ ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
+ ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
+ ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
+ ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
+ ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
+ ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
+ ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
+ ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
+ ['errorCode' => 'NotRegisterBeforeInvoke', 'errorMessage' => 'Need register token: pid before invoke.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this operation.',
- ],
- [
- 'errorCode' => 'DeniedRequest',
- 'errorMessage' => 'Your request was denied due to instance flow control.',
- ],
+ ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
],
500 => [
- [
- 'errorCode' => 'UnknownException',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- [
- 'errorCode' => 'NetworkException',
- 'errorMessage' => 'A network error occurred.',
- ],
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => '​The request is timeout.',
- ],
+ ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
+ ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'],
+ ['errorCode' => 'InternalException', 'errorMessage' => 'An internal server error occurred.', 'description' => ''],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => '​The request is timeout.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/cxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
- 'title' => '根据图片URL查询',
+ 'title' => '根据图片查询',
'description' => '## 使用说明'."\n"
.'本接口用于向淘宝联盟版在线调用。'."\n"
."\n"
@@ -599,16 +442,26 @@
.'查询操作默认5QPS。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
- ],
- 'SearchByPic' => [
- 'summary' => '本文为您介绍SearchByPic接口的语法及示例，用于向淘宝联盟版在线调用。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:SearchByPic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"sucess\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"casdcascascasc-dsasdasdasdasdas\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/xxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://uland.taobao.com/coupon/xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ ],
+ 'SearchByUrl' => [
+ 'summary' => '本文为您介绍SearchByUrl接口的语法及示例，用于向淘宝联盟版在线调用。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -619,21 +472,9 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'PicContent',
+ 'name' => 'PicUrl',
'in' => 'formData',
- 'schema' => [
- 'description' => '图片内容。'."\n"
- .' - 图片大小要求不超过4 MB。'."\n"
- .' - 图片格式：PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、PPM。'."\n"
- .' - 传输等待时间不超过5秒。'."\n"
- .' - 图片中不能包含旋转信息。'."\n"
- .'> - 如使用SDK，则无需填写PicContent字段，SDK已将本字段封装为PicContentObject字段无需处理。'."\n"
- ."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- 'isFileTransferUrl' => true,
- ],
+ 'schema' => ['description' => '图片URL。必须是HTTP或HTTPS开头。', 'type' => 'string', 'required' => true, 'example' => 'https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg'],
],
[
'name' => 'CategoryId',
@@ -647,34 +488,14 @@
'maximum' => '88888888',
'minimum' => '0',
'example' => '88888888',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- '9',
- '20',
- '21',
- '22',
- '88888888',
- ],
+ 'enum' => ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '20', '21', '22', '88888888'],
],
],
[
'name' => 'Pid',
'in' => 'formData',
- 'schema' => [
- 'description' => 'PID。具体请参考[PID](https://mos.m.taobao.com/union/pub/site/help?spm=a219t.11817172.PortalLayout.d52e56935.27ac6a15wlAEHe)。'."\n"
- .'> 使用V1.1.0及以上版本的SDK可用该字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mm_xxx_xxx_xxx',
- ],
+ 'schema' => ['description' => 'PID。具体请参考[PID](https://help.alimama.com/?spm=a219t.23786078.0.0.290575a55P1LBx#!/search/index?spm=&keyWord=PID&knowledgeId=5625118&categoryId=1000040170)。'."\n"
+ .'> 使用V1.1.0及以上版本的SDK可用该字段。', 'type' => 'string', 'required' => false, 'example' => 'mm_xxx_xxx_xxx'],
],
[
'name' => 'UserType',
@@ -682,7 +503,7 @@
'schema' => [
'description' => '卖家类型。'."\n"
."\n"
- .'- 1：天猫，'."\n"
+ .'- 1：天猫；'."\n"
."\n"
.'- 0：淘宝。',
'type' => 'integer',
@@ -691,84 +512,42 @@
'maximum' => '1',
'minimum' => '0',
'example' => '0',
- 'enum' => [
- '0',
- '1',
- ],
+ 'enum' => ['0', '1'],
],
],
[
'name' => 'Crop',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否需要进行主体识别。默认true。'."\n"
- .' - 为true时，由系统进行主体识别。建议使用此方式。'."\n"
- .'- 为false时，则不进行主体识别，以整张图进行搜索。'."\n"
- ."\n\n",
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否需要进行主体识别。默认true。'."\n"
+ .' - 为true时，由系统进行主体识别。建议使用此方式。'."\n"
+ .'- 为false时，则不进行主体识别，以整张图进行搜索。'."\n"
+ ."\n\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Region',
'in' => 'formData',
- 'schema' => [
- 'description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n"
- .'> 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '280,486,232,351',
- ],
+ 'schema' => ['description' => '图片的主体区域，格式为`x1,x2,y1,y2`, 其中`x1,y1 `是左上角的点，`x2,y2`是右下角的点。'."\n"
+ .'> 若用户设置了Region，则不论Crop参数为何值，都将以用户输入Region进行搜索。', 'type' => 'string', 'required' => false, 'example' => '280,486,232,351'],
],
[
'name' => 'Start',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回结果的起始位置。取值范围：0~499。默认值为0。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '499',
- 'minimum' => '0',
- 'example' => '0',
- 'default' => '0',
- ],
+ 'schema' => ['description' => '返回结果的起始位置。取值范围：0~499。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '499', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'Num',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回结果的数目。取值范围：1~20。默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '20',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '返回结果的数目。取值范围：1~20。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Fields',
'in' => 'formData',
- 'schema' => [
- 'description' => '需要返回的字段list。不同的字段用逗号分割。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Url,UserType',
- ],
+ 'schema' => ['description' => '需要返回的字段list。不同的字段用逗号分隔。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。可从下面值中选择填写ItemId,Title,PicUrl,ReservePrice,ZkFinalPrice,UserType,Provcity,Nick,SellerId,Volume,LevelOneCategoryName,CategoryName,CouponTotalCount,CouponRemainCount,CouponStartTime,CouponEndTime,CouponStartFee,CouponAmount,CouponInfo,CommissionRate,CouponShareUrl,Url,ShopTitle。', 'type' => 'string', 'required' => false, 'example' => 'Url,UserType'],
],
[
'name' => 'RelationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '渠道ID。用于淘宝联盟中的渠道区分。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1125526',
- ],
+ 'schema' => ['description' => '渠道ID。用于淘宝联盟中的渠道区分。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1125526'],
],
],
'responses' => [
@@ -778,26 +557,13 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => ' 错误码。'."\n"
- ."\n"
- .'- 0：成功，'."\n"
- ."\n"
- .'- 非0：失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'sucess',
- ],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => ' 错误码。'."\n"
+ ."\n"
+ .'- 0：成功，'."\n"
+ ."\n"
+ .'- 非0：失败。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'Data' => [
'description' => '识别结果集合。',
'type' => 'object',
@@ -813,196 +579,58 @@
'description' => '查询结果。',
'type' => 'object',
'properties' => [
- 'ItemId' => [
- 'description' => '商品信息-商品ID。',
- 'type' => 'string',
- 'example' => 'casdcascascasc-dsasdasdasdasdas',
- ],
- 'Title' => [
- 'description' => '商品信息-商品标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'ShortTitle' => [
- 'description' => '商品信息-商品短标题（移动端建议使用）。',
- 'type' => 'string',
- 'example' => 'yyy套装',
- ],
- 'SubTitle' => [
- 'description' => '商品信息-商品子标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'PicUrl' => [
- 'description' => '商品信息-商品主图。',
- 'type' => 'string',
- 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg',
- ],
- 'ReservePrice' => [
- 'description' => '商品信息-一口价通常显示为划线价。',
- 'type' => 'string',
- 'example' => '158',
- ],
- 'ZkFinalPrice' => [
- 'description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。',
- 'type' => 'string',
- 'example' => '98',
- ],
- 'PriceAfterCoupon' => [
- 'description' => '商品信息-券后价。',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'UserType' => [
- 'description' => '店铺信息-卖家类型。'."\n"
- ."\n"
- .'- 1：天猫，'."\n"
- ."\n"
- .'- 0：淘宝。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Provcity' => [
- 'description' => '商品信息-宝贝所在地。',
- 'type' => 'string',
- 'example' => '广东 深圳',
- ],
- 'Nick' => [
- 'description' => '店铺信息-卖家昵称。',
- 'type' => 'string',
- 'example' => '衣服专卖店',
- ],
- 'SellerId' => [
- 'description' => '店铺信息-卖家ID。',
- 'type' => 'string',
- 'example' => '32590610',
- ],
- 'Volume' => [
- 'description' => '商品信息-30天销量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- 'LevelOneCategoryName' => [
- 'description' => '商品信息-叶子类目名称。',
- 'type' => 'string',
- 'example' => '童装/婴儿装/亲子装',
- ],
- 'CategoryName' => [
- 'description' => '商品信息-一级类目名称。',
- 'type' => 'string',
- 'example' => '连衣裙',
- ],
- 'CouponTotalCount' => [
- 'description' => '优惠券信息-优惠券总量。',
- 'type' => 'string',
- 'example' => '100000',
- ],
- 'CouponRemainCount' => [
- 'description' => '优惠券信息-优惠券剩余量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CouponStartTime' => [
- 'description' => '优惠券信息-优惠券开始时间。',
- 'type' => 'string',
- 'example' => '2021-05-01',
- ],
- 'CouponEndTime' => [
- 'description' => '优惠券信息-优惠券结束时间。',
- 'type' => 'string',
- 'example' => '2021-06-01',
- ],
- 'CouponStartFee' => [
- 'description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
- .'如：满299元减20元。',
- 'type' => 'string',
- 'example' => '98.000000',
- ],
- 'CouponAmount' => [
- 'description' => '优惠券（元）若属于预售商品，该优惠券付尾款可用，付定金不可用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'CouponInfo' => [
- 'description' => '优惠券信息-优惠券满减信息。',
- 'type' => 'string',
- 'example' => '满98.0元减5.0元',
- ],
- 'CommissionRate' => [
- 'description' => '商品信息-佣金比率。'."\n"
- .'如：1550表示15.5%。',
- 'type' => 'string',
- 'example' => '180',
- ],
- 'CouponShareUrl' => [
- 'description' => '链接-宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => '//uland.taobao.com/xxxxxxx',
- ],
- 'DeeplinkCouponShareUrl' => [
- 'description' => '优惠券-手淘唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'Url' => [
- 'description' => '链接-宝贝推广链接。',
- 'type' => 'string',
- 'example' => '//s.click.taobao.com/t?xxxxxx',
- ],
- 'DeeplinkUrl' => [
- 'description' => '链接-宝贝推广的深度唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'ShopTitle' => [
- 'description' => '店铺信息-店铺名称。',
- 'type' => 'string',
- 'example' => 'xx旗舰店',
- ],
+ 'ItemId' => ['description' => '商品信息-商品ID。', 'type' => 'string', 'example' => '0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz'],
+ 'Title' => ['description' => '商品信息-商品标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'ShortTitle' => ['description' => '商品信息-商品短标题（移动端建议使用）。', 'type' => 'string', 'example' => 'yyy套装'],
+ 'SubTitle' => ['description' => '商品信息-商品子标题。', 'type' => 'string', 'example' => 'xxx套装'],
+ 'PicUrl' => ['description' => '商品信息-商品主图。', 'type' => 'string', 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg'],
+ 'ReservePrice' => ['description' => '商品信息-一口价通常显示为划线价。'."\n", 'type' => 'string', 'example' => '158'],
+ 'ZkFinalPrice' => ['description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。', 'type' => 'string', 'example' => '98'],
+ 'PriceAfterCoupon' => ['description' => '商品信息-券后价。', 'type' => 'string', 'example' => '90'],
+ 'UserType' => ['description' => '店铺信息-卖家类型。'."\n"
+ ."\n"
+ .'- 1：天猫，'."\n"
+ ."\n"
+ .'- 0：淘宝。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Provcity' => ['description' => '商品信息-宝贝所在地。', 'type' => 'string', 'example' => '广东 深圳'],
+ 'Nick' => ['description' => '店铺信息-卖家昵称。'."\n", 'type' => 'string', 'example' => '衣服专卖店'],
+ 'SellerId' => ['description' => '店铺信息-卖家ID。', 'type' => 'string', 'example' => '32590610'],
+ 'Volume' => ['description' => '商品信息-30天销量。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ 'LevelOneCategoryName' => ['description' => '商品信息-叶子类目名称。', 'type' => 'string', 'example' => '童装/婴儿装/亲子装'],
+ 'CategoryName' => ['description' => '商品信息-一级类目名称。', 'type' => 'string', 'example' => '连衣裙'],
+ 'CouponTotalCount' => ['description' => '优惠券信息-优惠券总量。', 'type' => 'string', 'example' => '100000'],
+ 'CouponRemainCount' => ['description' => '优惠券信息-优惠券剩余量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CouponStartTime' => ['description' => '优惠券信息-优惠券开始时间。', 'type' => 'string', 'example' => '2021-05-01'],
+ 'CouponEndTime' => ['description' => '优惠券信息-优惠券结束时间。', 'type' => 'string', 'example' => '2021-06-01'],
+ 'CouponStartFee' => ['description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
+ .'如：满299元减20元。', 'type' => 'string', 'example' => '98.000000'],
+ 'CouponAmount' => ['description' => '优惠券（元），若属于预售商品，该优惠券付尾款可用，付定金不可用。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'CouponInfo' => ['description' => '优惠券信息-优惠券满减信息。', 'type' => 'string', 'example' => '满98.0元减5.0元'],
+ 'CommissionRate' => ['description' => '商品信息-佣金比率。'."\n"
+ .'如：1550表示15.5%。', 'type' => 'string', 'example' => '180'],
+ 'CouponShareUrl' => ['description' => '链接-宝贝+券二合一页面链接。', 'type' => 'string', 'example' => '//uland.taobao.com/cxxxxxx'],
+ 'DeeplinkCouponShareUrl' => ['description' => '优惠券-手淘唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'Url' => ['description' => '链接-宝贝推广链接。', 'type' => 'string', 'example' => '//s.click.taobao.com/t?xxxxxx'],
+ 'DeeplinkUrl' => ['description' => '链接-宝贝推广的深度唤醒链接。', 'type' => 'string', 'example' => 'tbopen://m.taobao.com/tbopen/index.html?'],
+ 'ShopTitle' => ['description' => '店铺信息-店铺名称。', 'type' => 'string', 'example' => 'xx旗舰店'],
'MaxCommission' => [
'description' => '商品信息-高佣信息。',
'type' => 'object',
'properties' => [
- 'MaxCommissionRate' => [
- 'description' => '商品信息-最优佣金率。'."\n"
- .'如：20.4表示佣金率为20.4%。',
- 'type' => 'string',
- 'example' => '20.4',
- ],
- 'MaxCommissionClickUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝推广链接。',
- 'type' => 'string',
- 'example' => 'https://s.click.taobao.com/t?e=xxxx',
- ],
- 'MaxCommissionCouponShareUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => 'https://uland.taobao.com/coupon/xxxx',
- ],
+ 'MaxCommissionRate' => ['description' => '商品信息-最优佣金率。 如：20.4表示佣金率为20.4%。', 'type' => 'string', 'example' => '20.4'],
+ 'MaxCommissionClickUrl' => ['description' => '商品信息-链接-最优佣金率宝贝推广链接。', 'type' => 'string', 'example' => 'https://s.click.taobao.com/t?e=xxxx'],
+ 'MaxCommissionCouponShareUrl' => ['description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。', 'type' => 'string', 'example' => 'https://s.click.taobao.com/t?e=xxxx'],
],
],
],
],
- 'RankScore' => [
- 'description' => '商品相似性的排名分数。取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.337',
- ],
+ 'RankScore' => ['description' => '商品相似性的排名分数。取值范围：0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.337'],
],
],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879'],
'PicInfo' => [
'description' => '类目预测、主体识别结果等信息。',
'type' => 'object',
@@ -1011,30 +639,16 @@
'description' => '主体多类目信息。',
'type' => 'object',
'properties' => [
- 'Region' => [
- 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。',
- 'type' => 'string',
- 'example' => '280,486,232,351',
- ],
+ 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
'MultiCategoryId' => [
- 'description' => '主体预测区域的类目预测结果集合。',
+ 'description' => '主体预测区域的类目预测结果结合。',
'type' => 'array',
'items' => [
'description' => '主体预测区域的类目预测结果。',
'type' => 'object',
'properties' => [
- 'CategoryId' => [
- 'description' => '图片类目。具体请参考[类目参考](~~179184~~)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '88888888',
- ],
- 'Score' => [
- 'description' => '预测的类目得分。取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.34',
- ],
+ 'CategoryId' => ['description' => '图片类目。具体请参考[类目参考](~~179184~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '88888888'],
+ 'Score' => ['description' => '预测的类目得分。取值范围：0~1。', 'type' => 'number', 'format' => 'float', 'example' => '0.34'],
],
],
],
@@ -1047,11 +661,7 @@
'description' => '主体识别结果。',
'type' => 'object',
'properties' => [
- 'Region' => [
- 'description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。',
- 'type' => 'string',
- 'example' => '280,486,232,351',
- ],
+ 'Region' => ['description' => '主体识别结果。图片的主体区域，格式为x1,x2,y1,y2，其中 x1,y1 是左上角的点，x2，y2是右下角的点。若用户请求中指定了主体区域，则以请求中为准。', 'type' => 'string', 'example' => '280,486,232,351'],
],
],
],
@@ -1063,110 +673,40 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidPicContent',
- 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.',
- ],
- [
- 'errorCode' => 'InvalidPid',
- 'errorMessage' => 'The parameter Pid no specified',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'The request has invalid parameters.',
- ],
- [
- 'errorCode' => 'NoSpecifiedSearchPic',
- 'errorMessage' => 'The search image is not specified.',
- ],
- [
- 'errorCode' => 'InvalidCategory',
- 'errorMessage' => 'The specified category is invalid.',
- ],
- [
- 'errorCode' => 'OverflowMaxResultNum',
- 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.',
- ],
- [
- 'errorCode' => 'OverflowMaxReturnNum',
- 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.',
- ],
- [
- 'errorCode' => 'InvalidStartParameter',
- 'errorMessage' => 'The specified parameter start is inavlid.',
- ],
- [
- 'errorCode' => 'InvalidNumParameter',
- 'errorMessage' => 'The specified parameter num is invalid.',
- ],
- [
- 'errorCode' => 'InvalidIntAttr',
- 'errorMessage' => 'The specified int_attr field is invalid.',
- ],
- [
- 'errorCode' => 'UnsupportedPicFormat',
- 'errorMessage' => 'The specified image format is invalid.',
- ],
- [
- 'errorCode' => 'InvalidFilterClause',
- 'errorMessage' => 'The specified filtering condition is invalid.',
- ],
- [
- 'errorCode' => 'IncorrectOrientation',
- 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.',
- ],
- [
- 'errorCode' => 'UnsupportedPicPixels',
- 'errorMessage' => 'The specified pixels is not supported.',
- ],
- [
- 'errorCode' => 'SearchTimeout',
- 'errorMessage' => 'The request is timed out.',
- ],
- [
- 'errorCode' => 'NoSpecifiedPicContent',
- 'errorMessage' => 'The parameter PicContent no specified.',
- ],
- [
- 'errorCode' => 'InvalidCustomContent',
- 'errorMessage' => 'The specified parameter CustomContent is not valid.',
- ],
- [
- 'errorCode' => 'NotRegisterBeforeInvoke',
- 'errorMessage' => 'Need register token: pid before invoke.',
- ],
+ ['errorCode' => 'PidNotExist', 'errorMessage' => 'The parameter specified Pid not exist', 'description' => ''],
+ ['errorCode' => 'InvalidPid', 'errorMessage' => 'The parameter Pid no specified', 'description' => ''],
+ ['errorCode' => 'BadRequest', 'errorMessage' => 'The request has invalid parameters.', 'description' => ''],
+ ['errorCode' => 'InstanceStatusError', 'errorMessage' => 'Your instance is unavailable.', 'description' => ''],
+ ['errorCode' => 'TimeoutForTransferImage', 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.', 'description' => ''],
+ ['errorCode' => 'NoSpecifiedSearchPic', 'errorMessage' => 'The search image is not specified.', 'description' => ''],
+ ['errorCode' => 'InvalidCategory', 'errorMessage' => 'The specified category is invalid.', 'description' => '无效的类目id'],
+ ['errorCode' => 'OverflowMaxResultNum', 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.', 'description' => '超过了最大的返回结果限制数500'],
+ ['errorCode' => 'OverflowMaxReturnNum', 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.', 'description' => '单次返回数超过限制值100'],
+ ['errorCode' => 'InvalidStartParameter', 'errorMessage' => 'The specified parameter start is inavlid.', 'description' => ''],
+ ['errorCode' => 'InvalidNumParameter', 'errorMessage' => 'The specified parameter num is invalid.', 'description' => '无效的字段num'],
+ ['errorCode' => 'InvalidIntAttr', 'errorMessage' => 'The specified int_attr field is invalid.', 'description' => '无效的int过滤字段'],
+ ['errorCode' => 'UnsupportedPicFormat', 'errorMessage' => 'The specified image format is invalid.', 'description' => '无效的图片格式'],
+ ['errorCode' => 'InvalidFilterClause', 'errorMessage' => 'The specified filtering condition is invalid.', 'description' => '无效的过滤条件'],
+ ['errorCode' => 'IncorrectOrientation', 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.', 'description' => '图片包含不支持的旋转参数'],
+ ['errorCode' => 'UnsupportedPicPixels', 'errorMessage' => 'The specified pixels is not supported.', 'description' => '图片像素值不支持'],
+ ['errorCode' => 'SearchTimeout', 'errorMessage' => 'The request is timed out.', 'description' => ''],
+ ['errorCode' => 'NoSpecifiedPicContent', 'errorMessage' => 'The parameter PicContent no specified.', 'description' => ''],
+ ['errorCode' => 'InvalidCustomContent', 'errorMessage' => 'The specified parameter CustomContent is not valid.', 'description' => ''],
+ ['errorCode' => 'InvalidPicContent', 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.', 'description' => ''],
+ ['errorCode' => 'InvalidPicUrl', 'errorMessage' => 'The specified parameter PicUrl is not valid.', 'description' => '无效的PicUrl参数'],
+ ['errorCode' => 'NotRegisterBeforeInvoke', 'errorMessage' => 'Need register token: pid before invoke.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'DeniedRequest',
- 'errorMessage' => 'Your request was denied due to instance flow control.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this operation.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation.', 'description' => '未授权的行为'],
+ ['errorCode' => 'DeniedRequest', 'errorMessage' => 'Your request was denied due to instance flow control.', 'description' => '请求被限流'],
],
500 => [
- [
- 'errorCode' => 'UnknownException',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- [
- 'errorCode' => 'NetworkException',
- 'errorMessage' => 'A network error occurred.',
- ],
- [
- 'errorCode' => 'InternalException',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => '​The request is timeout.',
- ],
+ ['errorCode' => 'UnknownException', 'errorMessage' => 'An internal server error occurred.', 'description' => '未知异常'],
+ ['errorCode' => 'NetworkException', 'errorMessage' => 'A network error occurred.', 'description' => '内部错误：请求网络异常'],
+ ['errorCode' => 'RequestTimeout', 'errorMessage' => '​The request is timeout.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"sucess\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"casdcascascasc-dsasdasdasdasdas\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/xxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://uland.taobao.com/coupon/xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
- 'title' => '根据图片查询',
+ 'title' => '根据图片URL查询',
'description' => '## 使用说明'."\n"
.'本接口用于向淘宝联盟版在线调用。'."\n"
."\n"
@@ -1174,465 +714,182 @@
.'查询操作默认5QPS。',
'extraInfo' => '## 错误码'."\n"
.'请参见[错误码](~~66619~~)。',
- ],
- 'GetProductInfoByIds' => [
- 'summary' => '本文为您介绍GetProductInfoByIds接口的语法及示例，用于向淘宝联盟版在线调用。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'name' => 'ItemIds',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '商品ID串，用\',\'分割，最大40个。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '111,22,33',
- ],
- ],
- [
- 'name' => 'Pid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'PID。具体请参考[PID](https://mos.m.taobao.com/union/pub/site/help?spm=a219t.11817172.PortalLayout.d52e56935.27ac6a15wlAEHe)。'."\n"
- .'> 使用V1.1.0及以上版本的SDK可用该字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mm_xxx_xxx_xxx',
- ],
- ],
- [
- 'name' => 'Fields',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '需要返回的字段list。不同的字段用逗号分割。默认PicUrl,ReservePrice,Title,Url,ZkFinalPrice字段必返回。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Url,UserType',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '错误码。'."\n"
- ."\n"
- .'- 0：成功，'."\n"
- .'- 非0：失败。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'description' => '识别结果集合。',
- 'type' => 'object',
- 'properties' => [
- 'Auctions' => [
- 'description' => '识别结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '查询结果内容。',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => '查询结果。',
- 'type' => 'object',
- 'properties' => [
- 'InputItemId' => [
- 'description' => '商品信息-商品ID。'."\n"
- .'> SDK1.2.3使用，和搜索传入的ItemIds相同。',
- 'type' => 'string',
- 'example' => '123000123',
- ],
- 'ItemId' => [
- 'description' => '商品信息-商品ID。'."\n"
- .'> SDK1.2.3使用，动态商品ID。',
- 'type' => 'string',
- 'example' => 'Oqz93kougf9bkN7f4ACMtJ',
- ],
- 'Title' => [
- 'description' => '商品信息-商品标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'ShortTitle' => [
- 'description' => '商品信息-商品短标题（移动端建议使用）。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'SubTitle' => [
- 'description' => '商品信息-商品子标题。',
- 'type' => 'string',
- 'example' => 'xxx套装',
- ],
- 'PicUrl' => [
- 'description' => '商品信息-商品主图。',
- 'type' => 'string',
- 'example' => '//img.alicdn.com/i1/FXXXXXXXXXX.jpg',
- ],
- 'ReservePrice' => [
- 'description' => '商品信息-一口价通常显示为划线价。'."\n",
- 'type' => 'string',
- 'example' => '150',
- ],
- 'ZkFinalPrice' => [
- 'description' => '商品信息-在线售价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价格。',
- 'type' => 'string',
- 'example' => '98',
- ],
- 'PriceAfterCoupon' => [
- 'description' => '商品信息-券后价。',
- 'type' => 'string',
- 'example' => '90',
- ],
- 'UserType' => [
- 'description' => '店铺信息-卖家类型。'."\n"
- ."\n"
- .'- 1：天猫，'."\n"
- .'- 0：淘宝。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Provcity' => [
- 'description' => '商品信息-宝贝所在地。',
- 'type' => 'string',
- 'example' => '广东 深圳',
- ],
- 'Nick' => [
- 'description' => '店铺信息-卖家昵称。'."\n",
- 'type' => 'string',
- 'example' => '衣服专卖店',
- ],
- 'SellerId' => [
- 'description' => '店铺信息-卖家id。',
- 'type' => 'string',
- 'example' => '32590610',
- ],
- 'CategoryName' => [
- 'description' => '商品信息-一级类目名称。',
- 'type' => 'string',
- 'example' => '连衣裙',
- ],
- 'Volume' => [
- 'description' => '商品信息-30天销量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- 'LevelOneCategoryName' => [
- 'description' => '商品信息-叶子类目名称。',
- 'type' => 'string',
- 'example' => '童装/婴儿装/亲子装',
- ],
- 'CouponTotalCount' => [
- 'description' => '优惠券信息-优惠券总量。',
- 'type' => 'string',
- 'example' => '10000',
- ],
- 'CouponRemainCount' => [
- 'description' => '优惠券信息-优惠券剩余量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CouponStartTime' => [
- 'description' => '优惠券信息-优惠券开始时间。',
- 'type' => 'string',
- 'example' => '2021-05-01',
- ],
- 'CouponEndTime' => [
- 'description' => '优惠券信息-优惠券结束时间。',
- 'type' => 'string',
- 'example' => '2021-06-01',
- ],
- 'CouponStartFee' => [
- 'description' => '优惠券信息-优惠券启用门槛，满X元可用。'."\n"
- .'如：满299元减20元。',
- 'type' => 'string',
- 'example' => '98.000000',
- ],
- 'CouponAmount' => [
- 'description' => '优惠券（元），若属于预售商品，该优惠券付尾款可用，付定金不可用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'CouponInfo' => [
- 'description' => '优惠券信息-优惠券满减信息。',
- 'type' => 'string',
- 'example' => '满98.0元减5.0元',
- ],
- 'CommissionRate' => [
- 'description' => '商品信息-佣金比率。'."\n"
- .'如：1550表示15.5%。',
- 'type' => 'string',
- 'example' => '180',
- ],
- 'CouponShareUrl' => [
- 'description' => '链接-宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'DeeplinkCouponShareUrl' => [
- 'description' => '优惠券-手淘唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'Url' => [
- 'description' => '链接-宝贝推广链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'DeeplinkUrl' => [
- 'description' => '链接-宝贝推广的深度唤醒链接。',
- 'type' => 'string',
- 'example' => 'tbopen://m.taobao.com/tbopen/index.html?',
- ],
- 'ShopTitle' => [
- 'description' => '店铺信息-店铺名称。',
- 'type' => 'string',
- 'example' => 'xx旗舰店',
- ],
- 'MaxCommission' => [
- 'description' => '商品信息-高佣信息。',
- 'type' => 'object',
- 'properties' => [
- 'MaxCommissionRate' => [
- 'description' => '商品信息-最优佣金率。 如：20.4表示佣金率为20.4%。',
- 'type' => 'string',
- 'example' => '20.4',
- ],
- 'MaxCommissionClickUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝推广链接。',
- 'type' => 'string',
- 'example' => 'https://s.click.taobao.com/t?e=xxxx',
- ],
- 'MaxCommissionCouponShareUrl' => [
- 'description' => '商品信息-链接-最优佣金率宝贝+券二合一页面链接。',
- 'type' => 'string',
- 'example' => 'https://s.click.taobao.com/t?e=xxxx',
- ],
- ],
- ],
- ],
- ],
- 'RankScore' => [
- 'description' => '商品相似性的排名分数。取值范围：0~1。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.34',
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'B3137727-7D6E-488C-BA21-0E034C38A879',
- ],
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:SearchByUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'PidNotExist',
- 'errorMessage' => 'The parameter specified Pid not exist',
- ],
- [
- 'errorCode' => 'InvalidPid',
- 'errorMessage' => 'The parameter Pid no specified',
- ],
- [
- 'errorCode' => 'BadRequest',
- 'errorMessage' => 'The request has invalid parameters.',
- ],
- [
- 'errorCode' => 'InstanceStatusError',
- 'errorMessage' => 'Your instance is unavailable.',
- ],
- [
- 'errorCode' => 'TimeoutForTransferImage',
- 'errorMessage' => 'Timeout after 5 seconds waiting for images transfer to complete.',
- ],
- [
- 'errorCode' => 'InvalidInstance',
- 'errorMessage' => 'The specified instance name is invalid.',
- ],
- [
- 'errorCode' => 'InvalidItemIds',
- 'errorMessage' => 'ItemIds parameter overflow number max 40.',
- ],
- [
- 'errorCode' => 'OverflowMaxResultNum',
- 'errorMessage' => 'The specified number of total results exceeds the maximum of 500.',
- ],
- [
- 'errorCode' => 'OverflowMaxReturnNum',
- 'errorMessage' => 'The specified number of results for each request exceeds the maximum of 100.',
- ],
- [
- 'errorCode' => 'InvalidStartParameter',
- 'errorMessage' => 'The specified parameter start is inavlid.',
- ],
- [
- 'errorCode' => 'InvalidNumParameter',
- 'errorMessage' => 'The specified parameter num is invalid.',
- ],
- [
- 'errorCode' => 'InvalidIntAttr',
- 'errorMessage' => 'The specified int_attr field is invalid.',
- ],
- [
- 'errorCode' => 'UnsupportedPicFormat',
- 'errorMessage' => 'The specified image format is invalid.',
- ],
- [
- 'errorCode' => 'InvalidFilterClause',
- 'errorMessage' => 'The specified filtering condition is invalid.',
- ],
- [
- 'errorCode' => 'IncorrectOrientation',
- 'errorMessage' => 'The image contains incorrect rotation flags in the meta data.',
- ],
- [
- 'errorCode' => 'UnsupportedPicPixels',
- 'errorMessage' => 'The specified pixels is not supported.',
- ],
- [
- 'errorCode' => 'SearchTimeout',
- 'errorMessage' => 'The request is timed out.',
- ],
- [
- 'errorCode' => 'NoSpecifiedPicContent',
- 'errorMessage' => 'The parameter PicContent no specified.',
- ],
- [
- 'errorCode' => 'InvalidCustomContent',
- 'errorMessage' => 'The specified parameter CustomContent is not valid.',
- ],
- [
- 'errorCode' => 'InvalidPicContent',
- 'errorMessage' => 'The specified parameter PicContent length greater than 4 * 1024 * 1024.',
- ],
- [
- 'errorCode' => 'InvalidPicUrl',
- 'errorMessage' => 'The specified parameter PicUrl is not valid.',
- ],
- [
- 'errorCode' => 'NotRegisterBeforeInvoke',
- 'errorMessage' => 'Need register token: pid before invoke.',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"ItemId\\": \\"0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"yyy套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"158\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"CouponTotalCount\\": \\"100000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 5,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"//uland.taobao.com/cxxxxxx\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"//s.click.taobao.com/t?xxxxxx\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.337\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\",\\n \\"PicInfo\\": {\\n \\"MainRegion\\": {\\n \\"Region\\": \\"280,486,232,351\\",\\n \\"MultiCategoryId\\": [\\n {\\n \\"CategoryId\\": 88888888,\\n \\"Score\\": 0.34\\n }\\n ]\\n },\\n \\"MultiRegion\\": [\\n {\\n \\"Region\\": \\"280,486,232,351\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-southeast-2.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-beijing.aliyuncs.com', 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'imagesearch-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'imagesearch.eu-central-1.aliyuncs.com', 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'imagesearch.ap-south-1.aliyuncs.com', 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com', 'vpc' => 'imagesearch-vpc.ap-south-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AccessEngineFailed', 'message' => 'An error occurred while accessing the search engine.', 'http_code' => 400, 'description' => '内部错误：请求引擎失败'],
+ ['code' => 'ConnectionDVException', 'message' => 'Failed to obtain collection.', 'http_code' => 500, 'description' => 'internalError'],
+ ['code' => 'Console.BadRequest', 'message' => 'The request has invalid parameters.', 'http_code' => 400, 'description' => '非法请求，请检查请求参数。'],
+ ['code' => 'Console.CallServiceError', 'message' => 'An internal service error occurred.', 'http_code' => 500, 'description' => '访问内部服务错误'],
+ ['code' => 'Console.InstanceNotFound', 'message' => 'The specified ImageSearch instance is not found.', 'http_code' => 400, 'description' => '查找不到实例，检查购买的实例ID是否正确。'],
+ ['code' => 'Console.InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 409, 'description' => '实例状态错误，请检查实例状态'],
+ ['code' => 'Console.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => '服务器内部错误，请登录阿里云控制台提交工单。'],
+ ['code' => 'Console.LoginError', 'message' => 'Check login failed.', 'http_code' => 401, 'description' => '登录失败，请检查用户名、密码、邮箱是否输入有误。'],
+ ['code' => 'Console.MigrateCapacityError', 'message' => 'Migration instance specification error.', 'http_code' => 400, 'description' => '迁移的目标实例规格错误，目标实例规格必须大于等于源实例规格'],
+ ['code' => 'Console.MigrateDocNumError', 'message' => 'Migration target instance doc quantity error.', 'http_code' => 400, 'description' => '目标实例的doc数量必须为0'],
+ ['code' => 'Console.MigrateError', 'message' => 'An instance can only have one migration task.', 'http_code' => 400, 'description' => '实例只能存在一个迁移任务'],
+ ['code' => 'Console.MigrateExistError', 'message' => 'Only one migration task can exist in an instance.', 'http_code' => 400, 'description' => '当前实例下只能存在一个迁移任务。'],
+ ['code' => 'Console.MigrateTypeError', 'message' => 'Migration instance type error.', 'http_code' => 400, 'description' => '迁移的两个实例类型必须相同'],
+ ['code' => 'Console.ModifyTokenTimesExceed', 'message' => 'You can only modify the token once every day.', 'http_code' => 400, 'description' => '用户当天的修改次数不能超过1次'],
+ ['code' => 'Console.NoPermissionError', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '你没有权限进行该操作'],
+ ['code' => 'Console.NotAllowedModifyToken', 'message' => 'You are not allowed to modify token today.', 'http_code' => 403, 'description' => '今天不允许用户修改该token值'],
+ ['code' => 'Console.OrderStatusError', 'message' => 'Current Order status not supported this opreate.', 'http_code' => 409, 'description' => '用户订单错误，请确认订单处于有效状态'],
+ ['code' => 'Console.PidDescError', 'message' => 'The maximum character length of this PidDesc parameter is 32.', 'http_code' => 400, 'description' => 'PidDesc 这个字符串长度最长32位'],
+ ['code' => 'Console.PidError', 'message' => 'The number of PID bindings of the current instance exceeds 50.', 'http_code' => 400, 'description' => '当前实例PID绑定数量超过50'],
+ ['code' => 'Console.TaskAlreadyExist', 'message' => 'A task that is in progress already exists.', 'http_code' => 409, 'description' => '已经存在正在运行的任务。'],
+ ['code' => 'DeniedRequest', 'message' => 'Your request was denied due to instance flow control.', 'http_code' => 403, 'description' => '请求被限流'],
+ ['code' => 'EmptyMeta', 'message' => 'The body content has an empty meta field.', 'http_code' => 400, 'description' => '请求body含有空的字段'],
+ ['code' => 'ExtractFeatureTimeout', 'message' => 'The request timed out while extracting features.', 'http_code' => 500, 'description' => '内部错误：提取特征超时'],
+ ['code' => 'IncorrectOrientation', 'message' => 'The image contains incorrect rotation flags in the meta data.', 'http_code' => 400, 'description' => '图片包含不支持的旋转参数'],
+ ['code' => 'InstanceOverQuota', 'message' => 'The number of items exceeds the limit.', 'http_code' => 400, 'description' => '实例的图片数量超过限制值'],
+ ['code' => 'InstanceStatusError', 'message' => 'The current instance status does not support this operation.', 'http_code' => 400, 'description' => '实例状态不可用'],
+ ['code' => 'InternalOssError', 'message' => 'An internal OAS error occurred.', 'http_code' => 500, 'description' => '内部错误：请求内部算法错误'],
+ ['code' => 'InternalSwiftError', 'message' => 'An internal SWIFT error occurred.', 'http_code' => 500, 'description' => '内部错误：请求内部消息队列错误'],
+ ['code' => 'InternalTableStoreError', 'message' => 'An internal Table Store error occurred.', 'http_code' => 500, 'description' => '内部错误：请求特征存储错误'],
+ ['code' => 'InvalidCategory', 'message' => 'The specified category is invalid.', 'http_code' => 400, 'description' => '无效的类目id'],
+ ['code' => 'InvalidCategoryId', 'message' => 'The specified CategoryId parameter is invalid.', 'http_code' => 400, 'description' => '无效CategoryId'],
+ ['code' => 'InvalidCrop', 'message' => 'The specified Crop parameter is invalid.', 'http_code' => 400, 'description' => '无效Crop'],
+ ['code' => 'InvalidCustomContent', 'message' => 'The specified CustomContent is invalid.', 'http_code' => 400, 'description' => '无效的自定义内容'],
+ ['code' => 'InvalidFilterClause', 'message' => 'The specified filtering condition is invalid.', 'http_code' => 400, 'description' => '无效的过滤条件'],
+ ['code' => 'InvalidInstance', 'message' => 'The specified instance name is invalid.', 'http_code' => 400, 'description' => '实例名错误'],
+ ['code' => 'InvalidIntAttr', 'message' => 'The specified int_attr field is invalid.', 'http_code' => 400, 'description' => '无效的int过滤字段'],
+ ['code' => 'InvalidIntAttr', 'message' => 'The specified parameter IntAttr is not valid.', 'http_code' => 400, 'description' => '无效IntAttr'],
+ ['code' => 'InvalidIntAttr2', 'message' => 'The specified parameter IntAttr2 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr2'],
+ ['code' => 'InvalidIntAttr3', 'message' => 'The specified parameter IntAttr3 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr3'],
+ ['code' => 'InvalidIntAttr4', 'message' => 'The specified parameter IntAttr4 is not valid.', 'http_code' => 400, 'description' => '无效IntAttr4'],
+ ['code' => 'InvalidMetaItem', 'message' => 'The meta field is invalid.', 'http_code' => 400, 'description' => '无效的元信息字段'],
+ ['code' => 'InvalidNum', 'message' => 'The specified Num parameter is invalid.', 'http_code' => 400, 'description' => '无效num'],
+ ['code' => 'InvalidNumParameter', 'message' => 'The specified parameter num is invalid.', 'http_code' => 400, 'description' => '无效的字段num'],
+ ['code' => 'InvalidParameterReturnPicFormat', 'message' => 'The specified parameter returnPicFormat is invalid', 'http_code' => 400, 'description' => '入参ReturnPicFormat错误，仅支持png或jpg'],
+ ['code' => 'InvalidParameterReturnPicType', 'message' => 'The specified parameter returnPicType is invalid', 'http_code' => 400, 'description' => '入参ReturnPicType错误，仅支持score_image或white_bk'],
+ ['code' => 'InvalidParameterTitleIndex', 'message' => 'The specified parameter titleIndex is invalid.', 'http_code' => 400, 'description' => '无效的titleIndex参数，仅支持1,2,3.'],
+ ['code' => 'InvalidPicContent', 'message' => 'The image size exceeds 4 MB.', 'http_code' => 400, 'description' => '图片大小超过4M'],
+ ['code' => 'InvalidPicList', 'message' => 'The specified pic_list parameter is invalid.', 'http_code' => 400, 'description' => '无效的pic_list字段'],
+ ['code' => 'InvalidPicName', 'message' => 'The specified PicName is invalid.', 'http_code' => 400, 'description' => '无效的图片名称'],
+ ['code' => 'InvalidPicUrl', 'message' => 'The specified parameter PicUrl is not valid.', 'http_code' => 400, 'description' => '无效的PicUrl参数'],
+ ['code' => 'InvalidPrimaryPicContent', 'message' => 'The specified parameter PrimaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的PrimaryPicContent参数'],
+ ['code' => 'InvalidProductId', 'message' => 'The specified ProductId is invalid.', 'http_code' => 400, 'description' => '无效的商品id'],
+ ['code' => 'InvalidProductId', 'message' => 'The parameter ProductId no specified.', 'http_code' => 400, 'description' => 'ProductId无效'],
+ ['code' => 'InvalidSecondaryPicContent', 'message' => 'The specified parameter SecondaryPicContent is not valid.', 'http_code' => 400, 'description' => '无效的SecondaryPicContent参数'],
+ ['code' => 'InvalidStart', 'message' => 'The specified Start parameter is invalid.', 'http_code' => 400, 'description' => '无效Start'],
+ ['code' => 'InvalidStartParameter', 'message' => 'The specified parameter start is invalid.', 'http_code' => 400, 'description' => '无效的字段start'],
+ ['code' => 'InvalidStrAttr', 'message' => 'The specified StrAttr is invalid.', 'http_code' => 400, 'description' => '无效的过滤值'],
+ ['code' => 'InvalidStrAttr', 'message' => 'The specified parameter StrAttr is not valid.', 'http_code' => 400, 'description' => '无效StrAttr'],
+ ['code' => 'InvalidStrAttr2', 'message' => 'The specified parameter StrAttr2 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr2'],
+ ['code' => 'InvalidStrAttr3', 'message' => 'The specified parameter StrAttr3 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr3'],
+ ['code' => 'InvalidStrAttr4', 'message' => 'The specified parameter StrAttr4 is not valid.', 'http_code' => 400, 'description' => '无效StrAttr4'],
+ ['code' => 'InvalidText', 'message' => 'The specified parameter Text is not valid.', 'http_code' => 400, 'description' => '描述信息Text不能为null'],
+ ['code' => 'InvalidTextLength', 'message' => 'Invalid text clause.', 'http_code' => 400, 'description' => 'text字段长度必须在512内。'],
+ ['code' => 'InvalidType', 'message' => 'The specified Type is invalid.', 'http_code' => 400, 'description' => '不支持的参数类型'],
+ ['code' => 'InvalidUserType', 'message' => 'The specified UserType parameter is invalid.', 'http_code' => 400, 'description' => '无效UserType'],
+ ['code' => 'NeedRegisterBeforeInvoke', 'message' => 'Register for PID before invoking the service.', 'http_code' => 400, 'description' => '调用前需要先注册pid'],
+ ['code' => 'NetworkException', 'message' => 'A network error occurred.', 'http_code' => 500, 'description' => '内部错误：请求网络异常'],
+ ['code' => 'NoCaretSeperator', 'message' => 'The body content is missing the ^ separator.', 'http_code' => 400, 'description' => '请求body缺少特定符号'],
+ ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => '未授权的行为'],
+ ['code' => 'NoPicList', 'message' => 'The body content is missing the pic_list parameter.', 'http_code' => 400, 'description' => '未指定pic_list字段'],
+ ['code' => 'NoSpecifiedAddPic', 'message' => 'You must specify an image.', 'http_code' => 400, 'description' => '未指定图片'],
+ ['code' => 'NoSpecifiedItemId', 'message' => 'You must specify item_id.', 'http_code' => 400, 'description' => '未指定商品id'],
+ ['code' => 'NoSpecifiedPic', 'message' => 'The content of an image is not specified in the HTTP POST body.', 'http_code' => 400, 'description' => '图片未指定'],
+ ['code' => 'NoSpecifiedPicContent', 'message' => 'You must specify PicContent.', 'http_code' => 400, 'description' => '未指定图片内容'],
+ ['code' => 'NoSpecifiedPicName', 'message' => 'You must specify PicName.', 'http_code' => 400, 'description' => '未指定图片名称'],
+ ['code' => 'NoSpecifiedProductId', 'message' => 'You must specify ProductId.', 'http_code' => 400, 'description' => '未指定商品id'],
+ ['code' => 'NoSpecifiedSearchPic', 'message' => 'You must specify a search image.', 'http_code' => 400, 'description' => '图片未指定'],
+ ['code' => 'OverflowMaxResultNum', 'message' => 'The specified number of total results exceeds the maximum of 500.', 'http_code' => 400, 'description' => '超过了最大的返回结果限制数500'],
+ ['code' => 'OverflowMaxReturnNum', 'message' => 'The specified number of results for each request exceeds the maximum of 100.', 'http_code' => 400, 'description' => '单次返回数超过限制值100'],
+ ['code' => 'PicNotExist', 'message' => 'The specified image does not exist.', 'http_code' => 400, 'description' => '图片未指定'],
+ ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 500, 'description' => '图片下载失败，请检查图片'],
+ ['code' => 'PidNotExist', 'message' => 'The specified Pid parameter does not exist.', 'http_code' => 400, 'description' => 'Pid不存在'],
+ ['code' => 'RequestTimeout', 'message' => 'The request timed out.', 'http_code' => 500, 'description' => '内部错误：请求超时'],
+ ['code' => 'SearchTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => '请求超时'],
+ ['code' => 'ServerInternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部错误'],
+ ['code' => 'TimeoutForTransferImage', 'message' => 'Image transfer timed out.', 'http_code' => 400, 'description' => '客户端图片传输超时'],
+ ['code' => 'UnknownException', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => '未知异常'],
+ ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 500, 'description' => '内部错误：不支持的实例类型'],
+ ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 500, 'description' => '内部错误：不支持的action'],
+ ['code' => 'UnsupportedPicCategory', 'message' => 'The picture category is not supported.', 'http_code' => 400, 'description' => '图片对应的类目不支持，目前仅支持鞋子和衣服'],
+ ['code' => 'UnsupportedPicFormat', 'message' => 'The specified image format is invalid.', 'http_code' => 400, 'description' => '无效的图片格式'],
+ ['code' => 'UnsupportedPicPixels', 'message' => 'The specified pixels is not supported.', 'http_code' => 400, 'description' => '图片像素值不支持'],
+ ['code' => 'UnsupportedPictureFormat', 'message' => 'The format of the specified picture is not supported.', 'http_code' => 400, 'description' => '用户图片格式不支持'],
+ ['code' => 'UnsupportedInstanceType', 'message' => 'The instance type is not supported.', 'http_code' => 400, 'description' => '内部错误：不支持的实例类型'],
+ ['code' => 'UnsupportedOperationType', 'message' => 'The specified action is not supported.', 'http_code' => 400, 'description' => '内部错误：不支持的action'],
+ ['code' => 'PictureError', 'message' => '[download] Img Download Failed.', 'http_code' => 400, 'description' => '图片下载失败，请检查图片'],
+ ['code' => 'Console.OssError', 'message' => 'OSS information error.', 'http_code' => 400, 'description' => 'oss 信息错误'],
+ ],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'ImageSearch',
+ 'productName' => '图像搜索',
+ 'ramCodes' => ['imagesearch'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'SearchByPic',
+ 'description' => '根据图片查询',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:SearchByPic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this operation.',
- ],
- [
- 'errorCode' => 'DeniedRequest',
- 'errorMessage' => 'Your request was denied due to instance flow control.',
+ ],
+ [
+ 'apiName' => 'SearchByUrl',
+ 'description' => '根据图片URL查询',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:SearchByUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'An internal server error occurred.',
- ],
- [
- 'errorCode' => 'NetworkException',
- 'errorMessage' => 'A network error occurred.',
- ],
- [
- 'errorCode' => 'RequestTimeout',
- 'errorMessage' => '​The request is timeout.',
+ ],
+ [
+ 'apiName' => 'GetProductInfoByIds',
+ 'description' => '根据ID查询商品',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'imagesearch:GetProductInfoByIds',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ImageSearch', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Auctions\\": [\\n {\\n \\"Result\\": {\\n \\"InputItemId\\": \\"123000123\\",\\n \\"ItemId\\": \\"Oqz93kougf9bkN7f4ACMtJ\\",\\n \\"Title\\": \\"xxx套装\\",\\n \\"ShortTitle\\": \\"xxx套装\\",\\n \\"SubTitle\\": \\"xxx套装\\",\\n \\"PicUrl\\": \\"//img.alicdn.com/i1/FXXXXXXXXXX.jpg\\",\\n \\"ReservePrice\\": \\"150\\",\\n \\"ZkFinalPrice\\": \\"98\\",\\n \\"PriceAfterCoupon\\": \\"90\\",\\n \\"UserType\\": 0,\\n \\"Provcity\\": \\"广东 深圳\\",\\n \\"Nick\\": \\"衣服专卖店\\",\\n \\"SellerId\\": \\"32590610\\",\\n \\"CategoryName\\": \\"连衣裙\\",\\n \\"Volume\\": 500,\\n \\"LevelOneCategoryName\\": \\"童装/婴儿装/亲子装\\",\\n \\"CouponTotalCount\\": \\"10000\\",\\n \\"CouponRemainCount\\": 0,\\n \\"CouponStartTime\\": \\"2021-05-01\\",\\n \\"CouponEndTime\\": \\"2021-06-01\\",\\n \\"CouponStartFee\\": \\"98.000000\\",\\n \\"CouponAmount\\": 8,\\n \\"CouponInfo\\": \\"满98.0元减5.0元\\",\\n \\"CommissionRate\\": \\"180\\",\\n \\"CouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkCouponShareUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"Url\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"DeeplinkUrl\\": \\"tbopen://m.taobao.com/tbopen/index.html?\\",\\n \\"ShopTitle\\": \\"xx旗舰店\\",\\n \\"MaxCommission\\": {\\n \\"MaxCommissionRate\\": \\"20.4\\",\\n \\"MaxCommissionClickUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\",\\n \\"MaxCommissionCouponShareUrl\\": \\"https://s.click.taobao.com/t?e=xxxx\\"\\n }\\n },\\n \\"RankScore\\": 0.34\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B3137727-7D6E-488C-BA21-0E034C38A879\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
- 'title' => '根据ID查询商品',
- 'description' => '## 使用说明'."\n"
- .'本接口用于向淘宝联盟版在线调用。'."\n"
- .'> 推荐使用SDK1.2.3及以上版本，返回动态商品ID。'."\n"
- ."\n"
- .'## QPS限制'."\n"
- .'查询操作默认5QPS。'."\n",
- 'extraInfo' => '## 错误码'."\n"
- .'请参见[错误码](~~66619~~)。',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'imagesearch.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'imagesearch.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'imagesearch.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'imagesearch.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'imagesearch.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'imagesearch.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'imagesearch.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'imagesearch.ap-southeast-2.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'imagesearch.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'imagesearch.ap-south-1.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:42:48 +0000