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

taobao.tbk.rta.consumer.match (淘宝客-推广者-定向活动目标发布)

淘客计划向用户推送某个定向活动时,调用该接口判断用户是否符合活动目标(淘客接入前需签署协议 https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin)

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
adzone_id Number 必须 33 mm_xxx_xxx_xxx的第3段数字
offer_list OfferList [] 可选
  • 最大列表长度:100
  • 活动列表
    • └ offer_id
    • String
    • 可选
    • 123
    • 活动id
    • └ tlj_url
    • String
    • 可选
    • https://www.taobao.com
    • 淘礼金领取URL,不支持使用短链接
    • └ item_id
    • String
    • 可选
    • 1
    • 商品id
    special_id String 可选 1 消费者对应的会员ID(会员ID或设备信息同时填时,优先使用会员ID)
    device_value String 可选 ssss 设备信息,加密后的值(IMEI,IDFA,OAID,MOBILE需要加密),需用MD5加密,32位小写
    device_type String 可选 OAID 设备信息,入参类型(该模式下返回的结果为模糊匹配结果,和实际情况可能存在误差):IMEI, 或者IDFA, 或者OAID, 或者MOBILE, 或者ALIPAY_ID
    strategy_id_list String 可选 123456 策略ID,与活动列表二选一传入

    响应参数

    名称 类型 示例值 描述
    data Data 返回结果
    • result_list
    • Resultlist []
    • 返回结果列表
    • └ offer_id
    • String
    • 123
    • 活动id
    • └ status
    • String
    • 1
    • 活动状态:1-符合活动要求,2-淘客无活动权限,3-用户不匹配活动,4-系统异常,5-活动不存在
    • └ click_url
    • String
    • https://www.taobao.com
    • 推广链接
    • └ wx_miniprogram_path
    • String
    • https://www.taobao.com
    • 微信小程序路径
    • └ wx_qrcode_url
    • String
    • https://www.taobao.com
    • 微信小程序码
    • strategy_result_list
    • StrategyResultList []
    • 策略ID的匹配结果,仅在入参strategy_id_list字段非空时返回
    • └ strategy_id
    • String
    • 123
    • 策略ID
    • └ status
    • String
    • 1
    • 状态:1-符合活动要求 ,3-用户不匹配活动,4-系统异常,6-策略ID不存在,7-策略ID无效

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkRtaConsumerMatchRequest req = new TbkRtaConsumerMatchRequest();
    req.setAdzoneId(33L);
    List<TbkRtaConsumerMatchRequest.OfferList> list2 = new ArrayList<TbkRtaConsumerMatchRequest.OfferList>();
    TbkRtaConsumerMatchRequest.OfferList obj3 = new TbkRtaConsumerMatchRequest.OfferList();
    list2.add(obj3);
    obj3.setOfferId("123");
    obj3.setTljUrl("https://www.taobao.com");
    obj3.setItemId("1");
    req.setOfferList(list2);
    req.setSpecialId("1");
    req.setDeviceValue("ssss");
    req.setDeviceType("OAID");
    req.setStrategyIdList("123456");
    TbkRtaConsumerMatchResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_rta_consumer_match_response>
        <data>
            <result_list>
                <resultlist>
                    <offer_id>123</offer_id>
                    <status>1</status>
                    <click_url>https://www.taobao.com</click_url>
                    <wx_miniprogram_path>https://www.taobao.com</wx_miniprogram_path>
                    <wx_qrcode_url>https://www.taobao.com</wx_qrcode_url>
                </resultlist>
            </result_list>
            <strategy_result_list>
                <strategy_result_list>
                    <strategy_id>123</strategy_id>
                    <status>1</status>
                </strategy_result_list>
            </strategy_result_list>
        </data>
    </tbk_rta_consumer_match_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>

    错误码解释

    错误码 错误描述 解决方案
    1601 错误的specialId 确保specialId正确,且归属关系正确
    1701 活动查询异常 建议稍后重试
    1702 无效的offerId 建议传入有效的offerId
    2 adzoneId不正确 更换正确的adzoneId
    4 adzoneId不存在 更换正确的adzoneId
    1803 错误的设备信息参数 修改设备相关参数
    1802 错误的设备信息参数device_value 更换请求参数

    API工具

    如何获得此API

    FAQ

    返回
    顶部