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

taobao.tbk.dg.vegas.activity.tlj.create (创建社群拉新礼金)

创建淘礼金

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
security_level Number 可选 0 必须传入0
use_start_time String 可选 2019-01-29 使用开始日期, 相对时间,无需填写, 以用户领取时间作为使用开始时间。绝对时间 ,格式 yyyy-MM-dd,例如,2019-01-29, 表示从2019-01-29 00:00:00 开始,格式 yyyy-MM-dd HH:mm:ss,例如,2019-01-29 20:00:10,表示从2019-01-2920:00:10 开始。 注意:开始日期必须晚于官方补贴开始生效时间
use_end_time_mode Number 可选 1 结束日期的模式,2:绝对时间
use_end_time String 可选 5 使用结束日期,如果是绝对时间,格式为 yyyy-MM-dd,例如,2019-01-29,表示到 2019-01-29 23:59:59结束,格式 yyyy-MM-dd HH:mm:ss,例如,2019-01-29 20:00:10, 表示从2019-01-29 20:00:10 开始。 注意:结束日期必须早于官方补贴生效结束时间
send_end_time Date 可选 2018-09-01 00:00:00 发放截止时间,截止日期必须早于官方补贴开始生效时间
send_start_time Date 必须 2018-09-01 00:00:00 发放开始时间,开始日期必须晚于官方补贴生效结束时间
per_face String 必须 10 单个淘礼金面额,支持两位小数,单位元
security_switch Boolean 必须 true 必须设置为true,默认开启安全
user_total_win_num_limit Number 必须 1 单用户累计中奖次数上限
name String 必须 淘礼金来啦 淘礼金名称,最大10个字符
total_num Number 必须 10 淘礼金总个数
item_id String 必须 12323 宝贝ID或营销ID
use_threshold String 可选 2 淘礼金使用门槛,实付款大于等于门槛面额时才可使用此淘礼金;门槛值不能小于淘礼金面额
award_img_template_id String 可选 1 淘礼金皮肤模版ID,默认传1
promotion_activity_id String 必须 2
  • 默认值:2
  • 活动id,默认传2,老用户由淘客全额出资补贴,新用户由官方出资补贴
    adzone_id Number 必须 1234567 妈妈广告位Id

    响应参数

    名称 类型 示例值 描述
    result Result result
    • model
    • RightsInstanceCreateResult
    • 134523^4351232
    • model
    • └ rights_id
    • String
    • asfasdfasd
    • 淘礼金Id
    • └ send_url
    • String
    • https://www.taobao.com
    • 淘礼金领取Url
    • └ vegas_code
    • String
    • asfasdfasd
    • 投放code【百川商品详情页业务专用】
    • └ available_fee
    • String
    • 20.23
    • 创建完成后资金账户可用资金,单位元,保留2位小数
    • └ item_today_num_left
    • Number
    • 10
    • 媒体针对此商品今日剩余可领取淘礼金数量
    • └ msg_code
    • String
    • 1
    • msgCode
    • └ msg_info
    • String
    • 1
    • msgInfo
    • └ success
    • Boolean
    • false
    • success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkDgVegasActivityTljCreateRequest req = new TbkDgVegasActivityTljCreateRequest();
    req.setSecurityLevel(0L);
    req.setUseStartTime("2019-01-29");
    req.setUseEndTimeMode(1L);
    req.setUseEndTime("5");
    req.setSendEndTime(StringUtils.parseDateTime("2018-09-01 00:00:00"));
    req.setSendStartTime(StringUtils.parseDateTime("2018-09-01 00:00:00"));
    req.setPerFace("10");
    req.setSecuritySwitch(true);
    req.setUserTotalWinNumLimit(1L);
    req.setName("淘礼金来啦");
    req.setTotalNum(10L);
    req.setItemId("12323");
    req.setUseThreshold("2");
    req.setAwardImgTemplateId("1");
    req.setPromotionActivityId("2");
    req.setAdzoneId(1234567L);
    TbkDgVegasActivityTljCreateResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_dg_vegas_activity_tlj_create_response>
        <result>
            <model>
                <rights_id>asfasdfasd</rights_id>
                <send_url>https://www.taobao.com</send_url>
                <vegas_code>asfasdfasd</vegas_code>
                <available_fee>20.23</available_fee>
                <item_today_num_left>10</item_today_num_left>
            </model>
            <msg_code>1</msg_code>
            <msg_info>1</msg_info>
            <success>false</success>
        </result>
    </tbk_dg_vegas_activity_tlj_create_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

    返回
    顶部