搜狗首页  |   服务首页  |   客服热线:010-56898080

API参考  |  历史操作日志查询服务

历史操作日志查询服务 (BizlogService)

通过 BizlogService ,您可以获取历史操作日志的详细报表。由于产生报告需要一定的时间,我们采用了异步的方式对报表进行处理。您首先需要通过 getOptRecordId() 方法获得一个字符串类型的 reportId , 然后通过 pull 的方式轮询调用 getOptRecordStatus() 方法检查报表是否产生。待产生后,则可调用 getOptRecordFilePath() 方法获取报表的下载地址。根据该地址即可下载您所需要的报表。 报告 id 采用 <32 位 16 进制数 > 的取值形式,例如: 8e7e3f2d84a19c5df1415957434b2bd8

数据类型

接口描述

getOptRecordId

方法说明:查询历史操作记录报告
输入信息: optRecordIdRequest :历史操作日志查询参数,只有一个 OptRecordRequestType 对象 ,该对象说明如下 :

属性名 类型 说明 限制
startDate dateTime 统计开始时间,格式参考:
2019-03-10T00:00:00.000
必填
时间跨度不能超过45天,只能查询近3个月的历史操作记录,今日数据会有一定延迟
endDate dateTime 统计结束时间,格式参考:
2019-03-14T23:59:59.000
必填
optRangeLevel Integer 查询的操作范围层级 选填
1: 账户范围
2: 计划范围
3: 推广组范围
4: 关键词范围
5: 创意范围
statIds Long[] 指定的 id集合,根据optRangeLevel的不同类型 选填,默认为NULL,表示统计范围为全账户
optRangeLevel 为2时,填写计划ID;
optRangeLevel为3时填写推广组ID;
optRangeLevel为4时填写关键词ID;
optRangeLevel为5时填写创意ID;
optRole Integer 操作角色 选填
0: 全部角色
1: 账户管家
2: 客户
optLevel Integer[] 查询的操作内容 选填 ,默认值为0
0: 全部
1: 推广组
2: 推广计划
3: 账户
4: 创意
5: 关键词
25: 推广卫士
28:异地访客IP
32:高级样式
注意:操作内容层级不能高于操作范围层级optRangeLevel,例如操作范围在推广组下,操作内容层级不能选择推广计划或账户
Opt Opt 针对特定的报告类型设置特定的统计范围 无效属性
format Integer 压缩文件格式 无效属性,默认为zip


返回信息: optRecordIdResponse :含有本次请求所返回的 optRecordId.

属性名 类型 说明 限制
optRecordId String 生成的历史操作记录报告ID ID 为一串 MD5 值,格式为 32 位 16 进制数标示,例如 8e7e3f2d84a19c5df1415957434b2bd8


getOptRecordStatus

方法说明:查询历史记录报告是否生成
输入信息: optRecordStatusRequest

属性名 类型 说明 限制
optRecordId String 请求的报告 ID

返回信息: optRecordStatusResponse:

属性名 类型 说明 限制
isGenerated Integer 报告生成状态 1: 已完成
0: 处理中
-1:报告生成异常

附加说明:在获取 optRecord 下载 url 前,请调用此方法。待确认报表已生成时,再获取下载的 url 。
getOptRecordFilePath

方法说明:获取历史操作记录报告下载地址
输入信息: optRecordPathRequest

属性名 类型 说明 限制
optRecordId String 报告 ID

返回信息: optRecordPathResponse

属性名 类型 说明 限制
optRecordFilePath String 下载地址