报告模块

实时报告请求对象

字段名称 类型 描述 限制
performanceData array(string) 指定返回数据 必填(取值范围中任意一个)
取值范围:
impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
针对不同的物料层级,其合法的取值范围不同,(按照第一个请求的字段排序)请参见规则描述
说明:impression(展现)、click(点击)、cost(消费)、ctr(点击率)、cpc(平均点击价格)、cpm(千次展现消费)、aggrformsubmitsuccess(表单提交成功量)、aggrordersubmitsuccess(订单提交成功量)、aggreffectiveconsults(有效咨询量)、highqualityconsults(高质量咨询量)、aggrformclicksuccess(表单按钮点击量)、aggrreverseclicks(表单调起按钮点击量)、aggrconcultclicks(咨询按钮点击量)、aggrphoneclicks(电话按钮点击量)、activeconversions(APP激活量)、ocpx信息
order boolean 是否为降序排列 选填,默认null,按照时间排序:
true-降序
false-升序
startDate string 统计开始时间,格式参考:
2016-11-25
必填
说明:开始时间不能早于2016-11-25
endDate string 统计结束时间,格式参考:
2016-11-30
必填
说明:不能晚于当前时间,不能早于开始时间
levelOfDetails number 指定返回的数据层级 选填,默认为账户
2:账户粒度
3:计划粒度
5:单元粒度
7:创意粒度
reportType number 实时数据类型 必填
700:账户报告
701:计划报告
702:单元报告
703:创意报告
725:ocpx报告
statIds array(number) 统计范围下的id集合。根据StatRange的不同类型填写不同id 选填,默认NULL,表示统计范围为全账户
staRange为3时填写计划id
staRange为5时填写单元id
staRange为7时填写创意id
statRange number 统计范围 选填,默认值为2
2:账户范围:
3:计划范围
5:单元范围
7:创意范围
注意:统计范围不能细于当前的统计粒度,例如统计粒度为计划,则统计范围不能细到单元
unitOfTime number 统计时间单位 选填,默认值为5
取值范围:
5:分日
4:分周
3:分月
7:分时
8:请求时间段汇总(endDate-StartDate)
number number 返回数据条数 选填
目前实时报告中账户、计划、单元、创意报告最大支持10000条
默认值1000条
注意:超过限制或者小于等于0则报错
producttype number 版位 取值范围:
0-全部
1-列表页
2-详情页
subject number 推广对象 选填,默认值为0
0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
注意:仅支持计划和单元报告
bidType array(string) 出价模式 ocpx才有用
["3"]:ocpx
["5"]:ecpc
["3","5"]:ocpx+ecpc
payMode array(string) 付费模式 ocpx才有用
["0","1"]:ocpc
["2"]:ocpm
["0","1","2"]:ocpx
materialStyle number 样式类型 选填,默认值为0
0:全部
1:单图
2:三图
pageIndex number 分页 (选填)请求页码
说明:默认不分页
当不填写页码或页码参数为<=0时,代表未分页;
请求页码设置大于0时,代表分页请求(同时需要配合number字段)
bstype number bstype 选填(不填返回全部)
0:全部
1:普通报告
3:闪投报告

实时报告返回对象

字段名称 类型 描述
ID Long 请求对象的ID(ocpx报告此字段无用,固定为0)
name String[] 请求对象的name,数组形式,不同报告形式的不同定义规则见name字段规则
Date String 统计开始时间
KPIs String[] 按照请求顺序,返回KPI数据数组

name字段规则

其中name字段根据不同的报告类型,数组长度和各个位置代表的意义不一样,规则分别如下:

报告类型 NAME字段规则
账户报告 账户名
计划报告 账户名,计划名
单元报告 账户名,计划名,单元名
创意报告 账户名,计划名,单元名,创意名称,标题,图片数量,url

