文档中心 > API类目 > 阿里妈妈-UniDesk

taobao.unidesk.rta.assets.creativecomponent.get (UD创意组件查询接口)

UD创意组件查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
creative_component_top_query_dto CreativeComponentTopQueryDTO 必须 查询参数
  • └ page_no
  • Number
  • 可选
  • 1
  • 第几页
  • └ id
  • Number
  • 可选
  • 1
  • 创意组件id
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页多少条
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ type
  • Number
  • 可选
  • 1
  • 组件类型, 1图片磁贴 2电商磁贴 3电商优惠券磁贴 4推广卡片

响应参数

名称 类型 示例值 描述
result CreativeComponentTopDTO [] 组件信息列表
  • └ name
  • String
  • 组件名称
  • 组件名称
  • └ id
  • Number
  • 1
  • 组件ID
  • toutiao_coupon_magnet
  • ToutiaoCouponComponentTopDTO
  • 组件详细信息-电商优惠券磁贴
  • └ effective_end_date
  • String
  • 2020-12-01
  • 优惠结束时间。格式: "2020-12-01"
  • └ duration
  • Number
  • 10
  • 出现时间,单位s。 当show_time为自定义时必传,小于等于59,大于等于10。 当show_time为系统默认时,可不传,默认为10
  • └ coupon_amount
  • Number
  • 1
  • 优惠金额,单位分
  • └ show_time
  • Number
  • 1
  • 出现时间类型。1 系统默认,2自定义。不传代表系统默认
  • └ coupon_condition
  • Number
  • 1
  • 优惠条件,单位分
  • └ landing_page
  • String
  • httpxx
  • 淘积木链接
  • └ effective_start_date
  • String
  • 2020-12-01
  • 优惠开始时间。格式: "2020-12-01"
  • └ activity_name
  • String
  • 活动名称
  • 活动名称。长度最大为15。一个中文长度为2
  • └ start_time
  • String
  • 2020-12-01
  • 投放开始时间。格式: "2020-12-01"
  • └ end_time
  • String
  • 2020-12-01
  • 投放结束时间。格式: "2020-12-01"
  • └ type
  • Number
  • 1
  • 组件类型, 1图片磁贴 2电商磁贴 3电商优惠券磁贴 4推广卡片
  • toutiao_promotion_card
  • ToutiaoPromotionCardComponentTopDTO
  • 组件详细信息-推广卡片
  • └ button_text
  • String
  • 1
  • 行动号召。内容长度要求:2 ≤ x ≤6。一个中文长度为1
  • └ img_id
  • String
  • 1
  • 图片id
  • └ title
  • String
  • 1
  • 卡片标题。长度最大为20。一个中文长度为1
  • └ enable_personal_action
  • Number
  • 1
  • 是否开启智能优选,1-开启、0-不开启
  • └ product_selling_points
  • String []
  • 推广卖点。最多选择10个推广卖点 ,内容长度要求:6 ≤ x ≤9 。一个中文长度为1
  • └ img_url
  • String
  • https://
  • 图片链接
  • toutiao_image_magnet
  • ToutiaoImageComponentTopDTO
  • 组件详细信息-图片磁贴
  • └ duration
  • Number
  • 10
  • 出现时间,单位s。 当show_time为自定义时必传,小于等于59,大于等于10。 当show_time为系统默认时,可不传,默认为10
  • └ img_id
  • String
  • 1
  • 图片id 尺寸<=540*276px ,大小<2M
  • └ show_time
  • Number
  • 1
  • 出现时间类型。1 系统默认,2自定义。不传代表系统默认
  • └ start_time
  • String
  • 2020-12-01
  • 投放开始时间。格式: "2020-12-01"
  • └ end_time
  • String
  • 2020-12-01
  • 投放结束时间。格式: "2020-12-01"
  • └ img_url
  • String
  • https://
  • 图片链接
  • └ gmt_create
  • Date
  • 1661759114578
  • 创建时间
  • └ advertiser_id
  • Number
  • 1
  • 广告主id
  • └ status
  • Number
  • 1
  • 审核状态,1审核通过 2审核中 3审核拒绝
  • toutiao_commerce_magnet
  • ToutiaoECommerceCreativeTopComponent
  • 组件详细信息-电商磁贴
  • └ start_time
  • String
  • 2020-12-01
  • 投放开始时间。格式: "2020-12-01"
  • └ end_time
  • String
  • 2020-12-01
  • 投放结束时间。格式: "2020-12-01"
  • └ magnet_title
  • String
  • 磁贴标题
  • 磁贴标题。长度最大为10。一个中文长度为1
  • └ title
  • String
  • 文案内容
  • 文案内容。长度最大为15。一个中文长度为1
  • └ button_text
  • String
  • 立即购买
  • 按钮文案。只支持立即下单和立即购买
  • └ img_id
  • String
  • 1
  • 图片,宽高比1:1,尺寸最大为174*174,大小<1M
  • └ img_url
  • String
  • https://
  • 图片链接
  • kuaishou_image_magnet
  • KuaishouImageComponentTopDTO
  • 组件详细信息-图片磁贴-快手
  • └ img_id
  • String
  • 1
  • 图片id
  • └ img_url
  • String
  • https://xx
  • 图片链接
  • kuaishou_coupon_magnet
  • KuaishouCouponComponentTopDTO
  • 组件详细信息-优惠券磁贴-快手
  • └ landing_page
  • String
  • http://xx
  • 淘积木链接
  • └ activity_name
  • String
  • 活动名称
  • 活动名称。长度最大为15。一个中文长度为2
  • └ coupon_amount
  • Number
  • 100
  • 优惠金额,单位分
  • └ coupon_condition
  • Number
  • 200
  • 优惠条件,单位分
  • └ effective_start_date
  • String
  • 2023-01-01
  • 优惠开始时间。格式: "2020-12-01"
  • └ effective_end_date
  • String
  • 2023-02-01
  • 优惠结束时间。格式: "2020-12-01"
  • toutiao_shopping_cart_magnet
  • ToutiaoShoppingCartCreativeComponentTopDTO
  • 组件详细信息-购物车锚点-头条
  • └ shopping_cart_title
  • String
  • 购物车标题
  • 购物车标题
  • └ img_ids
  • String []
  • 商品图片
  • └ product_price
  • Number
  • 1
  • 商品价格
  • └ product_title
  • String
  • 商品标题
  • 商品标题
  • └ product_source
  • Number
  • 1
  • 商品来源 1:淘宝
  • └ link_type
  • Number
  • 1
  • 跳转类型 1 一跳 2 二跳
  • └ external_url
  • String
  • https://
  • 落地页链接
  • └ open_url
  • String
  • https://
  • 应用直达链接
