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

API参考  |  整帐户下载&跨层级下载服务

整帐户下载 & 跨层级下载服务 (AccountDownloadService)

通过 AccountDownloadService ,您可以下载全部帐户信息或按计划下载帐户信息。您首先需要通过 getAccountFile() 方法获得一个字符串类型的 accountFileId ,然后通过 pull 的方式轮询调用 getAccountFileStatus() 方法检查报表是否产生。待产生后,则可调用 getAccountFilePath() 方法获取整帐户文件的下载地址。根据该地址即可下载您所需要的整帐户文件。 同报告 id 一样,整帐户文件 id 采用 <32 位 16 进制数 > 的取值形式。

数据类型

接口描述

getAccountFile

方法说明:获取整帐户或跨层级信息
输入信息: getAccountFileRequest 说明如下 :

属性名 类型 说明 限制
cpcPlanIds Long[] 指定计划 id ,获取其下全部物料信息。如为空,则获取该账户下的完整物料信息 选填,默认为空;
为空表示获取该账户下的完整物料信息
includeQuality Boolean 账户信息中是否包含关键词质量度。
提示:如果包含质量度,性能会有所下降
选填,默认为 false ;
true: 包含质量度
false:不包含质量度
includeTemp Boolean 是否包含修改后还未生效的关键词、创意。
默认不包含修改后未生效的关键词、创意
选填,默认为 false ;
true :包含修改未生效物料,即获取的是全集
false :不包含修改后还未生效的关键词、创意
format Integer 压缩文件格式 无效属性,默认为 zip
opt Opt 预留属性,支持未来整账户文件下载返回扩展数据列 若不需要下载账户图片,则在optInt中传参:key值withoutImg,valule设为1

返回信息: getAccountFileResponse :含有本次请求所返回的文件 Id.

属性名 类型 说明 限制
accountFileId String 生成的文件 ID ID 为一串 MD5 值,格式为 32 位 16 进制数标示,例如 8e7e3f2d84a19c5df1415957434b2bd8

getAccountFileStatus

方法说明:查询报告是否生成
输入信息: getAccountFileStatusRequest

属性名 类型 说明 限制
accountFileId String 请求的文件 ID

返回信息: getAccountFileStatusResponse :

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

getAccountFilePath

方法说明:获取报告下载地址
输入信息: getAccountFilePathRequest

属性名 类型 说明 限制
accountFileId String 文件 ID

返回信息: getAccountFilePathResponse

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

API整账户下载物料说明

1. 账户信息

(1) 文件名:download_account_***.csv,***为一个随机数,例: download_account_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
账户ID Long 411643
账户余额 Double 以元为单位,小数点后保留两位 10000
账户累积消费 Double 以元为单位,小数点后保留两位 100.55
账户投资 Double 以元为单位,小数点后保留两位 10000.55
账户预算 Double 以元为单位,小数点后保留两位 901.55
投放地区代码 String 投放地区之间以||分割
代码和地域间的对应关系:
0001 所有地区
1000 北京
2000 上海
3000 天津
4000 广东
5000 福建
8000 海南
9000 安徽
10000 贵州
11000 甘肃
12000 广西
13000 河北
14000 河南
15000 黑龙江
16000 湖北
17000 湖南
18000 吉林
19000 江苏
20000 江西
21000 辽宁
22000 内蒙古
23000 宁夏
24000 青海
25000 山东
26000 山西
27000 陕西
28000 四川
29000 西藏
30000 新疆
31000 云南
32000 浙江
33000 重庆
34000 港澳台及其他地区
35000 无地区
1000||3000||13000||18000||26000
投放地区名称 String 投放地区之间以||分割

北京||上海||厦门
IP排除列表 String 排除IP之间以||分割 1.2.3.6||11.1.22.*
账户开放域名列表 String 域名之间以||分割 http://www.sogou.com/

2. 推广计划信息

(1) 文件名:download_cpcplan_***.csv, ***为一个随机数,例:download_cpcplan_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
推广计划ID Long 299000
推广计划名称 String 计划1
推广计划每日预算 Double 以元为单位,小数点后保留两位 1500
投放地区代码 String 同账户投放地区代码字段 1000||2000||17000
投放地区名称 String 同账户投放地区名称字段 北京||上海||厦门
IP排除列表 String 同账户IP排除列表 1.2.3.6||11.1.22.*
否定关键词列表 String 关键词之间以||分割 感冒药||头疼药
精确否定关键词列表 String 关键词之间以||分割 皮包||钱包
推广暂停时段 String 时段之间以||分割,每个时段内部以格式:星期**开始时间**结束时间表示 1**0**23||
2**0**23||
3**0**23||
4**0**23||
5**0**23||
6**0**23||
7**0**24
到达预算下线时段 String 时段之间以||分割,每个时段内部以格式:flag**时间表示
创意展现方式 Int 1:展现
0:不展现
1
暂停 / 取消暂停推广计划 Boolean True :暂停
False : 取消暂停
TRUE
是否内容关联 Boolean True :是
False :否
TRUE
内容关联出价 Double 以元为单位,小数点后保留两位 300.55
推广计划状态 Int
移动出价比例 double 小数点后保留两位 1.20

3. 推广组信息