name字段是字符串数组类型,规则中按照“,”分割各个数组位需要填入的实际字段名,若某数组位的字段值为空值,则用“-”代替。

异步报告请求对象

字段名称 类型 描述 限制
performanceData array(string) 指定返回数据 必填(取值范围中任意一个)
取值范围:
impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
针对不同的物料层级,其合法的取值范围不同,(按照第一个请求的字段排序)请参见规则描述
说明:impression(展现)、click(点击)、cost(消费)、ctr(点击率)、cpc(平均点击价格)、cpm(千次展现消费)、aggrformsubmitsuccess(表单提交成功量)、aggrordersubmitsuccess(订单提交成功量)、aggreffectiveconsults(有效咨询量)、highqualityconsults(高质量咨询量)、aggrformclicksuccess(表单按钮点击量)、aggrreverseclicks(表单调起按钮点击量)、aggrconcultclicks(咨询按钮点击量)、aggrphoneclicks(电话按钮点击量)、activeconversions(APP激活量)、 ocpx信息
startDate string 统计开始时间,格式参考:
2016-11-25
必填
2016-12-25
说明:开始时间不能早于2016-11-25
endDate string 统计结束时间,格式参考:
2016-11-30
必填
idOnly boolean 是否只需要id 选填;默认为false
取值范围:
true:只获取id
false:既获取id也获取字面
levelOfDetails number 统计粒度 选填;不同的ReportType对应的默认值和取值范围不同,请参见规则描述
2:账户粒度
3:计划粒度
5:单元粒度
7:创意粒度
format number 报告文件格式 选填,默认值为2;
2:csv格式
reportType number 报告类型 必填;
700:账户报告
701:计划报表
702:单元报告
703:创意报告
725:ocpx报告
statIds array(number) 统计范围下的id集合。根据StatRange的不同类型填写不同id 选填,默认NULL,表示统计范围为全账户
staRange为3时填写计划id
staRange为5时填写单元id
staRange为7时填写创意id
statRange number 统计范围 选填,默认值为2;
2:账户范围
3:计划范围
5:单元范围
7:创意范围
注意:统计范围不能细于当前的统计粒度,例如统计粒度为计划,则统计范围不能细到单元
unitOfTime number 统计时间单位 选填,默认值为5
取值范围:
5:日报
4:周报
3:月报
7:分时报
8:请求时间段汇总(endDate-StartDate)
subject number 推广对象 选填,默认值为0
0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
materialStyle number 样式类型 0:全部
1:单图
2:三图
producttype number 版位 取值范围:
0-全部
1-列表页
2-详情页
bidType array(string) 出价模式 ocpx才有用
["3"]:ocpx
["5"]:ecpc
["3","5"]:ocpx+ecpc
payMode array(string) 付费模式 ocpx才有用
["0","1"]:ocpc
["2"]:ocpm
["0","1","2"]:ocpx
bstype number bstype 选填(不填返回全部)
0:全部
1:普通报告
3:闪投报告

获取实时报告

接口描述

请求账户,计划,单元,创意4种绩效数据报告,请求时提供所需数据报告的条件,返回本次请求数据。

接口URL

http://sem.baidubce.com/v1/feed/cloud/ReportFeedService/getRealTimeFeedData

请求参数说明

字段名称 类型 描述
realTimeRequestType object 具体类型见实时报告请求对象

响应参数说明

字段名称 类型 描述
- array(object) 具体类型见实时报告返回对象

请求示例

POST /v1/feed/cloud/ReportFeedService/getRealTimeFeedData HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
    "header": {
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body": {
        "realTimeRequestType": {
            "producttype": 0,
            "endDate": "2019-02-22",
            "levelOfDetails": 2,
            "number": 1000,
            "order": true,
            "performanceData": [
                "cost",
                "impression",
                "click",
                "cpm",
                "ctr",
                "cpc"
            ],
            "reportType": 700,
            "startDate": "2019-02-21",
            "statRange": 2,
            "unitOfTime": 7,
            "bstype":0
        }
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
    "body":{
        "data":[
            {
                "id": 1234,
                "kpis": [
                    "12.3",
                    "100",
                    "10",
                    "123",
                    "0.1",
                    "1.23"
                ],
                "name": [
                    "账户名"
                ],
                "date": "2019-02-22 17:00"
            }
        ]
    }
}

