\TbkDgMaterialOptionalRequest

TOP API: taobao.tbk.dg.material.optional request

Summary

Methods
Properties
Constants
setAdzoneId()
getAdzoneId()
setCat()
getCat()
setCityCode()
getCityCode()
setDeviceEncrypt()
getDeviceEncrypt()
setDeviceType()
getDeviceType()
setDeviceValue()
getDeviceValue()
setEndKaTkRate()
getEndKaTkRate()
setEndPrice()
getEndPrice()
setEndTkRate()
getEndTkRate()
setGetTopnRate()
getGetTopnRate()
setHasCoupon()
getHasCoupon()
setIncludeGoodRate()
getIncludeGoodRate()
setIncludePayRate30()
getIncludePayRate30()
setIncludeRfdRate()
getIncludeRfdRate()
setIp()
getIp()
setIsOverseas()
getIsOverseas()
setIsTmall()
getIsTmall()
setItemloc()
getItemloc()
setLatitude()
getLatitude()
setLockRateEndTime()
getLockRateEndTime()
setLockRateStartTime()
getLockRateStartTime()
setLongitude()
getLongitude()
setMaterialId()
getMaterialId()
setNeedFreeShipment()
getNeedFreeShipment()
setNeedPrepay()
getNeedPrepay()
setNpxLevel()
getNpxLevel()
setPageNo()
getPageNo()
setPageResultKey()
getPageResultKey()
setPageSize()
getPageSize()
setPlatform()
getPlatform()
setQ()
getQ()
setRelationId()
getRelationId()
setSellerIds()
getSellerIds()
setSort()
getSort()
setSpecialId()
getSpecialId()
setStartDsr()
getStartDsr()
setStartKaTkRate()
getStartKaTkRate()
setStartPrice()
getStartPrice()
setStartTkRate()
getStartTkRate()
setUcrowdId()
getUcrowdId()
setUcrowdRankItems()
getUcrowdRankItems()
getApiMethodName()
getApiParas()
check()
putOtherTextParam()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$adzoneId
$cat
$cityCode
$deviceEncrypt
$deviceType
$deviceValue
$endKaTkRate
$endPrice
$endTkRate
$getTopnRate
$hasCoupon
$includeGoodRate
$includePayRate30
$includeRfdRate
$ip
$isOverseas
$isTmall
$itemloc
$latitude
$lockRateEndTime
$lockRateStartTime
$longitude
$materialId
$needFreeShipment
$needPrepay
$npxLevel
$pageNo
$pageResultKey
$pageSize
$platform
$q
$relationId
$sellerIds
$sort
$specialId
$startDsr
$startKaTkRate
$startPrice
$startTkRate
$ucrowdId
$ucrowdRankItems
$apiParas
N/A

Properties

$adzoneId

$adzoneId : 

mm_xxx_xxx_12345678三段式的最后一段数字

Type

$cat

$cat : 

商品筛选-后台类目ID。用,分割,最大10个,该ID可以通过taobao.itemcats.get接口获取到

Type

$cityCode

$cityCode : 