(1) 文件名:download_cpcgrp_***.csv,***为一个随机数,例:download_cpcgrp_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
推广计划 ID Long 301284
推广组 ID Long 70853530
推广组名称 String 优先教育计划
推广组出价 Double 1.5
推广组否定关键词 String 关键词之间以 || 分割
推广组精确否定关键词 String 关键词之间以 || 分割
暂停 / 取消暂停推广组 Boolean true :暂停
false :取消暂停
推广组状态 int

4. 关键词信息

(1) 文件名: download_cpcgrp_***.csv , *** 为一个随机数,例:download_cpcgrp_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
推广计划 ID Long 299046
推广组 ID Long 70844984
关键词 ID Long 2990454
关键词 String 塑胶跑道供应商
关键词出价 Double 0.35
访问 URL String
移动访问 URL String
匹配方式 int 0 :精确匹配
1 :广泛匹配
2 :短语匹配(核心包含)
4 :短语匹配(精确包含)
5 :短语匹配(同义包含)
1
暂停 / 取消暂停关键词 Boolean true :暂停
false :取消暂停
FALSE
关键词状态 int 31:审核未通过
32:暂停
33:审核中
34:搜索无效
35:正常
36:关键词计算机搜索无效
37:关键词移动搜索无效正常
31
关键词质量度 int 1:0.5星,2:1星,3:1.5星,4:2星,5:2.5星,6:3星,7:3.5星,8:4星,9:4.5星,10:5星 -1
是否为修改未生效物料 int 0 :否
1 :是
0
能否展现 int 0 :否
1 :是
0
是否使用组出价 int 0 :否
1 :是
0
关键词移动质量度 int 1:0.5星,2:1星,3:1.5星,4:2星,5:2.5星,6:3星,7:3.5星,8:4星,9:4.5星,10:5星 10
关键词不能展示的原因 String 暂停推广:关键词所在的推广计划设置了暂停,取消暂停可恢复展现。
审核不通过原因 String 推广内容包含近期黑名单(123);
是否不回插 int 0:否, 1:是 推广内容包含近期黑名单(123);
不回插原因 String 推广内容包含注册商标(123);

5. 创意信息

(1) 文件名: download_cpcidea_***.csv , *** 为一个随机数,例: download_cpcidea_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
推广计划 ID Long 299012
推广组 ID Long 70844934
创意 ID Long 29932454
创意标题 String 搜狗 { 海南旅游 } 特价 ! 带你玩转假期 !
创意描述 1 String 搜狗旅游 , 精心安排 { 海南旅游 }, 玩转海南 , 尽享完美行程 !
创意描述 2 String 超值价格 , 完美体验 ! 详情请致电 :
访问 URL String http://www.sogou.com
显示 URL String http://www.sogou.com
移动访问 URL String http://www.sogou.com
移动显示 URL String http://www.sogou.com
暂停 / 取消暂停创意 Boolean true :暂停
false :取消暂停
FALSE
创意状态 int 41 :审核未通过
42 :暂停
43 :审核中
44 :正常
45 :移动显示URL无效
44
是否为修改未生效物料 int 0 :原创意
1 :修改后的创意
0
创意审核不通过原因 String -- --
移动访问URL审核不通过原因 String -- --

6. 附加创意信息

(1) 文件名: 计算机附加创意download_cpcexidea_***.csv,移动附加创意download_cpcmobiexidea_***.csv(已下线), *** 为一个随机数,例: download_cpcidea_3d8a3cb444f860bb32d49f289fd35555.csv
(2) 文件内容:

列名 数据类型 说明 例子
推广计划 ID Long 299012
推广组 ID Long 70844934
取消暂停/暂停 1 Boolean true :暂停
false :取消暂停
FALSE
子链ID Long 子链id
子链名称 String 假日鲜花
子链访问 URL String http://www.sogou.com
图片ID Long 图片id
是否为修改未生效物料 int 0 :原附加创意
1 :修改后的附加创意
0
创意审核不通过原因 String

7. 移动创意组件信息

(1) 文件名: 创意组件-子链组件内容:download_subchain_***.csv、创意组件-单图组件内容:download_mobilesingleimage_*.csv、创意组件-图文组件内容:download_mobilepictext_*.csv、创意组件-图集组件内容:download_mobilepicset_*.csv;其中*** 为一个随机数,例: download_subchain_e738124b46fd270880a5dc99b66bfb91.csv
(2) 文件内容:
移动创意组件内容:

列名 数据类型 说明 例子
物料 ID Long 254489680
物料类型 Int 7:短子链-组合
8:长子链-组合
9:单图组件
18:图文组件
11:短子链-单条
37:长子链-单条
52:图集组件
7
物料内容 String 参考content格式说明
投放设备 Int 2:移动 2
绑定关系 Int 1:账号,2:推广计划,3:推广组 1
TargetIds String 绑定范围(账户、计划或组的ID)与绑定关系字段联动 16,467,360,731,646,800,000
取消暂停/暂停 Int 0:取消暂停,1:暂停 0
审核状态 Int 105:正常 ;106:审核中 107:拒绝 ;108:暂停 105
审核失败原因 String 推广内容涉及违禁信息
是否为修改未生效物料 Int 0:否,1:是 0