获取异步报告

接口描述

请求绩效数据报告,请求时提供所需数据报告的条件,返回本次请求的reportId。

接口URL

http://sem.baidubce.com/v1/feed/cloud/ReportFeedService/getReportFeedId

请求参数说明

字段名称 类型 描述
reportRequestType object 具体类型见异步报告请求对象

响应参数说明

字段名称 类型 描述
reportFeedId string 生成的报告ID,为一串MD5值

请求示例

POST /v1/feed/cloud/ReportFeedService/getReportFeedId HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
    "header": {
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body": {
        "realTimeRequestType": {
            "producttype": 0,
            "endDate": "2019-02-22",
            "levelOfDetails": 2,
            "order": true,
            "performanceData": [
                "cost",
                "impression",
                "click",
                "cpm",
                "ctr",
                "cpc"
            ],
            "reportType": 700,
            "startDate": "2019-02-21",
            "statRange": 2,
            "unitOfTime": 7,
            "bstype":0
        }
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
    "body":{
        "data":[
            {
                "reportFeedId": "8e7e3f2d84a19c5df1415957434b2***"
            }
        ]
    }
}

获取异步报告状态

接口描述

查询报告当前的生成状态。请求中提供报告ID,返回中带有当前报告ID的处理状态。在获取Report下载url前,请调用此方法。待确认报表已生成时,再获取下载的url。

接口URL

http://sem.baidubce.com/v1/feed/cloud/ReportFeedService/getReportFeedState

请求参数说明

字段名称 类型 描述
reportId string 生成的报告ID,为一串MD5值

响应参数说明

字段名称 类型 描述
isGenerated number 报告生成状态,
1:等待中
2:处理中
3:处理成功
对于生成失败的报告返回null和对应的错误码

请求示例

POST /v1/feed/cloud/ReportFeedService/getReportFeedState HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
    "header":{
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body":{
        "reportId": "8e7e3f2d84a19c5df1415957434b2***"
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
    "body":{
        "data":[
            {
                "isGenerated": 3
            }
        ]
    }
}

获取异步报告路径

接口描述

获取报告下载地址。当报告成功生成后,使用reportId请求,返回相应的报告下载地址。生成的url有效期为1小时,如果超时则需重新调用此方法,获取新的url。

接口URL

http://sem.baidubce.com/v1/feed/cloud/ReportFeedService/getReportFeedFileUrl

请求参数说明

字段名称 类型 描述
reportId string 生成的报告ID,为一串MD5值

响应参数说明

字段名称 类型 描述
reportFilePath string 下载地址,生成的url有效期为1小时,如果超时则需重新获取新的url
对于生成失败或者正在生成中报告返回null和对应的错误码

请求示例

POST /v1/feed/cloud/ReportFeedService/getReportFeedFileUrl HTTP/1.1
Accept-encoding: 'gzip, deflate'
Host: sem.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/b406c344bb764e00aff7d3b80d9bd87a/2019-06-05T07:34:31Z/1800/host/bb0f820e4499b8b44548388b37a7afed970e965a7a59f79ebac47a99c315a97b(签名有效时间为30分钟,需要替换成自己生成的签名)
Accept: '*/*'
{
    "header":{
        "opUsername": "example",
        "tgUsername": "example",
        "bceUser": "example",
        "opPassword": "example",
        "tgPassword": "example"
    },
    "body":{
        "reportId": "8e7e3f2d84a19c5df1415957434b2***"
    }
}

响应示例

