注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 手淘用户增长

taobao.usergrowth.post.gateway (驿站用增红包)

驿站用增红包

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id String 必须 userId userId
open_id String 必须 openId openId
scene_code String 必须 场景code(用增分配) 场景code(用增分配)
module_code String 可选 模块Code(用增分配) 模块Code(用增分配)
station_code String 必须 驿站code 驿站code
ext_params Json 可选 {} 扩展参数
from String 必须 index 首页还是浮层(index=首页,drawerWindow=弹层)
city_code String 必须 城市code 城市code-二级地址
terminal_info TerminalInfo 可选 设备信息
  • └ umid
  • String
  • 可选
  • umid
  • 设备umid
area_code String 必须 三级地址 三级地址
shopping_guide Boolean 可选 true 站长是否有导购能力

响应参数

名称 类型 示例值 描述
result TopResult result
  • └ success
  • Boolean
  • true
  • 是否执行成功
  • └ error_code
  • String
  • 200
  • 错误码
  • └ error_msg
  • String
  • 成功
  • 错误信息
  • data
  • CainiaoGatewayResponse
  • data
  • default_banners
  • BannerModelDTO []
  • test
  • 兜底红包Banner信息
  • └ img_url
  • String
  • 图片url
  • 图片url
  • └ jump_url
  • String
  • 跳转url
  • 跳转url
  • red_packet
  • RedPacketVO
  • 红包信息
  • win_record_list
  • MarqueeWinRecordDTO []
  • 中奖记录,可降级
  • └ user_nick
  • String
  • 用*名
  • 用户昵称(脱敏)
  • └ feature
  • String
  • {"displayAmount":"5","amount":"500"}
  • 金额信息
  • red_packet_list
  • RedPacketDetailVO []
  • 红包列表
  • └ show_amount
  • String
  • 5
  • 金额
  • └ display_start_fee
  • String
  • 5.01
  • 门槛(空为无门槛)
  • └ status
  • Number
  • 0
  • 状态 0 待解锁 1 待使用(显示倒计时) 2 已使用 3 已过期
  • └ need_order_cnt
  • Number
  • 1
  • 订单数要求
  • └ remain_time
  • Number
  • 100000
  • 剩余时间(毫秒)
  • └ effective_end_timestamp
  • Number
  • 100000
  • 有效期结束时间(毫秒)
  • └ need_pop
  • Boolean
  • false
  • 是否需要pop(废弃)
  • item_recommend
  • CnItemResp
  • 商品信息
  • module_item_list
  • ModuleItemResp []
  • 模块商品信息
  • └ supply_id
  • Number
  • 1
  • 供给id
  • └ module_code
  • String
  • hotRecommend
  • 模块code
  • item_list
  • CnItemVO []
  • 商品具体信息
  • └ item_id
  • String
  • 1
  • 商品id
  • └ item_title
  • String
  • 标题
  • 商品标题
  • └ item_price
  • String
  • 5.0
  • 商品价格
  • └ item_img
  • String
  • xxxx.jpg
  • 商品图片
  • └ month_sold_num
  • String
  • 5000+
  • 月销量
  • └ total_sold_num
  • String
  • 5000+
  • 总销量
  • └ sku_panel_url
  • String
  • //sku.taobao.com
  • 下单面板
  • └ item_tags
  • String
  • [{"tagValue":"包邮","tagType":"WIRE_FRAME"}]
  • 标签
  • └ price_diff
  • String
  • 7.9
  • 直降价格
  • └ track_info
  • String
  • xxxx
  • 算法埋点信息
  • └ item_type
  • String
  • auction
  • 商品类型
  • └ item_url
  • String
  • //item.taobao.com
  • 商品链接
  • └ item_reserve_price
  • String
  • 5.0
  • 商品原价
  • └ quantity_num
  • Number
  • 5
  • 库存
  • └ extra_info
  • String
  • {}
  • 扩展信息
  • └ extra
  • String
  • {"pvuuid":"1"}
  • 扩展信息
  • └ shopping_guide
  • Boolean
  • true
  • 是否有导购能力
  • └ title
  • String
  • 标题
  • 标题
  • └ need_pop
  • Boolean
  • true
  • 是否需要弹窗
  • └ extra_info
  • String
  • {}
  • 扩展信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UsergrowthPostGatewayRequest req = new UsergrowthPostGatewayRequest();
req.setUserId("userId");
req.setOpenId("openId");
req.setSceneCode("场景code(用增分配)");
req.setModuleCode("模块Code(用增分配)");
req.setStationCode("驿站code");
req.setExtParamsString("{}");
req.setFrom("index");
req.setCityCode("城市code");
UsergrowthPostGatewayRequest.TerminalInfo obj1 = new UsergrowthPostGatewayRequest.TerminalInfo();
obj1.setUmid("umid");
req.setTerminalInfo(obj1);
req.setAreaCode("三级地址");
req.setShoppingGuide(true);
UsergrowthPostGatewayResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<usergrowth_post_gateway_response>
    <result>
        <success>true</success>
        <error_code>200</error_code>
        <error_msg>成功</error_msg>
        <data>
            <default_banners>
                <banner_model_d_t_o>
                    <img_url>图片url</img_url>
                    <jump_url>跳转url</jump_url>
                </banner_model_d_t_o>
            </default_banners>
            <red_packet>
                <win_record_list>
                    <marquee_win_record_d_t_o>
                        <user_nick>用*名</user_nick>
                        <feature>{&quot;displayAmount&quot;:&quot;5&quot;,&quot;amount&quot;:&quot;500&quot;}</feature>
                    </marquee_win_record_d_t_o>
                </win_record_list>
                <red_packet_list>
                    <red_packet_detail_v_o>
                        <show_amount>5</show_amount>
                        <display_start_fee>5.01</display_start_fee>
                        <status>0</status>
                        <need_order_cnt>1</need_order_cnt>
                        <remain_time>100000</remain_time>
                        <effective_end_timestamp>100000</effective_end_timestamp>
                        <need_pop>false</need_pop>
                    </red_packet_detail_v_o>
                </red_packet_list>
            </red_packet>
            <item_recommend>
                <module_item_list>
                    <module_item_resp>
                        <supply_id>1</supply_id>
                        <module_code>hotRecommend</module_code>
                        <item_list>
                            <cn_item_v_o>
                                <item_id>1</item_id>
                                <item_title>标题</item_title>
                                <item_price>5.0</item_price>
                                <item_img>xxxx.jpg</item_img>
                                <month_sold_num>5000+</month_sold_num>
                                <total_sold_num>5000+</total_sold_num>
                                <sku_panel_url>//sku.taobao.com</sku_panel_url>
                                <item_tags>[{&quot;tagValue&quot;:&quot;包邮&quot;,&quot;tagType&quot;:&quot;WIRE_FRAME&quot;}]</item_tags>
                                <price_diff>7.9</price_diff>
                                <track_info>xxxx</track_info>
                                <item_type>auction</item_type>
                                <item_url>//item.taobao.com</item_url>
                                <item_reserve_price>5.0</item_reserve_price>
                                <quantity_num>5</quantity_num>
                                <extra_info>{}</extra_info>
                            </cn_item_v_o>
                        </item_list>
                        <extra>{&quot;pvuuid&quot;:&quot;1&quot;}</extra>
                    </module_item_resp>
                </module_item_list>
            </item_recommend>
            <shopping_guide>true</shopping_guide>
            <title>标题</title>
            <need_pop>true</need_pop>
            <extra_info>{}</extra_info>
        </data>
    </result>
</usergrowth_post_gateway_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

返回
顶部