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

taobao.unidesk.rta.report.asynctask.add (UD报表-创建异步任务接口)

UD报表-创建异步任务接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
report_task_top_dto ReportTaskTopDTO 必须 入参,每个账户(adv)每天最多创建50个任务
  • params
  • ReportTaskParamTopDTO
  • 必须
  • 报表任务参数
  • └ order_by_field
  • String
  • 可选
  • click
  • 排序字段
  • └ end_date
  • String
  • 必须
  • 2022-12-23
  • 结束日期, 格式yyyy-MM-dd,按天分组时间区间不能超过一个月,按小时分组只支持查询当天数据
  • └ order_by_type
  • String
  • 可选
  • ASC
  • 排序方式,ASC:正序、DESC:倒序
  • └ group_by
  • String []
  • 必须
  • STAT_GROUP_BY_CAMPAIGN_ID,STAT_GROUP_BY_TIME_DAY
  • 分组条件,素材分组仅头条2.0支持,STAT_GROUP_BY_ADVERTISER_ID:按照广告主分组,STAT_GROUP_BY_CAMPAIGN_ID:按照计划组分组(腾讯3.0无计划组报表),STAT_GROUP_BY_ADGROUP_ID:按照计划分组,STAT_GROUP_BY_CREATIVE_ID:按照创意分组,STAT_GROUP_BY_TIME_DAY:按照天分组,STAT_GROUP_BY_TIME_HOUR:按照小时分组,STAT_GROUP_BY_MATERIAL_ID:按照素材分组,STAT_GROUP_BY_MATERIAL_X_ADGROUP_ID:按照素材X计划分组,STAT_GROUP_BY_COMBINATION_MATERIAL_ID:按照素材组合分组,STAT_GROUP_BY_COMBINATION_MATERIALX_CAMPAIGN_ID:按照素材组合X项目分组
  • └ fields
  • String []
  • 可选
  • cost,adPv,ecpm,click,adCtr,ecpc
  • 需要返回的指标,不指定则返回默认指标。具体字段名称参考日报表、小时报表数据查询接口
  • filtering
  • ReportTaskFilterTopDTO
  • 可选
  • 1
  • 过滤条件
  • └ adgroup_ids
  • Number []
  • 可选
  • 1
  • 按照计划过滤
  • └ effect
  • Number
  • 可选
  • 7
  • 转化效果周期,7:7天,15:15天
  • └ campaign_ids
  • Number []
  • 可选
  • 1
  • 按照计划组过滤
  • └ creative_ids
  • Number []
  • 可选
  • 1
  • 按照创意过滤
  • └ effect_type
  • Number
  • 可选
  • 1
  • 归因逻辑,1:点击效果,0:展示效果
  • └ material_id
  • Number
  • 可选
  • 1
  • 按照素材过滤,素材id从adgroup查询接口获取,素材组合报表只支持根据标题素材id筛选
  • └ start_date
  • String
  • 必须
  • 2022-12-21
  • 开始日期, 格式yyyy-MM-dd
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ name
  • String
  • 必须
  • 任务名称
  • 任务名称
  • └ force
  • Number
  • 可选
  • 1
  • 强制生成新的任务,参数相同会复用之前的任务,1:是,0:否
  • └ version
  • Number
  • 可选
  • 9999
  • 平台版本,9999:升级版API(仅巨量2.0API需传入) 3:腾讯3.0需要传入

响应参数

名称 类型 示例值 描述
result AsyncTaskTopDTO 返回结果
  • └ id
  • Number
  • 1
  • 任务id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaReportAsynctaskAddRequest req = new UnideskRtaReportAsynctaskAddRequest();
UnideskRtaReportAsynctaskAddRequest.ReportTaskTopDTO obj1 = new UnideskRtaReportAsynctaskAddRequest.ReportTaskTopDTO();
UnideskRtaReportAsynctaskAddRequest.ReportTaskParamTopDTO obj2 = new UnideskRtaReportAsynctaskAddRequest.ReportTaskParamTopDTO();
obj2.setOrderByField("click");
obj2.setEndDate("2022-12-23");
obj2.setOrderByType("ASC");
obj2.setGroupBy("STAT_GROUP_BY_CAMPAIGN_ID,STAT_GROUP_BY_TIME_DAY");
obj2.setFields("cost,adPv,ecpm,click,adCtr,ecpc");
UnideskRtaReportAsynctaskAddRequest.ReportTaskFilterTopDTO obj3 = new UnideskRtaReportAsynctaskAddRequest.ReportTaskFilterTopDTO();
obj3.setAdgroupIds(new Long[] { 1 };
);
obj3.setEffect(7L);
obj3.setCampaignIds(new Long[] { 1 };
);
obj3.setCreativeIds(new Long[] { 1 };
);
obj3.setEffectType(1L);
obj3.setMaterialId(1L);
obj2.setFiltering(obj3);
obj2.setStartDate("2022-12-21");
obj1.setParams(obj2);
obj1.setAdvertiserId(1L);
obj1.setName("任务名称");
obj1.setForce(1L);
obj1.setVersion(9999L);
req.setReportTaskTopDto(obj1);
UnideskRtaReportAsynctaskAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_report_asynctask_add_response>
    <result>
        <id>1</id>
    </result>
</unidesk_rta_report_asynctask_add_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

返回
顶部