{
    "header":{
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    },
    "body":{
        "data":[
            {
                "reportFilePath": "http://apidata.baidu.com/***"
            }
        ]
    }
}

报告规则

整体规则:实时报告按照请求的顺序返回结果,异步报告相对顺序一致。

账户报告

查询条件 取值范围
reportType 700
startDate 不能早于20161125
小时报的起始日期不能早于31天以前
endDate 不能早于startDate
levelOfDetails 2 (账户粒度)
statRange 2 (账户范围)
unitOfTime 5,4,3,7,8 (日报,周报,月报,分时报,请求时间段汇总)
subject 0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
performanceData impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
说明:可只填写取值范围中任意一个,如:impression

账户报告说明:materialStyle(样式类型)字段,请求时填写将会报错。

计划报告

查询条件 取值范围
reportType 701
startDate 不能早于20161125
小时报的起始日期不能早于31天以前
endDate 不能早于startDate
levelOfDetails 3 (计划粒度)
statRange 2,3(账户范围,计划范围)
unitOfTime 5,4,3,7,8(日报,周报,月报,分时报,请求时间段汇总)
subject 0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
performanceData impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
说明:可只填写取值范围中任意一个,如:impression

计划报告说明:不支持materialStyle(样式类型)字段,请求时填写将会报错

单元报告

查询条件 取值范围
reportType 702
startDate 不能早于20161125
小时报的起始日期不能早于31天以前
endDate 不能早于startDate
levelOfDetails 5(单元粒度)
statRange 2,3,5(账户范围,计划范围,单元范围)
unitOfTime 5,4,3,7,8 (日报,周报,月报,分时报,请求时间段汇总)
subject 0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
producttype 0-全部
1-列表页
2-详情页
performanceData impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
说明:可只填写取值范围中任意一个,如:impression

单元报告说明:不支持materialStyle(样式类型)字段,请求时填写将会报错

创意报告

查询条件 取值范围
reportType 703
startDate 不能早于20161125
小时报的起始日期不能早于31天以前
endDate 不能早于startDate
levelOfDetails 7(创意粒度)
statRange 2,3,5,7(账户范围,计划范围,单元范围,创意范围)
unitOfTime 5,4,3,8,7(日报,周报,月报,请求时间段汇总,分时报)
materialStyle 0:全部
1:单图
2:三图
subject 0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
producttype 0-全部
1-列表页
2-详情页
performanceData impression、click、cost、ctr、cpc、cpm、aggrformsubmitsuccess、aggrordersubmitsuccess、aggreffectiveconsults、highqualityconsults、aggrformclicksuccess、aggrreverseclicks、aggrconcultclicks、aggrphoneclicks、activeconversions
说明:可只填写取值范围中任意一个,如:impression

ocpx报告

查询条件 取值范围
reportType 725
startDate 不能早于20161125
endDate 不能早于startDate
levelOfDetails 200(固定传值)
statRange 2(账户范围)
unitOfTime 5,4,3,8(日报,周报,月报,请求时间段汇总)
subject 0:全部
1:网站链接
2:APP(IOS)
3:APP(ANDROID)
bidType ["3"]:ocpx
["5"]:ecpc
["3","5"]:ocpx+ecpc
payMode ["0","1"]:ocpc
["2"]:ocpm
["0","1","2"]:ocpx
performanceData date(时间)
unitinfo(单元信息)
planinfo(计划信息)
paysum(消费)
ocpcstagestatus(转化阶段)
ocpcstage2starttime(进入第二阶段时间)
clks(点击)
shows(展示)
ocpctranstype(转化目标)
ocpctargettrans(目标转化量)
bidType(出价模式)
paymode(付费模式)
ocpctargettransratio(目标转化率)
ocpctargettranscpc(目标转化成本)
ocpclabstatus(是否实验室)
说明:clks,shows,date三个字段必填,其他字段可只填写取值范围中任意一个