alibaba.latour.strategy.show (阿里巴巴权益投放接口)

阿里巴巴权益平台权益投放接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
with_test_benefit Boolean 可选 true 带出测试权益
channel String 必须 xxx 渠道
page_size Number 可选 10
  • 默认值:10
  • 每页权益数
    transformed_user_type String 可选 uic 要转换的账户类型
    need_identify_risk Boolean 可选 true
  • 默认值:false
  • 是否需要调用安全校验服务
    user_nick String 可选 xxx 用户昵称,除非有特殊申请,默认不允许使用该参数,请通过用户授权token传递用户信息
    skip_with_had_win Boolean 可选 true
  • 默认值:true
  • 不带出hadWin状态
    filter_empty_inventory Boolean 可选 true
  • 默认值:false
  • 过滤无库存权益
    user_id String 可选 xxx 用户id,除非有特殊申请,默认不允许使用该参数,请通过用户授权token传递用户信息
    strategy_code String 必须 xxxxx 投放计划code
    user_type String 可选 weibo 当面账户类型
    current_page Number 可选 1
  • 默认值:1
  • 当面分页
    filter_crowd Boolean 可选 true
  • 默认值:true
  • 过滤人群
    openid String 可选 xxxx openid
    with_strategy_instance Boolean 可选 false
  • 默认值:false
  • 是否需要投放计划维度的权益核销实例
    with_benefit_instance Boolean 可选 false
  • 默认值:false
  • 是否需要权益维度的权益核销实例

    响应参数

    名称 类型 示例值 描述
    result Result {} 返回结果
    • data
    • StrategyShowResultDto
    • 返回结果
    • └ extra_data
    • String
    • 扩展参数
    • └ has_next_page
    • Boolean
    • false
    • 是否有下一页
    • show_strategy
    • ShowStrategyDto
    • 投放计划
    • └ mode
    • String
    • DRAW
    • 投放模式
    • └ code
    • String
    • xxx
    • 投放计划code
    • └ all_rule_passed
    • Boolean
    • true
    • 是否投放计划所有规则通过
    • └ asac
    • String
    • xxx
    • 投放计划安全码
    • └ algorithm_failover
    • Boolean
    • false
    • 算法容灾结果
    • show_rules
    • ShowRuleDto []
    • 投放计划规则
    • └ feature
    • String
    • xxx
    • 规则扩展信息
    • └ passed
    • Boolean
    • false
    • 规则是否通过
    • └ type
    • String
    • xxx
    • 规则类型
    • show_benefit_instances
    • ShowBenefitInstanceDTO []
    • 投放计划维度核销数据
    • └ benefit_code
    • String
    • xxxx
    • 权益code
    • └ benefit_type
    • String
    • xxx
    • 权益类型
    • └ record_id
    • Number
    • 123456
    • 中奖记录ID
    • └ current_page
    • Number
    • 1
    • 当前页
    • show_benefits
    • ShowBenefitDto []
    • 权益列表
    • └ code
    • String
    • xxxxx
    • 权益code
    • └ type_desc
    • String
    • 现金红包
    • 权益类型
    • └ display_amount_unit
    • String
    • 权益展示面额单位
    • └ end_date
    • Date
    • 1593517953000
    • 权益发放结束时间
    • └ title
    • String
    • 签到红包
    • 权益标题
    • └ type
    • String
    • fpRedEnvelope
    • 权益类型
    • └ feature
    • String
    • xxx
    • 权益扩展信息
    • └ can_win
    • Boolean
    • true
    • 权益是否可领
    • └ interval_time_unit
    • String
    • DAYS
    • 相对使用时间类型
    • └ display_start_fee
    • String
    • 0.17
    • 展示门槛
    • └ send_mode
    • String
    • dynamicValue
    • 权益发放类型
    • └ send_life_cycle_state
    • String
    • running
    • 权益生命周期
    • └ amount
    • Number
    • 16
    • 权益面额
    • └ test
    • Boolean
    • false
    • 是否测试权益
    • └ had_win
    • Boolean
    • true
    • 是否已领
    • show_rules
    • ShowRuleDto []
    • 权益规则列表
    • └ passed
    • Boolean
    • true
    • 规则是否通过
    • └ type
    • String
    • CROWD_LIMIT
    • 规则类型
    • └ feature
    • String
    • xxx
    • 规则扩展字段
    • └ amount_unit
    • String
    • 面额单位
    • └ has_inventory
    • Boolean
    • true
    • 是否有库存
    • └ display_amount
    • String
    • 0.16
    • 展示面额
    • └ effective_time_mode
    • String
    • RELATIVE_NATURAL
    • 使用时间类型
    • └ material
    • String
    • xxx
    • 素材
    • └ effective_interval
    • Number
    • 2
    • 相对使用时间长度
    • └ encrypted_dynamic_info
    • String
    • xxxx
    • 加密动态面额参数
    • └ start_fee
    • Number
    • 17
    • 门槛
    • └ asac
    • String
    • xxx
    • 权益安全码
    • └ start_date
    • Date
    • 1556193150000
    • 发放开始时间
    • └ effective_start
    • Date
    • 1556193150000
    • 绝对使用时间开始
    • └ effective_end
    • Date
    • 1556193150000
    • 绝对使用时间结束
    • show_benefit_instances
    • ShowBenefitInstanceDTO []
    • 权益维度核销数据
    • └ record_id
    • Number
    • 123456
    • 中奖记录ID
    • └ tracking_data
    • String
    • {}
    • 追踪信息
    • └ msg
    • String
    • xxx
    • 错误描述
    • └ code
    • String
    • LATOUR2-xx-01
    • 错误码
    • └ success
    • Boolean
    • true
    • 是否成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaLatourStrategyShowRequest req = new AlibabaLatourStrategyShowRequest();
    req.setWithTestBenefit(true);
    req.setChannel("xxx");
    req.setPageSize(10L);
    req.setTransformedUserType("uic");
    req.setNeedIdentifyRisk(true);
    req.setUserNick("xxx");
    req.setSkipWithHadWin(true);
    req.setFilterEmptyInventory(true);
    req.setUserId("xxx");
    req.setStrategyCode("xxxxx");
    req.setUserType("weibo");
    req.setCurrentPage(1L);
    req.setFilterCrowd(true);
    req.setOpenid("xxxx");
    req.setWithStrategyInstance(false);
    req.setWithBenefitInstance(false);
    AlibabaLatourStrategyShowResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_latour_strategy_show_response>
        <result>
            <data>
                <extra_data></extra_data>
                <has_next_page>false</has_next_page>
                <show_strategy>
                    <mode>DRAW</mode>
                    <code>xxx</code>
                    <all_rule_passed>true</all_rule_passed>
                    <asac>xxx</asac>
                    <algorithm_failover>false</algorithm_failover>
                    <show_rules>
                        <show_rule_dto>
                            <feature>xxx</feature>
                            <passed>false</passed>
                            <type>xxx</type>
                        </show_rule_dto>
                    </show_rules>
                    <show_benefit_instances>
                        <show_benefit_instance_d_t_o>
                            <benefit_code>xxxx</benefit_code>
                            <benefit_type>xxx</benefit_type>
                            <record_id>123456</record_id>
                        </show_benefit_instance_d_t_o>
                    </show_benefit_instances>
                </show_strategy>
                <current_page>1</current_page>
                <show_benefits>
                    <show_benefit_dto>
                        <code>xxxxx</code>
                        <type_desc>现金红包</type_desc>
                        <display_amount_unit>元</display_amount_unit>
                        <end_date>1593517953000</end_date>
                        <title>签到红包</title>
                        <type>fpRedEnvelope</type>
                        <feature>xxx</feature>
                        <can_win>true</can_win>
                        <interval_time_unit>DAYS</interval_time_unit>
                        <display_start_fee>0.17</display_start_fee>
                        <send_mode>dynamicValue</send_mode>
                        <send_life_cycle_state>running</send_life_cycle_state>
                        <amount>16</amount>
                        <test>false</test>
                        <had_win>true</had_win>
                        <show_rules>
                            <show_rule_dto>
                                <passed>true</passed>
                                <type>CROWD_LIMIT</type>
                                <feature>xxx</feature>
                            </show_rule_dto>
                        </show_rules>
                        <amount_unit>分</amount_unit>
                        <has_inventory>true</has_inventory>
                        <display_amount>0.16</display_amount>
                        <effective_time_mode>RELATIVE_NATURAL</effective_time_mode>
                        <material>xxx</material>
                        <effective_interval>2</effective_interval>
                        <encrypted_dynamic_info>xxxx</encrypted_dynamic_info>
                        <start_fee>17</start_fee>
                        <asac>xxx</asac>
                        <start_date>1556193150000</start_date>
                        <effective_start>1556193150000</effective_start>
                        <effective_end>1556193150000</effective_end>
                        <show_benefit_instances>
                            <show_benefit_instance_d_t_o>
                                <record_id>123456</record_id>
                            </show_benefit_instance_d_t_o>
                        </show_benefit_instances>
                    </show_benefit_dto>
                </show_benefits>
                <tracking_data>{}</tracking_data>
            </data>
            <msg>xxx</msg>
            <code>LATOUR2-xx-01</code>
            <success>true</success>
        </result>
    </alibaba_latour_strategy_show_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

    返回
    顶部