本文为您介绍SearchByUrl接口的语法及示例,用于向淘宝联盟版在线调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchByUrl

系统规定参数。取值:SearchByUrl

PicUrl String https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg

图片URL。必须是HTTP或HTTPS开头。

CategoryId Integer 88888888

图片类目。具体请参考类目参考

说明 如果设置类目,则以设置的为准;如果不设置类目,则由系统进行类目预测,预测的类目结果可以在Response中获取 。
Crop Boolean true

是否需要进行主体识别。默认true。

  • 为true时,由系统进行主体识别,以识别的主体进行搜索,主体识别结果可在Response中获取。
  • 为false时,则不进行主体识别,以整张图进行搜索。
Region String 280,486,232,351

图片的主体区域,格式为x1,x2,y1,y2, 其中x1,y1 是左上角的点,x2,y2是右下角的点。

说明 若用户设置了Region,则不论Crop参数为何值,都将以用户输入Region进行搜索。
Start Integer 0

返回结果的起始位置。取值范围:0~499。默认值为0。

Num Integer 10

返回结果的数目。取值范围:1~20。默认值为10。

Fields String ClickUrl

需要返回的字段list。不同的字段用逗号分割。默认ClickUrl,ItemName,Pic,Price,PromotionPrice字段必返回。

RelationId Long 1125526

渠道ID。用于淘宝联盟中的渠道区分。

返回数据

名称 类型 示例值 描述
Success Boolean true

请求是否成功。

Code Integer 0

错误码。

0:成功,

非0:失败。

Message String sucess

错误信息。

Data Object

识别结果集合。

Auctions Array of auction

识别结果。

Result Object

查询结果。

ItemId String 638848296260

商品信息-宝贝id。

ItemName String 宝宝连衣裙

商品信息-商品标题。

Pic String //img.alicdn.com/i1/3994587735/O1CN01r4NeS3270gFJEV1AZ_!!0-item_pic.jpg

商品信息-商品主图。

Price String 158

商品信息-一口价。

PromotionPrice String 98

折扣价(元),若属于预售商品,付定金时间内,折扣价=预售价。

UserType Integer 0

店铺信息-卖家类型。

1:天猫,

0:淘宝,

3:特价版。

Provcity String 广东 深圳

商品信息-宝贝所在地。

SellerNickName String 衣服专卖店

店铺信息-卖家昵称。

SellerId String 32590610

店铺信息-卖家id。

MonthSellCount Integer 1

商品信息-30天销量(饿了么卡券信息-总销量)。

LevelOneCategoryName String 童装/婴儿装/亲子装

商品信息-叶子类目名称。

CategoryName String 连衣裙

商品信息-一级类目名称。

CouponTotalCount String 100000

优惠券信息-优惠券总量。

CouponRemainCount Integer 0

优惠券信息-优惠券剩余量。

CouponStartTime String 2021-05-01

优惠券信息-优惠券开始时间。

CouponEndTime String 2021-06-01

优惠券信息-优惠券结束时间。

CouponStartFee String 98.000000

优惠券信息-优惠券启用门槛,满X元可用。

如:满299元减20元。

CouponAmount Integer 5

优惠券(元),若属于预售商品,该优惠券付尾款可用,付定金不可用。

CouponSaleTextInfo String 满98.0元减5.0元

优惠券信息-优惠券满减信息。

CommissionRate String 180

商品信息-佣金比率。

如:1550表示15.5%。

CouponShareUrl String //uland.taobao.com/cxxxxxx

链接-宝贝+券二合一页面链接。

ClickUrl String //s.click.taobao.com/cccccc

链接-宝贝推广链接。

RankScore Float 0.337

商品相似性的排名分数。取值范围:0~1。

RequestId String B3137727-7D6E-488C-BA21-0E034C38A879

请求ID。

PicInfo Object

类目预测、主体识别结果等信息。

MainRegion Object

主体多类目信息。

Region String 280,486,232,351

主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

MultiCategoryId Array of cate

主体预测区域的类目预测结果结合。

CategoryId Integer 88888888

图片类目。具体请参考类目参考

Score Float 0.34

预测的类目得分。取值范围:0~1。

MultiRegion Array of reg

主体识别结果集合。

Region String 280,486,232,351

主体识别结果。图片的主体区域,格式为x1,x2,y1,y2,其中 x1,y1 是左上角的点,x2,y2是右下角的点。若用户请求中指定了主体区域,则以请求中为准。

示例

请求示例

{
        "picUrl": "https://oss-test.oss-cn-shanghai.aliyuncs.com/xxxx.jpg"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "rankScore" : 0.4555,
  "result" : {
    "CommissionRate" : "180",
    "categoryName" : "湿巾",
    "clickUrl" : "//s.click.taobao.com/t?eion_id=",
    "couponAmount" : 5,
    "couponEndTime" : "2021-06-01",
    "couponRemainCount" : 9730,
    "couponSaleTextInfo" : "满54.0元减5.0元",
    "couponShareUrl" : "//uland.taobao.com/xxx/eekJ17LB40ba",
    "couponStartFee" : "54.000000",
    "couponStartTime" : "2021-04-24",
    "couponTotalCount" : "10000",
    "itemId" : "618030053778",
    "itemName" : "特价湿巾纸",
    "levelOneCategoryName" : "婴童用品",
    "monthSellCount" : 196,
    "pic" : "//img.alicdn.com/i1/268_pic.jpg",
    "price" : "218",
    "productId" : "618030053778",
    "promotionPrice" : "54.9",
    "provcity" : "安徽 芜湖",
    "sellerId" : "2682789975",
    "sellerNickName" : "衣服专卖店",
    "userType" : 1
  }
}