文档中心 > API类目 > 淘宝客API

taobao.tbk.dg.material.recommend (淘宝客-推广者-物料精选升级版)

推广者使用,支持入参对应的“推广位”和官方提供的“物料id”,获取指定物料信息和推广链接。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
page_size Number 可选 20
  • 默认值:20
  • 页大小,默认20,1~100
    page_no Number 可选 1
  • 默认值:1
  • 第几页,默认:1
    material_id Number 必须 123 官方提供的物料Id;可以通过taobao.tbk.optimus.tou.material.ids.get接口获取公开的物料id列表或查看物料id汇总贴:https://market.m.taobao.com/app/qn/toutiao-new/index-pc.html#/detail/10628875?_k=gpov9a
    adzone_id Number 必须 123 推广位id,mm_xxx_xxx_12345678三段式的最后一段数字(登录pub.alimama.com推广管理-推广位管理中查询)
    relation_id Number 可选 123456 渠道关系ID,仅适用于渠道推广场景
    device_type String 可选 IMEI 智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID;使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin
    device_encrypt String 可选 MD5 智能匹配-设备号加密类型:MD5;使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin
    device_value String 可选 xxx 智能匹配-设备号加密后的值(MD5加密需32位小写);使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin
    favorites_id String 可选 123445 选品库收藏夹id,获取收藏夹id参考文档:https://mos.m.taobao.com/union/page_20230109_175050_176?spm=a219t._portal_v2_pages_promo_goods_index_htm.0.0.7c2a75a5H2ER3N
    promotion_type String 可选 2 1-自购省,2-推广赚(代理模式专属ID,代理模式必填,非代理模式不用填写该字段)
    special_id String 可选 2323 会员运营ID
    item_id String 可选 qeqscd1231-uqwenqe 淘宝客新商品ID;用于相似商品推荐(注意:使用相似商品推荐material_id=13256必传,并请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin);另关于《淘宝客新商品ID升级》参考白皮书:https://www.yuque.com/taobaolianmengguanfangxiaoer/zmig94/tfyt0pahmlpzu2ud

    响应参数

    名称 类型 示例值 描述
    result_list MapData [] resultList
    • └ item_id
    • String
    • qeqscd1231-uqwenqe
    • 商品信息-淘宝客新商品id;使用说明参考《淘宝客新商品ID升级》白皮书:https://www.yuque.com/taobaolianmengguanfangxiaoer/zmig94/tfyt0pahmlpzu2ud
    • item_basic_info
    • BasicMapData
    • 商品基础信息
    • └ title
    • String
    • 复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款
    • 商品信息-商品标题
    • └ short_title
    • String
    • 九分裤显瘦高腰韩版
    • 商品信息-商品短标题
    • └ pict_url
    • String
    • //img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
    • 商品信息-商品主图
    • └ white_image
    • String
    • https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
    • 商品信息-商品白底图
    • └ level_one_category_id
    • Number
    • 1
    • 商品信息-一级类目ID
    • └ level_one_category_name
    • String
    • 美妆
    • 商品信息-一级类目名称
    • └ category_id
    • Number
    • 162201
    • 商品信息-叶子类目id
    • └ category_name
    • String
    • 牛仔裤
    • 商品信息-叶子类目名称
    • └ seller_id
    • Number
    • 123
    • 店铺信息-卖家id
    • └ user_type
    • Number
    • 1
    • 店铺信息-卖家类型,0表示淘宝,1表示天猫,3表示特价版
    • └ shop_title
    • String
    • 魔黛娅内衣旗舰店
    • 店铺信息-店铺名称
    • └ volume
    • Number
    • 30
    • 商品信息-30天销量;数据统计截止昨日非实时更新
    • └ sub_title
    • String
    • 吉品鲍鱼 关西参
    • 商品信息-商品子标题
    • └ brand_name
    • String
    • 淘宝心选
    • 商品信息-品牌名称
    • └ annual_vol
    • String
    • 1万+
    • 年销量
    • price_promotion_info
    • PromotionInfoMapData
    • 价格促销信息
    • └ reserve_price
    • String
    • 102.00
    • 商品信息-一口价通常显示为划线价
    • └ zk_final_price
    • String
    • 79.9
    • 促销信息-销售价格,无促销时等于一口价,有促销时为促销价。若属于预售商品,付定金时间内,在线售卖价=预售价
    • └ final_promotion_price
    • String
    • 69.9
    • 促销信息-预估到手价(元)。若属于预售商品,付定金时间内,预估到手价价=定金+尾款的预估到手价
    • final_promotion_path_list
    • FinalPromotionPathMapData []
    • 到手价优惠路径列表
    • └ promotion_title
    • String
    • 商品券
    • 优惠名称,如“商品券”、“跨店满减”、“单品直降”等
    • └ promotion_desc
    • String
    • 满7999减1300
    • 优惠利益点文案,如“1件7.92折”、“每200减20”等
    • └ promotion_fee
    • String
    • 1300.00
    • 实际优惠金额(元)
    • └ promotion_start_time
    • String
    • 1661184000000
    • 优惠开始时间
    • └ promotion_end_time
    • String
    • 1661788799000
    • 优惠结束时间
    • └ promotion_id
    • String
    • xx
    • 优惠ID
    • └ future_activity_promotion_price
    • String
    • 99.5
    • 预热预估到手价(元)
    • future_activity_promotion_path_list
    • FutureActivityPromotionPathMapData []
    • 预热到手价优惠路径列表
    • └ promotion_title
    • String
    • 商品券
    • 预热优惠名称,如“商品券”、“跨店满减”、“单品直降”等
    • └ promotion_desc
    • String
    • 满7999减1300
    • 预热优惠利益点文案,如“1件7.92折”、“每200减20”等
    • └ promotion_fee
    • String
    • 1300.00
    • 预热实际优惠金额(元)
    • └ promotion_start_time
    • String
    • 1661184000000
    • 优惠开始时间
    • └ promotion_end_time
    • String
    • 1661788799000
    • 优惠结束时间
    • promotion_tag_list
    • PromotionTagMapData []
    • 标签信息列表
    • └ tag_name
    • String
    • 88VIP
    • 标签名称,如“88VIP”、“花呗免息”、“猫超买返”、“是否包邮”
    • └ predict_rounding_up_price
    • String
    • 56.1
    • 促销信息-预估凑单价(元)。预估凑单叠加优惠后的商品单价
    • └ predict_rounding_up_price_desc
    • String
    • 需买1件
    • 促销信息-凑单价说明,描述凑单价的实现说明。如 “可凑单”或“需买X件”
    • more_promotion_list
    • MorePromotionMapData []
    • 更多活动优惠
    • └ promotion_title
    • String
    • 满件折
    • 预热优惠名称,如“商品券”、“跨店满减”、“单品直降”等
    • └ promotion_desc
    • String
    • 2件9折
    • 预热优惠利益点文案,如“1件7.92折”、“每200减20”等
    • └ promotion_start_time
    • String
    • 1661222400000
    • 优惠开始时间
    • └ promotion_end_time
    • String
    • 1662393600000
    • 优惠结束时间
    • └ promotion_id
    • String
    • xx
    • 优惠ID
    • predict_rounding_up_path_list
    • PredictRoundingUpPathMapData []
    • 预估凑单优惠路径
    • └ promotion_title
    • String
    • 店铺优惠
    • 优惠名称,如“商品券”、“跨店满减”、“单品直降”等
    • └ promotion_desc
    • String
    • 再买1件,可参与2件5折
    • 优惠利益点文案,如“2件5折”、“每200减20”等
    • publish_info
    • PublishInfo
    • 淘客推广信息
    • └ income_rate
    • String
    • 5.50
    • 商品信息-收入比率(%);商品佣金比率+补贴比率
    • └ click_url
    • String
    • //item.taobao.com/item.htm?id=556633720749&scm=1007.16190.92234.0&pvid=41362290-fa0b-4252-b172-6afc9c00e2c8&app_pvid=0ab0fac715095507006577956e
    • 链接-宝贝推广链接
    • └ coupon_share_url
    • String
    • //uland.taobao.com/coupon/edetail?e=pR6YtnFKK%2B8GQASttHIRqcEWOmlidB03Pf45HLyCqA8dRAklSM5tEQ36hBQToU3M3MmLjFwLsqgZxcV7BPtHQDd2Naqom0e0&mt=1&app_pvid=0ab0fac715095507006577956e&ptl=app_pvid:0ab0fac715095507006577956e;tpp_pvid:41362290-fa0b-4252-b172-6afc9c00e2c8
    • 链接-宝贝+券二合一页面链接
    • sp_campaign_list
    • SpCampaign []
    • 定向计划集合-仅支持联系商务或运营小二申请定向计划合集字段权限
    • └ sp_cid
    • String
    • 123
    • 定向计划活动ID
    • └ sp_name
    • String
    • 定向计划活动1
    • 定向计划名称
    • └ sp_rate
    • String
    • 1550表示15.5%
    • 定向佣金率
    • └ sp_lock_status
    • String
    • 0
    • 定向是否锁佣,0=不锁佣 1=锁佣
    • └ sp_apply_link
    • String
    • http://pub.alimama.com/portal/promo/shop/campaign/detail.htm?mode=info&campaignId=1000492470&creatorId=98836808&breadcrumb=false
    • 定向计划申请链接
    • └ sp_status
    • String
    • 1
    • 定向计划是否可用 1-可用 0-不可用
    • └ future_activity_commission_rate
    • String
    • 1550表示15.5%
    • 预热活动到手价对应的佣金比率
    • └ future_activity_time
    • String
    • 1665504000000
    • 预热价活动开始时间
    • income_info
    • IncomeInfo
    • 商品佣金信息
    • └ commission_rate
    • String
    • 55
    • 商品佣金比率
    • └ commission_amount
    • String
    • 12
    • 商品佣金金额
    • └ subsidy_rate
    • String
    • 11
    • 补贴比率
    • └ subsidy_amount
    • String
    • 4
    • 补贴金额
    • └ subsidy_upper_limit
    • String
    • 10
    • 补贴上限;仅在单笔订单命中补贴上限时返回结果否则出参为空
    • └ cpa_reward_type
    • String
    • 0 1 2
    • 额外奖励活动类型,如果一个商品有多个奖励类型,返回结果使用空格分割,0=预售单单奖励,1=618超级U选单单补
    • └ cpa_reward_amount
    • String
    • 1.11 2.22 3.21
    • 额外奖励活动金额,活动奖励金额的类型与cpa_reward_type字段对应,如果一个商品有多个奖励类型,返回结果使用空格分割
    • tmall_rank_info
    • TmallRankInfo
    • 天猫榜单信息
    • └ tmall_rank_text
    • String
    • 白茶热销榜·第5名
    • 榜单排行描述
    • └ tmall_rank_url
    • String
    • https://pages.tmall.com/wow/a/act/tmall/dailygroup/16220/16661/wupr?wh_pid=daily-459438&disableNav=YES
    • 榜单url
    • presale_info
    • PresaleInfo
    • 预售信息
    • └ presale_start_time
    • Number
    • 1567440000000
    • 预售商品-付定金开始时间(毫秒)
    • └ presale_end_time
    • Number
    • 1567440000000
    • 预售商品-付定金结束时间(毫秒)
    • └ presale_tail_start_time
    • Number
    • 1567440000000
    • 预售商品-付尾款开始时间(毫秒)
    • └ presale_tail_end_time
    • Number
    • 1567440000000
    • 预售商品-付尾款结束时间(毫秒)
    • └ presale_deposit
    • String
    • 100
    • 预售商品-定金(元)
    • └ presale_discount_fee_text
    • String
    • 付定金立减5元
    • 预售商品-优惠信息
    • favorites_info
    • FavoritesInfo
    • 选品库信息
    • └ total_count
    • Number
    • 100
    • 选品库收藏夹总数量
    • favorites_list
    • FavoritesDetail []
    • 选品库收藏夹详细信息
    • └ favorites_id
    • Number
    • 12334
    • 选品库收藏夹id
    • └ favorites_title
    • String
    • 测试选品库
    • 选品库收藏夹标题
    • topn_info
    • TopNInfoDTO
    • 前N件佣金信息-前N件佣金生效或预热时透出以下字段
    • └ topn_quantity
    • Number
    • 3000
    • 前N件剩余库存
    • └ topn_total_count
    • Number
    • 3000
    • 前N件初始总库存
    • └ topn_start_time
    • String
    • 1937297392332
    • 前N件佣金开始时间
    • └ topn_end_time
    • String
    • 1937297392332
    • 前N件佣金结束时间
    • └ topn_rate
    • String
    • 30
    • 前N件佣金率
    • scope_info
    • ScopeInfo
    • 商品库范围信息
    • └ superior_brand
    • String
    • 1
    • 是否品牌精选,0不是,1是
    is_default String false 推荐信息-是否抄底
    total_count Number 100 商品总数-该选品库收藏夹id及官方物料id对应的商品数量
    uvid_msg String 123 uvid结果信息,传入但未使用uvid时会返回原因

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkDgMaterialRecommendRequest req = new TbkDgMaterialRecommendRequest();
    req.setPageSize(20L);
    req.setPageNo(1L);
    req.setMaterialId(123L);
    req.setAdzoneId(123L);
    req.setRelationId(123456L);
    req.setDeviceType("IMEI");
    req.setDeviceEncrypt("MD5");
    req.setDeviceValue("xxx");
    req.setFavoritesId("123445");
    req.setPromotionType("2");
    req.setSpecialId("2323");
    req.setItemId("qeqscd1231-uqwenqe");
    TbkDgMaterialRecommendResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_dg_material_recommend_response>
        <result_list>
            <map_data>
                <item_id>qeqscd1231-uqwenqe</item_id>
                <item_basic_info>
                    <title>复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款</title>
                    <short_title>九分裤显瘦高腰韩版</short_title>
                    <pict_url>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</pict_url>
                    <white_image>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</white_image>
                    <level_one_category_id>1</level_one_category_id>
                    <level_one_category_name>美妆</level_one_category_name>
                    <category_id>162201</category_id>
                    <category_name>牛仔裤</category_name>
                    <seller_id>123</seller_id>
                    <user_type>1</user_type>
                    <shop_title>魔黛娅内衣旗舰店</shop_title>
                    <volume>30</volume>
                    <sub_title>吉品鲍鱼 关西参</sub_title>
                    <brand_name>淘宝心选</brand_name>
                    <annual_vol>1万+</annual_vol>
                </item_basic_info>
                <price_promotion_info>
                    <reserve_price>102.00</reserve_price>
                    <zk_final_price>79.9</zk_final_price>
                    <final_promotion_price>69.9</final_promotion_price>
                    <final_promotion_path_list>
                        <final_promotion_path_map_data>
                            <promotion_title>商品券</promotion_title>
                            <promotion_desc>满7999减1300</promotion_desc>
                            <promotion_fee>1300.00</promotion_fee>
                            <promotion_start_time>1661184000000</promotion_start_time>
                            <promotion_end_time>1661788799000</promotion_end_time>
                            <promotion_id>xx</promotion_id>
                        </final_promotion_path_map_data>
                    </final_promotion_path_list>
                    <future_activity_promotion_price>99.5</future_activity_promotion_price>
                    <future_activity_promotion_path_list>
                        <future_activity_promotion_path_map_data>
                            <promotion_title>商品券</promotion_title>
                            <promotion_desc>满7999减1300</promotion_desc>
                            <promotion_fee>1300.00</promotion_fee>
                            <promotion_start_time>1661184000000</promotion_start_time>
                            <promotion_end_time>1661788799000</promotion_end_time>
                        </future_activity_promotion_path_map_data>
                    </future_activity_promotion_path_list>
                    <promotion_tag_list>
                        <promotion_tag_map_data>
                            <tag_name>88VIP</tag_name>
                        </promotion_tag_map_data>
                    </promotion_tag_list>
                    <predict_rounding_up_price>56.1</predict_rounding_up_price>
                    <predict_rounding_up_price_desc>需买1件</predict_rounding_up_price_desc>
                    <more_promotion_list>
                        <more_promotion_map_data>
                            <promotion_title>满件折</promotion_title>
                            <promotion_desc>2件9折</promotion_desc>
                            <promotion_start_time>1661222400000</promotion_start_time>
                            <promotion_end_time>1662393600000</promotion_end_time>
                            <promotion_id>xx</promotion_id>
                        </more_promotion_map_data>
                    </more_promotion_list>
                    <predict_rounding_up_path_list>
                        <predict_rounding_up_path_map_data>
                            <promotion_title>店铺优惠</promotion_title>
                            <promotion_desc>再买1件,可参与2件5折</promotion_desc>
                        </predict_rounding_up_path_map_data>
                    </predict_rounding_up_path_list>
                </price_promotion_info>
                <publish_info>
                    <income_rate>5.50</income_rate>
                    <click_url>//item.taobao.com/item.htm?id=556633720749&amp;scm=1007.16190.92234.0&amp;pvid=41362290-fa0b-4252-b172-6afc9c00e2c8&amp;app_pvid=0ab0fac715095507006577956e</click_url>
                    <coupon_share_url>//uland.taobao.com/coupon/edetail?e=pR6YtnFKK%2B8GQASttHIRqcEWOmlidB03Pf45HLyCqA8dRAklSM5tEQ36hBQToU3M3MmLjFwLsqgZxcV7BPtHQDd2Naqom0e0&amp;mt=1&amp;app_pvid=0ab0fac715095507006577956e&amp;ptl=app_pvid:0ab0fac715095507006577956e;tpp_pvid:41362290-fa0b-4252-b172-6afc9c00e2c8</coupon_share_url>
                    <sp_campaign_list>
                        <sp_campaign>
                            <sp_cid>123</sp_cid>
                            <sp_name>定向计划活动1</sp_name>
                            <sp_rate>1550表示15.5%</sp_rate>
                            <sp_lock_status>0</sp_lock_status>
                            <sp_apply_link>http://pub.alimama.com/portal/promo/shop/campaign/detail.htm?mode=info&amp;campaignId=1000492470&amp;creatorId=98836808&amp;breadcrumb=false</sp_apply_link>
                            <sp_status>1</sp_status>
                        </sp_campaign>
                    </sp_campaign_list>
                    <future_activity_commission_rate>1550表示15.5%</future_activity_commission_rate>
                    <future_activity_time>1665504000000</future_activity_time>
                    <income_info>
                        <commission_rate>55</commission_rate>
                        <commission_amount>12</commission_amount>
                        <subsidy_rate>11</subsidy_rate>
                        <subsidy_amount>4</subsidy_amount>
                        <subsidy_upper_limit>10</subsidy_upper_limit>
                    </income_info>
                    <cpa_reward_type>0 1 2</cpa_reward_type>
                    <cpa_reward_amount>1.11 2.22 3.21</cpa_reward_amount>
                </publish_info>
                <tmall_rank_info>
                    <tmall_rank_text>白茶热销榜·第5名</tmall_rank_text>
                    <tmall_rank_url>https://pages.tmall.com/wow/a/act/tmall/dailygroup/16220/16661/wupr?wh_pid=daily-459438&amp;disableNav=YES</tmall_rank_url>
                </tmall_rank_info>
                <presale_info>
                    <presale_start_time>1567440000000</presale_start_time>
                    <presale_end_time>1567440000000</presale_end_time>
                    <presale_tail_start_time>1567440000000</presale_tail_start_time>
                    <presale_tail_end_time>1567440000000</presale_tail_end_time>
                    <presale_deposit>100</presale_deposit>
                    <presale_discount_fee_text>付定金立减5元</presale_discount_fee_text>
                </presale_info>
                <favorites_info>
                    <total_count>100</total_count>
                    <favorites_list>
                        <favorites_detail>
                            <favorites_id>12334</favorites_id>
                            <favorites_title>测试选品库</favorites_title>
                        </favorites_detail>
                    </favorites_list>
                </favorites_info>
                <topn_info>
                    <topn_quantity>3000</topn_quantity>
                    <topn_total_count>3000</topn_total_count>
                    <topn_start_time>1937297392332</topn_start_time>
                    <topn_end_time>1937297392332</topn_end_time>
                    <topn_rate>30</topn_rate>
                </topn_info>
                <scope_info>
                    <superior_brand>1</superior_brand>
                </scope_info>
            </map_data>
        </result_list>
        <is_default>false</is_default>
        <total_count>100</total_count>
        <uvid_msg>123</uvid_msg>
    </tbk_dg_material_recommend_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部