本文為您介紹SearchByUrl接口的語法及示例,用于向淘寶聯盟版在線調用。
使用說明
本接口用于向淘寶聯盟版在線調用。
QPS限制
查詢操作默認5QPS。
調試
您可以在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中獲取 。 |
Pid | String | 否 | mm_xxx_xxx_xxx | PID。具體請參考PID。 說明 使用V1.1.0及以上版本的SDK可用該字段。 |
UserType | Long | 否 | 0 | 賣家類型。
|
Crop | Boolean | 否 | true | 是否需要進行主體識別。默認true。
|
Region | String | 否 | 280,486,232,351 | 圖片的主體區域,格式為 說明 若用戶設置了Region,則不論Crop參數為何值,都將以用戶輸入Region進行搜索。 |
Start | Integer | 否 | 0 | 返回結果的起始位置。取值范圍:0~499。默認值為0。 |
Num | Integer | 否 | 10 | 返回結果的數目。取值范圍:1~20。默認值為10。 |
Fields | String | 否 | Url,UserType | 需要返回的字段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。 |
RelationId | Long | 否 | 1125526 | 渠道ID。用于淘寶聯盟中的渠道區分。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
Success | Boolean | true | 請求是否成功。 |
Code | Integer | 0 | 錯誤碼。
|
Message | String | success | 錯誤信息。 |
Data | Object | 識別結果集合。 |
|
Auctions | Array of auction | 識別結果。 |
|
Result | Object | 查詢結果。 |
|
ItemId | String | 0gkRpWudf8Qk6G0AqU6NZH2t6-4asdasdaszxczxpz | 商品信息-商品ID。 |
Title | String | xxx套裝 | 商品信息-商品標題。 |
ShortTitle | String | yyy套裝 | 商品信息-商品短標題(移動端建議使用)。 |
SubTitle | String | xxx套裝 | 商品信息-商品子標題。 |
PicUrl | String | //img.alicdn.com/i1/FXXXXXXXXXX.jpg | 商品信息-商品主圖。 |
ReservePrice | String | 158 | 商品信息-一口價通常顯示為劃線價。 |
ZkFinalPrice | String | 98 | 商品信息-在線售價(元)。若屬于預售商品,付定金時間內,在線售賣價=預售價格。 |
PriceAfterCoupon | String | 90 | 商品信息-券后價。 |
UserType | Integer | 0 | 店鋪信息-賣家類型。
|
Provcity | String | 廣東 深圳 | 商品信息-寶貝所在地。 |
Nick | String | 衣服專賣店 | 店鋪信息-賣家昵稱。 |
SellerId | String | 32590610 | 店鋪信息-賣家ID。 |
Volume | Integer | 500 | 商品信息-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 | 優惠券(元),若屬于預售商品,該優惠券付尾款可用,付定金不可用。 |
CouponInfo | String | 滿98.0元減5.0元 | 優惠券信息-優惠券滿減信息。 |
CommissionRate | String | 180 | 商品信息-傭金比率。 如:1550表示15.5%。 |
CouponShareUrl | String | //uland.taobao.com/cxxxxxx | 鏈接-寶貝+券二合一頁面鏈接。 |
DeeplinkCouponShareUrl | String | tbopen://m.taobao.com/tbopen/index.html? | 優惠券-手淘喚醒鏈接。 |
Url | String | //s.click.taobao.com/t?xxxxxx | 鏈接-寶貝推廣鏈接。 |
DeeplinkUrl | String | tbopen://m.taobao.com/tbopen/index.html? | 鏈接-寶貝推廣的深度喚醒鏈接。 |
ShopTitle | String | xx旗艦店 | 店鋪信息-店鋪名稱。 |
MaxCommission | Object | 商品信息-高傭信息。 |
|
MaxCommissionRate | String | 20.4 | 商品信息-最優傭金率。 如:20.4表示傭金率為20.4%。 |
MaxCommissionClickUrl | String | https://s.click.taobao.com/t?e=xxxx | 商品信息-鏈接-最優傭金率寶貝推廣鏈接。 |
MaxCommissionCouponShareUrl | String | https://s.click.taobao.com/t?e=xxxx | 商品信息-鏈接-最優傭金率寶貝+券二合一頁面鏈接。 |
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",
"pid":"mm_xxx_xxx_xxx"
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : 0,
"data" : {
"auctions" : [ {
"rankScore" : 0.9877,
"result" : {
"itemId" : "22222",
"shortTitle" : "xxx套裝",
"subTitle" : "xxx套裝",
"categoryName" : "USB風扇",
"commissionRate" : "90",
"couponAmount" : 2,
"couponEndTime" : "2021-08-31",
"couponInfo" : "滿15.0元減2.0元",
"couponRemainCount" : 72287,
"couponShareUrl" : "http://uland.taobao.com/coupon/edetail?xxx",
"couponStartFee" : "15.000000",
"couponStartTime" : "2021-07-06",
"couponTotalCount" : "100000",
"levelOneCategoryName" : "3C數碼配件",
"maxCommission" : {
"maxCommissionClickUrl" : "https://s.click.taobao.com/txxxx",
"maxCommissionCouponShareUrl" : "https://uland.taobao.com/xxxxx",
"maxCommissionRate" : "0.90"
},
"nick" : "urkazf旗艦店",
"picUrl" : "http://img.alicdn.com/pic.jpg",
"provcity" : "廣東 深圳",
"reservePrice" : "65.8",
"sellerId" : "2207366944297",
"shopTitle" : "urkazf旗艦店",
"title" : "【官方推薦】電風扇",
"url" : "http://s.click.taobao.com/t?xxx",
"userType" : 1,
"volume" : 12515,
"zkFinalPrice" : "15.8",
"priceAfterCoupon" : "12.8",
"DeeplinkUrl" : "tbopen://m.taobao.com/tbopen/index.html?",
"DeeplinkCouponShareUrl" : "tbopen://m.taobao.com/tbopen/index.html?"
}
} ]
},
"picInfo" : {
"mainRegion" : {
"multiCategoryId" : [ {
"categoryId" : 88888888,
"score" : 0.79521
}, {
"categoryId" : 22,
"score" : 0.13365
}, {
"categoryId" : 9,
"score" : 0.00778
}, {
"categoryId" : 7,
"score" : 0.00685
} ],
"region" : "428,750,64,739"
},
"multiRegion" : [ {
"region" : "428,750,64,739"
}, {
"region" : "428,750,64,739"
} ]
},
"requestId" : "xx-FDF7-xxx-A794-xxx",
"success" : true
}
錯誤碼
請參見錯誤碼。