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

taobao.unidesk.rta.ad.raise.report.get (一键起量-报告获取)

一键起量-报告获取

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
report_top_query_dto ReportTopQueryDTO 可选 查询参数
  • └ group_by
  • String []
  • 可选
  • STAT_GROUP_BY_TIME_HOUR
  • 分组粒度 STAT_GROUP_BY_TIME_HOUR - 时间类型-按照小时分组
  • └ advertiser_id
  • Number
  • 可选
  • 1
  • 广告主ID
  • filtering
  • ReportFilterTopQueryDTO
  • 可选
  • 筛选条件
  • └ adgroup_ids
  • Number []
  • 可选
  • 1
  • 计划ID,仅限传一个且必传 只支持字节2.0
  • └ adgroup_raise_version
  • Number
  • 可选
  • 1
  • 起量版本号
  • └ start_date
  • String
  • 可选
  • 2023-01-01 00:00:00
  • 开始时间,与起量版本号的开始时间一致。YYYY-MM-DD HH:mm:ss
  • └ end_date
  • String
  • 可选
  • 2023-01-01 00:00:00
  • 结束时间,与起量版本号的结束时间一致。YYYY-MM-DD HH:mm:ss

响应参数

名称 类型 示例值 描述
result AdgroupRaiseReportTopDTO [] 起量报告信息
  • └ ad_raise_version
  • Number
  • 1
  • 起量版本号
  • └ click
  • Number
  • 1
  • 点击量
  • └ convert
  • Number
  • 1
  • 转化数
  • └ cost
  • Number
  • 1
  • 消耗
  • └ ad_pv
  • Number
  • 1
  • 展示数
  • └ stat_datetime
  • String
  • 2023-08-21 10:00:00
  • 起量时间

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdRaiseReportGetRequest req = new UnideskRtaAdRaiseReportGetRequest();
UnideskRtaAdRaiseReportGetRequest.ReportTopQueryDTO obj1 = new UnideskRtaAdRaiseReportGetRequest.ReportTopQueryDTO();
obj1.setGroupBy("STAT_GROUP_BY_TIME_HOUR");
obj1.setAdvertiserId(1L);
UnideskRtaAdRaiseReportGetRequest.ReportFilterTopQueryDTO obj2 = new UnideskRtaAdRaiseReportGetRequest.ReportFilterTopQueryDTO();
obj2.setAdgroupIds(new Long[] { 1 };
);
obj2.setAdgroupRaiseVersion(1L);
obj1.setFiltering(obj2);
obj1.setStartDate("2023-01-01 00:00:00");
obj1.setEndDate("2023-01-01 00:00:00");
req.setReportTopQueryDto(obj1);
UnideskRtaAdRaiseReportGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_raise_report_get_response>
    <result>
        <adgroup_raise_report_top_d_t_o>
            <ad_raise_version>1</ad_raise_version>
            <click>1</click>
            <convert>1</convert>
            <cost>1</cost>
            <ad_pv>1</ad_pv>
            <stat_datetime>2023-08-21 10:00:00</stat_datetime>
        </adgroup_raise_report_top_d_t_o>
    </result>
</unidesk_rta_ad_raise_report_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

返回
顶部