文档中心 > API类目 > 阿里妈妈-媒体开放平台

alibaba.tanx.ssp.settle.report.query (阿里妈妈媒体开放平台投放数据报表API)

阿里妈妈媒体开放平台投放数据报表API

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_param SdkSettlementReportTopQueryDTO 可选 查询参数对象
  • └ os
  • String
  • 可选
  • android
  • 系统类型,枚举值为:android、ios;非法取值会忽略。
  • └ end_date
  • String
  • 可选
  • 2022-08-31
  • 结束日期,格式为:yyyy-MM-dd
  • └ pids
  • String []
  • 可选
  • ["mm_1_2_3","mm_1_2_4"]
  • 广告位ID
  • └ app_ids
  • Number []
  • 可选
  • [111,112]
  • 应用ID
  • └ page_size
  • Number
  • 可选
  • 20
  • 每页记录数大小,默认100,最大5000
  • └ dimensions
  • String []
  • 可选
  • ["day","app_id"]
  • 数据聚合维度字段,枚举值为:day - 天级粒度的日期、app_id - 应用ID、pid - 广告位ID、os - 系统类型
  • └ start_date
  • String
  • 可选
  • 2022-08-01
  • 开始日期,格式为:yyyy-MM-dd
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码

响应参数

名称 类型 示例值 描述
result TopSettleReportDTO [] 结果数据
  • └ req_cnt
  • Number
  • 11222
  • 广告请求量
  • └ clk_cnt
  • Number
  • 12
  • 广告点击量
  • └ os
  • String
  • ios
  • 系统类型,枚举值:android、ios
  • └ fill_rate
  • String
  • 0.1002
  • 广告填充率=resp_cnt/req_cnt,保留4位小数
  • └ pid
  • String
  • mm_8373_256680_111812
  • 广告位ID
  • └ resp_cnt
  • Number
  • 123
  • 广告返回数量
  • └ revenue
  • String
  • 1.23
  • 预估媒体收益,单位:元,保留2位小数
  • └ exposure_rate
  • String
  • 0.0221
  • 广告曝光率=imp_cnt/req_cnt,保留4位小数
  • └ imp_cnt
  • Number
  • 1234
  • 广告曝光量
  • └ ecpm
  • String
  • 1.21
  • eCPM,单位:元,保留2位小数
  • └ clk_rate
  • String
  • 0.0401
  • 广告点击率=clk_cnt/imp_cnt,保留4位小数
  • └ app_id
  • Number
  • 123
  • 应用ID
  • └ day
  • String
  • 2022-08-01
  • 天级粒度的日期,格式为:yyyy-MM-dd
  • └ ad_name
  • String
  • 广告位名称
  • 广告位名称
count Number 1465 查询条件匹配到的总记录数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTanxSspSettleReportQueryRequest req = new AlibabaTanxSspSettleReportQueryRequest();
AlibabaTanxSspSettleReportQueryRequest.SdkSettlementReportTopQueryDTO obj1 = new AlibabaTanxSspSettleReportQueryRequest.SdkSettlementReportTopQueryDTO();
obj1.setOs("android");
obj1.setEndDate("2022-08-31");
obj1.setPids(""mm_1_2_3","mm_1_2_4"");
obj1.setAppIds(new Long[] { 111,112 };
);
obj1.setPageSize(20L);
obj1.setDimensions(""day","app_id"");
obj1.setStartDate("2022-08-01");
obj1.setPageNo(1L);
req.setQueryParam(obj1);
AlibabaTanxSspSettleReportQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_tanx_ssp_settle_report_query_response>
    <result>
        <top_settle_report_d_t_o>
            <req_cnt>11222</req_cnt>
            <clk_cnt>12</clk_cnt>
            <os>ios</os>
            <fill_rate>0.1002</fill_rate>
            <pid>mm_8373_256680_111812</pid>
            <resp_cnt>123</resp_cnt>
            <revenue>1.23</revenue>
            <exposure_rate>0.0221</exposure_rate>
            <imp_cnt>1234</imp_cnt>
            <ecpm>1.21</ecpm>
            <clk_rate>0.0401</clk_rate>
            <app_id>123</app_id>
            <day>2022-08-01</day>
            <ad_name>广告位名称</ad_name>
        </top_settle_report_d_t_o>
    </result>
    <count>1465</count>
</alibaba_tanx_ssp_settle_report_query_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

返回
顶部