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

taobao.tbk.activity.info.get (淘宝客-推广者-官方活动转链)

支持入参推广位和官方活动会场ID,获取活动信息和推广链接,包含推广长链接、短链接、淘口令、微信推广二维码地址等。改该API支持二方、三方类型的转链。官方活动会场ID,从淘宝客后台“我要推广-活动推广”中获取。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
activity_material_id String 必须 123 官方活动会场ID,从淘宝客后台“我要推广-活动推广”中获取
adzone_id Number 必须 123 mm_xxx_xxx_xxx的第三位
sub_pid String 可选 mm_1_2_3 mm_xxx_xxx_xxx 仅三方分成场景使用
relation_id Number 可选 123 渠道关系id
union_id String 可选 demo 自定义输入串,英文和数字组成,长度不能大于12个字符,区分不同的推广渠道

响应参数

名称 类型 示例值 描述
data Data 返回结果对象
  • └ wx_qrcode_url
  • String
  • https://img.alicdn.com/xxx
  • 【本地化】微信推广二维码地址
  • └ click_url
  • String
  • https://s.click.xx.xx/xxx?xx
  • 淘客推广长链
  • └ short_click_url
  • String
  • https://s.click.xx.xx/xxx?xx
  • 淘客推广短链
  • └ terminal_type
  • String
  • 1
  • 投放平台, 1-PC 2-无线
  • └ material_oss_url
  • String
  • http://xxx.xxx.xxx
  • 物料素材下载地址
  • └ page_name
  • String
  • 活动会场A
  • 会场名称
  • └ page_start_time
  • String
  • 2020-02-27
  • 活动开始时间
  • └ page_end_time
  • String
  • 2020-02-27
  • 活动结束时间
  • └ wx_miniprogram_path
  • String
  • pages/sharePid/web/index?scene=https://xxx
  • 【本地化】微信小程序路径

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkActivityInfoGetRequest req = new TbkActivityInfoGetRequest();
req.setActivityMaterialId("123");
req.setAdzoneId(123L);
req.setSubPid("mm_1_2_3");
req.setRelationId(123L);
req.setUnionId("demo");
TbkActivityInfoGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tbk_activity_info_get_response>
    <data>
        <wx_qrcode_url>https://img.alicdn.com/xxx</wx_qrcode_url>
        <click_url>https://s.click.xx.xx/xxx?xx</click_url>
        <short_click_url>https://s.click.xx.xx/xxx?xx</short_click_url>
        <terminal_type>1</terminal_type>
        <material_oss_url>http://xxx.xxx.xxx</material_oss_url>
        <page_name>活动会场A</page_name>
        <page_start_time>2020-02-27</page_start_time>
        <page_end_time>2020-02-27</page_end_time>
        <wx_miniprogram_path>pages/sharePid/web/index?scene=https://xxx</wx_miniprogram_path>
    </data>
</tbk_activity_info_get_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>

错误码解释

错误码 错误描述 解决方案
isp.invalid-parameter-adzone 入参adzone_id错误 请检查adzone_id是否属于appkey拥有者
4 入参adzone_id不存在 查询不到对应的adzoneId,请检查adzoneId是否正确
isp.invalid-parameter-materialId 物料id无效 请检查物料id是否从官方渠道获取或物料本身是否已失效
1108 【本地化】饿了么微信小程序二维码生成失败 请稍后重试,多次重试无效后请联系官方人员
1107 【本地化】饿了么短链生成失败 请稍后重试,多次重试无效后请联系官方人员
isp.isp.get-activityinfo-unavailable 服务无法获取 稍后重试,多次重试无效后请联系官方人员
isv.invalid-parameter-materialId 入参物料id无效 请检查物料id是否从官方渠道获取或物料本身是否已失效
isv.invalid-parameter-adzone 入参adzone_id错误 请检查adzone_id是否属于appkey拥有者
isv.empty-parameter-materialId 入参物料ID不正确 请传入正确的物料ID

API工具

如何获得此API

FAQ

返回
顶部