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

taobao.unidesk.rta.ad.creative.get (UD创意查询接口)

UD创意查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
creative_top_query_dto CreativeTopQueryDTO 必须 查询参数
  • └ campaign_id
  • Number
  • 可选
  • 1
  • 计划组id
  • └ page_no
  • Number
  • 可选
  • 1
  • 第几页
  • └ ids
  • Number []
  • 可选
  • 1
  • 创意id
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页多少条
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ adgroup_id
  • Number
  • 可选
  • 1
  • 计划id
  • └ start_time
  • String
  • 可选
  • 2023-01-01
  • 创建时间大于等于startDate的数据 格式:yyyy-MM-dd 查询最长跨度为三个月
  • └ end_time
  • String
  • 可选
  • 2023-01-01
  • 创建时间小于等于endDate的数据. 格式:yyyy-MM-dd 查询最长跨度为三个月

响应参数

名称 类型 示例值 描述
result CreativeTopDTO [] 返回结果
  • reasons
  • CreativeRejectReasonTopDTO []
  • 审核拒绝详情
  • └ images
  • String []
  • 图片id列表, 素材类型为"图片"时填充
  • └ reject_reason
  • String
  • 审核拒绝原因
  • 审核拒绝原因
  • └ material_type
  • String
  • 素材
  • 素材类型:创意、素材、图片、标题、视频、副标题、头图、摘要
  • └ reject_item
  • String
  • 审核拒绝项
  • 审核拒绝项
  • └ videos
  • String []
  • 视频id列表, 素材类型为"视频"时填充
  • └ title
  • String
  • 标题
  • 标题,素材类型为"标题"时填充
  • └ adgroup_id
  • Number
  • 1
  • 计划id
  • └ id
  • Number
  • 1
  • 创意id
  • └ campaign_id
  • Number
  • 1
  • 计划组id
  • └ title
  • String
  • 创意标题
  • 创意标题
  • └ gmt_create
  • Date
  • 1661742350955
  • 创建时间
  • └ advertiser_id
  • Number
  • 1
  • 广告主id
  • └ tags
  • String []
  • 创意标签
  • └ opt_status
  • Number
  • 1
  • 操作状态,1:启用,0:暂停,-1:删除
  • └ category
  • Number
  • 1
  • 创意分类
  • └ action_text
  • String
  • 行动号召文本
  • 行动号召文本
  • └ format
  • Number
  • 1
  • 广告形式,1:竖版视频,2:横版视频,3:大图横图,5:小图,6:大图竖图。竖版视频:格式要求:mp4、mpeg、3gp、avi 视频格式,建议尺寸要求:宽高比9:16,分辨率≥ 720*1280,视频码率≥516kbps,时长≥4s; 竖版视频-视频封面:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比9:16,1440*2560 ≤ 尺寸≥ 720*1280; 横版视频:格式要求:mp4、mpeg、3gp、avi 视频格式,建议尺寸要求:宽高比16:9,分辨率≥ 1280*720,视频码率≥516kbps,时长≥4s,大小≤1000M; 横版视频-视频封面:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比16:9,2560*1440 ≤ 尺寸≥ 1280*720; 大图横图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比16:9,2560*1440 ≤ 尺寸≥ 1280*720; 组图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比1.52,1368*900 ≤ 尺寸≥ 456*300; 小图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比1.52,1368*900 ≤ 尺寸≥ 456*300; 大图竖图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比9:16,1440*2560 ≤ 尺寸≥ 720*1280;
  • └ img_ids
  • String []
  • 图片素材id列表(组图存在多个)
  • └ video_id
  • String
  • v02033g10000catc8b3c77ua16dov4og
  • 视频素材id
  • └ video_cover_img_id
  • String
  • 0000catc8b3c77ua1
  • 视频素材封面id。注:通过UDBP生成的自动封面不会返回封面ID,可先通过素材查询接口获取poster值(视频首帧图URL),再通过素材上传接口上传即可获得该视频的自动封面ID。
  • └ status
  • Number
  • 1
  • 状态,-1:已删除,1:投放中,2:未到达投放时间,3:不在投放时段,4:创意暂停,5:已被广告组暂停,6:广告组超出预算,7:新建审核中, 8:修改审核中,10:已完成(投放达到结束时间),11:广告计划暂停,12:审核不通过,13:账户余额不足,14:超出预算,15:数据错误,16:预上线,17:广告计划新建审核中,18:广告计划修改审核中,19:广告计划审核不通过,20:所有包含已删除,21:所有不包含已删除,22:超出账户日预算,23:作品异常,24:视频审核通过可投放滑滑场景,25:部分素材审核失败
  • └ last_modify_time
  • Date
  • 1600987
  • 最后修改时间
total Number 1 总条数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCreativeGetRequest req = new UnideskRtaAdCreativeGetRequest();
UnideskRtaAdCreativeGetRequest.CreativeTopQueryDTO obj1 = new UnideskRtaAdCreativeGetRequest.CreativeTopQueryDTO();
obj1.setCampaignId(1L);
obj1.setPageNo(1L);
obj1.setIds(new Long[] { 1 };
);
obj1.setPageSize(10L);
obj1.setAdvertiserId(1L);
obj1.setAdgroupId(1L);
obj1.setStartTime("2023-01-01");
obj1.setEndTime("2023-01-01");
req.setCreativeTopQueryDto(obj1);
UnideskRtaAdCreativeGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_creative_get_response>
    <result>
        <creative_top_d_t_o>
            <reasons>
                <creative_reject_reason_top_d_t_o>
                    <reject_reason>审核拒绝原因</reject_reason>
                    <material_type>素材</material_type>
                    <reject_item>审核拒绝项</reject_item>
                    <title>标题</title>
                </creative_reject_reason_top_d_t_o>
            </reasons>
            <adgroup_id>1</adgroup_id>
            <id>1</id>
            <campaign_id>1</campaign_id>
            <title>创意标题</title>
            <gmt_create>1661742350955</gmt_create>
            <advertiser_id>1</advertiser_id>
            <opt_status>1</opt_status>
            <category>1</category>
            <action_text>行动号召文本</action_text>
            <format>1</format>
            <video_id>v02033g10000catc8b3c77ua16dov4og</video_id>
            <video_cover_img_id>0000catc8b3c77ua1</video_cover_img_id>
            <status>1</status>
            <last_modify_time>1600987</last_modify_time>
        </creative_top_d_t_o>
    </result>
    <total>1</total>
</unidesk_rta_ad_creative_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

返回
顶部