total Number -1 总条数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAssetsCreativecomponentGetRequest req = new UnideskRtaAssetsCreativecomponentGetRequest();
UnideskRtaAssetsCreativecomponentGetRequest.CreativeComponentTopQueryDTO obj1 = new UnideskRtaAssetsCreativecomponentGetRequest.CreativeComponentTopQueryDTO();
obj1.setPageNo(1L);
obj1.setId(1L);
obj1.setPageSize(10L);
obj1.setAdvertiserId(1L);
obj1.setType(1L);
req.setCreativeComponentTopQueryDto(obj1);
UnideskRtaAssetsCreativecomponentGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_assets_creativecomponent_get_response>
    <result>
        <creative_component_top_d_t_o>
            <name>组件名称</name>
            <id>1</id>
            <toutiao_coupon_magnet>
                <effective_end_date>2020-12-01</effective_end_date>
                <duration>10</duration>
                <coupon_amount>1</coupon_amount>
                <show_time>1</show_time>
                <coupon_condition>1</coupon_condition>
                <landing_page>httpxx</landing_page>
                <effective_start_date>2020-12-01</effective_start_date>
                <activity_name>活动名称</activity_name>
                <start_time>2020-12-01</start_time>
                <end_time>2020-12-01</end_time>
            </toutiao_coupon_magnet>
            <type>1</type>
            <toutiao_promotion_card>
                <button_text>1</button_text>
                <img_id>1</img_id>
                <title>1</title>
                <enable_personal_action>1</enable_personal_action>
                <img_url>https://</img_url>
            </toutiao_promotion_card>
            <toutiao_image_magnet>
                <duration>10</duration>
                <img_id>1</img_id>
                <show_time>1</show_time>
                <start_time>2020-12-01</start_time>
                <end_time>2020-12-01</end_time>
                <img_url>https://</img_url>
            </toutiao_image_magnet>
            <gmt_create>1661759114578</gmt_create>
            <advertiser_id>1</advertiser_id>
            <status>1</status>
            <toutiao_commerce_magnet>
                <start_time>2020-12-01</start_time>
                <end_time>2020-12-01</end_time>
                <magnet_title>磁贴标题</magnet_title>
                <title>文案内容</title>
                <button_text>立即购买</button_text>
                <img_id>1</img_id>
                <img_url>https://</img_url>
            </toutiao_commerce_magnet>
            <kuaishou_image_magnet>
                <img_id>1</img_id>
                <img_url>https://xx</img_url>
            </kuaishou_image_magnet>
            <kuaishou_coupon_magnet>
                <landing_page>http://xx</landing_page>
                <activity_name>活动名称</activity_name>
                <coupon_amount>100</coupon_amount>
                <coupon_condition>200</coupon_condition>
                <effective_start_date>2023-01-01</effective_start_date>
                <effective_end_date>2023-02-01</effective_end_date>
            </kuaishou_coupon_magnet>
            <toutiao_shopping_cart_magnet>
                <shopping_cart_title>购物车标题</shopping_cart_title>
                <product_price>1</product_price>
                <product_title>商品标题</product_title>
                <product_source>1</product_source>
                <link_type>1</link_type>
                <external_url>https://</external_url>
                <open_url>https://</open_url>
            </toutiao_shopping_cart_magnet>
        </creative_component_top_d_t_o>
    </result>
    <total>-1</total>
</unidesk_rta_assets_creativecomponent_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部