本地化业务入参-LBS信息-国标城市码,仅支持单个请求,请求饿了么卡券物料时,该字段必填。 (详细城市ID见:https://mo.m.taobao.com/page_2020010315120200508)

Type

$deviceEncrypt

$deviceEncrypt : 

智能匹配-设备号加密类型:MD5

Type

$deviceType

$deviceType : 

智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID

Type

$deviceValue

$deviceValue : 

智能匹配-设备号加密后的值(MD5加密需32位小写)

Type

$endKaTkRate

$endKaTkRate : 

商品筛选-KA媒体淘客佣金比率上限。如:1234表示12.34%

Type

$endPrice

$endPrice : 

商品筛选-折扣价范围上限。单位:元

Type

$endTkRate

$endTkRate : 

商品筛选-淘客佣金比率上限。如:1234表示12.34%

Type

$getTopnRate

$getTopnRate : 

是否获取前N件佣金信息 0否,1是,其他值否

Type

$hasCoupon

$hasCoupon : 

优惠券筛选-是否有优惠券。true表示该商品有优惠券,false或不设置表示不限

Type

$includeGoodRate

$includeGoodRate : 

商品筛选-好评率是否高于行业均值。True表示大于等于,false或不设置表示不限

Type

$includePayRate30

$includePayRate30 : 

商品筛选(特定媒体支持)-成交转化是否高于行业均值。True表示大于等于,false或不设置表示不限

Type

$includeRfdRate

$includeRfdRate : 

商品筛选(特定媒体支持)-退款率是否低于行业均值。True表示大于等于,false或不设置表示不限

Type

$ip

$ip : 

ip参数影响邮费获取,如果不传或者传入不准确,邮费无法精准提供

Type

$isOverseas

$isOverseas : 

商品筛选-是否海外商品。true表示属于海外商品,false或不设置表示不限

Type

$isTmall

$isTmall : 

商品筛选-是否天猫商品。true表示属于天猫商品,false或不设置表示不限

Type

$itemloc

$itemloc : 

商品筛选-所在地

Type

$latitude

$latitude : 

本地化业务入参-LBS信息-纬度

Type

$lockRateEndTime

$lockRateEndTime : 

锁佣结束时间

Type

$lockRateStartTime

$lockRateStartTime : 

锁佣开始时间

Type

$longitude

$longitude : 

本地化业务入参-LBS信息-经度

Type

$materialId

$materialId : 

不传时默认物料id=2836;如果直接对消费者投放,可使用官方个性化算法优化的搜索物料id=17004

Type

$needFreeShipment

$needFreeShipment : 

商品筛选-是否包邮。true表示包邮,false或不设置表示不限

Type

$needPrepay

$needPrepay : 

商品筛选-是否加入消费者保障。true表示加入,false或不设置表示不限

Type

$npxLevel

$npxLevel : 

商品筛选-牛皮癣程度。取值:1不限,2无,3轻微

Type

$pageNo

$pageNo : 

第几页,默认:1

Type

$pageResultKey

$pageResultKey : 

本地化业务入参-分页唯一标识,非首页的请求必传,值为上一页返回结果中的page_result_key字段值

Type

$pageSize

$pageSize : 

页大小,默认20,1~100

Type

$platform

$platform : 

链接形式:1:PC,2:无线,默认:1

Type

$q

$q : 

商品筛选-查询词

Type

$relationId

$relationId : 

渠道关系ID,仅适用于渠道推广场景

Type

$sellerIds

$sellerIds : 

商家id,仅支持饿了么卡券商家ID,支持批量请求1-100以内,多个商家ID使用英文逗号分隔

Type

$sort

$sort : 

排序_des(降序),排序_asc(升序),销量(total_sales),淘客佣金比率(tk_rate), 累计推广量(tk_total_sales),总支出佣金(tk_total_commi),价格(price),匹配分(match)

Type

$specialId

$specialId : 

会员运营ID

Type

$startDsr

$startDsr : 

商品筛选(特定媒体支持)-店铺dsr评分。筛选大于等于当前设置的店铺dsr评分的商品0-50000之间

Type

$startKaTkRate

$startKaTkRate : 

商品筛选-KA媒体淘客佣金比率下限。如:1234表示12.34%

Type

$startPrice

$startPrice : 

商品筛选-折扣价范围下限。单位:元

Type

$startTkRate

$startTkRate : 

商品筛选-淘客佣金比率下限。如:1234表示12.34%

Type

$ucrowdId

$ucrowdId : 

人群ID,仅适用于物料评估场景material_id=41377

Type

$ucrowdRankItems

$ucrowdRankItems : 

物料评估-商品列表

Type

$apiParas

$apiParas : 

Type

Methods

setAdzoneId()

setAdzoneId(  $adzoneId) 

Parameters

$adzoneId

getAdzoneId()

getAdzoneId() 

setCat()

setCat(  $cat) 

Parameters

$cat

getCat()

getCat() 

setCityCode()

setCityCode(  $cityCode) 

Parameters

$cityCode

getCityCode()

getCityCode() 

setDeviceEncrypt()

setDeviceEncrypt(  $deviceEncrypt) 

Parameters

$deviceEncrypt

getDeviceEncrypt()

getDeviceEncrypt() 

setDeviceType()

setDeviceType(  $deviceType) 

Parameters

$deviceType

getDeviceType()

getDeviceType() 

setDeviceValue()

setDeviceValue(  $deviceValue) 

Parameters

$deviceValue

getDeviceValue()

getDeviceValue() 

setEndKaTkRate()

setEndKaTkRate(  $endKaTkRate) 

Parameters

$endKaTkRate

getEndKaTkRate()

getEndKaTkRate() 

setEndPrice()

setEndPrice(  $endPrice) 

Parameters

$endPrice

getEndPrice()

getEndPrice() 

setEndTkRate()

setEndTkRate(  $endTkRate) 

Parameters

$endTkRate

getEndTkRate()

getEndTkRate() 

setGetTopnRate()

setGetTopnRate(  $getTopnRate) 

Parameters

$getTopnRate

getGetTopnRate()

getGetTopnRate() 

setHasCoupon()

setHasCoupon(  $hasCoupon) 

Parameters

$hasCoupon

getHasCoupon()

getHasCoupon() 

setIncludeGoodRate()

setIncludeGoodRate(  $includeGoodRate) 

Parameters

$includeGoodRate

getIncludeGoodRate()

getIncludeGoodRate() 

setIncludePayRate30()

setIncludePayRate30(  $includePayRate30) 

Parameters

$includePayRate30

getIncludePayRate30()

getIncludePayRate30() 

setIncludeRfdRate()

setIncludeRfdRate(  $includeRfdRate) 

Parameters

$includeRfdRate

getIncludeRfdRate()

getIncludeRfdRate() 

setIp()

setIp(  $ip) 

Parameters

$ip

getIp()

getIp() 

setIsOverseas()

setIsOverseas(  $isOverseas) 

Parameters

$isOverseas

getIsOverseas()

getIsOverseas() 

setIsTmall()

setIsTmall(  $isTmall) 

Parameters

$isTmall

getIsTmall()

getIsTmall() 

setItemloc()

setItemloc(  $itemloc) 

Parameters

$itemloc

getItemloc()

getItemloc() 

setLatitude()

setLatitude(  $latitude) 

Parameters

$latitude

getLatitude()

getLatitude() 

setLockRateEndTime()

setLockRateEndTime(  $lockRateEndTime) 

Parameters

$lockRateEndTime

getLockRateEndTime()

getLockRateEndTime() 

setLockRateStartTime()

setLockRateStartTime(  $lockRateStartTime) 

Parameters

$lockRateStartTime

getLockRateStartTime()

getLockRateStartTime() 

setLongitude()

setLongitude(  $longitude) 

Parameters

$longitude

getLongitude()

getLongitude() 

setMaterialId()

setMaterialId(  $materialId) 

Parameters

$materialId

getMaterialId()

getMaterialId() 

setNeedFreeShipment()

setNeedFreeShipment(  $needFreeShipment) 

Parameters

$needFreeShipment

getNeedFreeShipment()

getNeedFreeShipment() 

setNeedPrepay()

setNeedPrepay(  $needPrepay) 

Parameters

$needPrepay

getNeedPrepay()

getNeedPrepay() 

setNpxLevel()

setNpxLevel(  $npxLevel) 

Parameters

$npxLevel

getNpxLevel()

getNpxLevel() 

setPageNo()

setPageNo(  $pageNo) 

Parameters

$pageNo

getPageNo()

getPageNo() 

setPageResultKey()

setPageResultKey(  $pageResultKey) 

Parameters

$pageResultKey

getPageResultKey()

getPageResultKey() 

setPageSize()

setPageSize(  $pageSize) 

Parameters

$pageSize

getPageSize()

getPageSize() 

setPlatform()

setPlatform(  $platform) 

Parameters

$platform

getPlatform()

getPlatform() 

setQ()

setQ(  $q) 

Parameters

$q

getQ()

getQ() 

setRelationId()

setRelationId(  $relationId) 

Parameters

$relationId

getRelationId()

getRelationId() 

setSellerIds()

setSellerIds(  $sellerIds) 

Parameters

$sellerIds

getSellerIds()

getSellerIds() 

setSort()

setSort(  $sort) 

Parameters

$sort

getSort()

getSort() 

setSpecialId()

setSpecialId(  $specialId) 

Parameters

$specialId

getSpecialId()

getSpecialId() 

setStartDsr()

setStartDsr(  $startDsr) 

Parameters

$startDsr

getStartDsr()

getStartDsr() 

setStartKaTkRate()

setStartKaTkRate(  $startKaTkRate) 

Parameters

$startKaTkRate

getStartKaTkRate()

getStartKaTkRate() 

setStartPrice()

setStartPrice(  $startPrice) 

Parameters

$startPrice

getStartPrice()

getStartPrice() 

setStartTkRate()

setStartTkRate(  $startTkRate) 

Parameters

$startTkRate

getStartTkRate()

getStartTkRate() 

setUcrowdId()

setUcrowdId(  $ucrowdId) 

Parameters

$ucrowdId

getUcrowdId()

getUcrowdId() 

setUcrowdRankItems()

setUcrowdRankItems(  $ucrowdRankItems) 

Parameters

$ucrowdRankItems

getUcrowdRankItems()

getUcrowdRankItems() 

getApiMethodName()

getApiMethodName() 

getApiParas()

getApiParas() 

check()

check() 

putOtherTextParam()

putOtherTextParam(  $key,   $value) 

Parameters

$key
$value