文档中心 > API类目 > 直通车API

taobao.universalbp.report.async.create.download.task (创建异步下载任务)

入参报表查询信息,出参下载任务id

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
report_query_v_o ReportQueryVo 必须 reportQueryVO
  • └ split_type
  • String
  • 必须
  • hour
  • 汇总类型 sum-汇总,hour-分时,day-分天,week-分周,month-分月
  • └ unify_type
  • String
  • 必须
  • zhai
  • 归因口径,zhai-末次点击归因, mta-mta归因
  • └ start_time
  • String
  • 必须
  • 2023-06-06
  • 开始时间
  • └ end_time
  • String
  • 必须
  • 2023-06-12
  • 结束时间
  • └ effect_equal
  • Number
  • 必须
  • 15
  • 归因周期,1、3、7、15、30
  • └ biz_code_in_list
  • String []
  • 可选
  • [onebpDisplay]
  • 场景筛选code
  • └ strategy_optimize_target_in_list
  • Number []
  • 可选
  • [3003]
  • 优化目标筛选
  • └ strategy_campaign_id_in_list
  • Number []
  • 可选
  • [68798644117]
  • 计划id筛选
  • └ strategy_adgroup_id_or_name
  • String
  • 可选
  • 连衣裙长裙
  • 单元id或者名称筛选
  • └ strategy_adgroup_id_in_list
  • Number []
  • 可选
  • [68798644117]
  • 单元id筛选
  • └ sub_promotion_types
  • String []
  • 可选
  • [USER_DEFINE_URL]
  • 主体类型筛选,ITEM_PRIVATE_MINIL-橱窗,SHOP-店铺,USER_DEFINE_URL-自定义
  • └ strategy_target_title_like
  • String
  • 可选
  • 消费
  • 人群名称模糊过滤
  • └ item_ids
  • Number []
  • 可选
  • [68798644117]
  • 宝贝id筛选
  • └ strategy_creative_id_or_name
  • String
  • 可选
  • 1111111
  • 仅创意报表有效,创意筛选
  • └ adzone_pkg_id_in_list
  • Number []
  • 可选
  • [68798644117]
  • 流量来源资源包id筛选
  • └ bid_word_type_in_list
  • String []
  • 可选
  • [word, wordPkg]
  • 词包还是词
  • └ strategy_bidword_name_like
  • String
  • 可选
  • 红裙
  • 词模糊筛选
  • └ strategy_bidword_pkg_name_like
  • String
  • 可选
  • 红裙
  • 词包模糊筛选
  • └ province_id_in_list
  • Number []
  • 可选
  • [1]
  • 省份筛选
  • └ query_domains
  • String []
  • 可选
  • [account, campaign]
  • 聚合维度,可用值和选择对应报表类型一致
  • └ query_field_in_list
  • String []
  • 可选
  • adPv
  • 需要下载的指标数据
  • └ excel_name
  • String
  • 必须
  • 账户报表00000
  • 报表异步下载文件名称,下载时必填
  • └ field_type
  • String
  • 必须
  • xxxxx
  • 下载指标设置, all-全部指标,selected-下载传入指标
  • └ parent_adc_name
  • String
  • 必须
  • report_frame_campaign
  • 报表下载需要的参数,必填, report_frame_account-账户,report_frame_campaign-计划,report_frame_adgroup-单元,report_frame_bidword-关键词,report_frame_crowd-人群,report_frame_item_promotion-宝贝主体,report_frame_other_promotion-其他主体,report_frame_creative-创意,report_frame_area-地域
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小
  • └ rpt_type
  • String
  • 必须
  • crowd
  • 报表类型
  • └ source
  • String
  • 可选
  • async_dowdload
  • 来源
  • └ from_real_time
  • Boolean
  • 可选
  • false
  • 是否查询实时库,不传默认就是false

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • top_report_download_v_o
  • TopReportDownloadVo
  • 结果集
  • └ task_id
  • Number
  • 99999
  • 任务id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpReportAsyncCreateDownloadTaskRequest req = new UniversalbpReportAsyncCreateDownloadTaskRequest();
UniversalbpReportAsyncCreateDownloadTaskRequest.TopServiceContext obj1 = new UniversalbpReportAsyncCreateDownloadTaskRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpReportAsyncCreateDownloadTaskRequest.ReportQueryVo obj2 = new UniversalbpReportAsyncCreateDownloadTaskRequest.ReportQueryVo();
obj2.setSplitType("hour");
obj2.setUnifyType("zhai");
obj2.setStartTime("2023-06-06");
obj2.setEndTime("2023-06-12");
obj2.setEffectEqual(15L);
obj2.setBizCodeInList("onebpDisplay");
obj2.setStrategyOptimizeTargetInList(new Long[] { 3003 };
);
obj2.setStrategyCampaignIdInList(new Long[] { 68798644117 };
);
obj2.setStrategyAdgroupIdOrName("连衣裙长裙");
obj2.setStrategyAdgroupIdInList(new Long[] { 68798644117 };
);
obj2.setSubPromotionTypes("USER_DEFINE_URL");
obj2.setStrategyTargetTitleLike("消费");
obj2.setItemIds(new Long[] { 68798644117 };
);
obj2.setStrategyCreativeIdOrName("1111111");
obj2.setAdzonePkgIdInList(new Long[] { 68798644117 };
);
obj2.setBidWordTypeInList("word, wordPkg");
obj2.setStrategyBidwordNameLike("红裙");
obj2.setStrategyBidwordPkgNameLike("红裙");
obj2.setProvinceIdInList(new Long[] { 1 };
);
obj2.setQueryDomains("account, campaign");
obj2.setQueryFieldInList("adPv");
obj2.setExcelName("账户报表00000");
obj2.setFieldType("xxxxx");
obj2.setParentAdcName("report_frame_campaign");
obj2.setOffset(0L);
obj2.setPageSize(20L);
obj2.setRptType("crowd");
obj2.setSource("async_dowdload");
obj2.setFromRealTime(false);
req.setReportQueryVO(obj2);
UniversalbpReportAsyncCreateDownloadTaskResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_report_async_create_download_task_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_report_download_v_o>
            <task_id>99999</task_id>
        </top_report_download_v_o>
    </result>
</universalbp_report_async_create_download_task_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

返回
顶部