API参考 | 帐户服务
帐户服务 (CpcAccountService)
通过 AccountService ,您可以查询 / 更新您的账户信息。包括账户消费限额、推广地域、推广信息、 IP 排除、账户余额等数据。
数据类型
AccountType
属性名 |
类型 |
说明 |
限制 |
accountid |
Long |
账户 ID |
|
balance |
Double |
账户余额 |
|
totalCost |
Double |
账户累积消费 |
|
totalPay |
Double |
账户投资 |
|
budget |
Double |
账户预算 |
|
type |
Integer |
账户财务数据类型 |
无效属性 |
regions |
Integer[] |
投放地区列表 |
|
excludeIps |
String[] |
IP 排除列表 |
|
domains |
String[] |
账户开放域名列表 |
|
budgetOfficeTime |
BudgetOfficeTime[] |
到达预算下线时段 |
数组元素个数限制:最近有过下线时段的自然日的下线和上线时段
(若某日期距当前已超过 30天,则不返回)
注:时间为 date 类型,格式示例”2018-08-11T20:00:00.691+08:00”
|
accountLevel |
Integer |
账户星级 |
1 – 四星客户 ;
2 – 三星客户 ;
3 – 二星客户 ;
4 – 一星客户;
5 – 未生效客户
|
opt |
Opt |
可选字段 |
目前无效,用于扩展接口 |
BudgetOfficeTime 对象定义了账户的到达预算下线时间段
属性名 |
类型 |
说明 |
限制 |
flag |
Integer |
标识改时间点是发生了上线还是下线 |
1 - 上线
0 - 下线 |
time |
dateTime |
下线 / 上线时间点 |
|
Opt
属性名 |
类型 |
说明 |
限制 |
optString |
List<StringMapItem> |
|
|
optInt |
List<IntMapItem> |
|
|
optLong |
List<LongMapItem> |
|
|
optFloat |
List<FloatMapItem> |
|
|
optDouble |
List<DoubleMapItem> |
|
|
StringMapItem
属性名 |
类型 |
说明 |
限制 |
key |
String |
键 |
key |
value |
String |
值 |
value |
IntMapItem
属性名 |
类型 |
说明 |
限制 |
key |
String |
键 |
|
value |
Integer |
值 |
|
LongMapItem
属性名 |
类型 |
说明 |
限制 |
key |
String |
键 |
|
value |
Long |
值 |
|
FloatMapItem
属性名 |
类型 |
说明 |
限制 |
key |
String |
键 |
|
value |
Float |
值 |
|
DoubleMapItem
属性名 |
类型 |
说明 |
限制 |
key |
String |
键 |
|
value |
Double |
值 |
|
ChangedCpcPlanIdType
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
1 : 新增计划
2 : 删除计划
3 : 计划属性有修改
4 : 新增推广组
5 : 删除推广组
6 : 推广组属性有修改
7 : 新增关键词
8 : 删除关键词
9 : 关键词属性有修改
10 : 新增创意
11 : 删除创意
12 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
ChangedCpcGrpIdType
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
4 : 新增推广组
5 : 删除推广组
6 : 推广组属性有修改
7 : 新增关键词
8 : 删除关键词
9 : 关键词属性有修改
10 : 新增创意
11 : 删除创意
12 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
ChangedCpcIdType
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
7 : 新增关键词
8 : 删除关键词
9 : 关键词属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
cpcIdeaId |
Long |
变化创意 id |
|
ChangedCpcIdeaIdType
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
10 : 新增创意
11 : 删除创意
12 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
cpcIdeaId |
Long |
变化创意 id |
|
接口描述
getAccountInfo
获取 SOAPHeader 中 username 对应的账户信息。接口如下:
输入信息: getAccountInfoRequest ,无具体参数
返回信息: getAccountInfoResponse
属性名 |
类型 |
说明 |
限制 |
accountType |
AccountType |
- |
- |
updateAccountInfo
更新 SOAPHeader 中 username 对应的账户信息
输入信息: updateAccountInfoRequest
属性名 |
类型 |
说明 |
限制 |
accountType |
AccountType |
更新对象 |
见下表 |
对 accountType 对象的输入限制如下:
属性名 |
类型 |
说明 |
限制 |
userId |
Long |
无效属性 |
|
balance |
Double |
无效属性 |
|
totalCost |
Double |
无效属性 |
|
totalPay |
Double |
无效属性 |
|
budget |
Double |
选填;
值为 NULL :不修改该属性;
值为 0 :取消预算限制 |
|
type |
Integer |
无效属性 |
无效属性 |
regions |
Integer |
选填;
值为 NULL :不修改该属性;
值为 0( 数组仅有 1 个元素 , 为 0) :取消投放地区限制 |
|
excludeIps |
String |
IP 排除列表
若要置空列表,需要传 ["$"] |
|
domains |
String |
无效属性 |
无效属性 |
budgetOfficeTime |
BudgetOfficeTime[] |
无效属性 |
无效属性
|
accountLevel |
Integer |
无效属性 |
无效属性 |
opt |
Opt |
可选字段 |
目前无效,用于扩展 |
返回信息: updateAccountInfoResponse
属性名 |
类型 |
说明 |
限制 |
accountType |
AccountType |
返回更新后的对象 |
对于输入时的无效属性,返回值为 null |
getChangedCpcPlanId
获取从指定时间到当前时间段内有变化的计划 id 。
输入信息: getChangedCpcPlanIdRequest
属性名 |
类型 |
说明 |
限制 |
startTime |
datetime |
更新的起始时间 |
必填;不能早于 3 个月以前,例如现在是 9 月 10 日,则 startTime 最早只能到 7 月 1 日,即查询 7 、 8 、 9 三个月 |
cpcPlanLevel |
Boolean |
是否获取计划层级有变化的 cpcPlanId
返回对象中对应 operator 标识为 1,2,3 |
选填,默认值为 true ;
true: 获取
false :不获取 |
cpcGrpLevel |
Boolean |
是否获取推广组层级有变化的 cpcPlanId
返回对象中对应 operator 标识为 4,5,6 |
选填,默认值为 true ;
true: 获取
false :不获取 |
cpcMaterialLevel |
Boolean |
是否获取关键词 / 创意层级有变化的 cpcPlanId
返回对象中对应 operator 标识为 7,8,9,10,11,12 |
选填,默认值为 true ;
true: 获取
false :不获取 |
返回信息: getChangedCpcPlanIdResponse
属性名 |
类型 |
说明 |
限制 |
endTime |
datetime |
当前时间点 |
- |
changedCpcPlanIds |
ChangedCpcPlanIdType [] |
变化的计划 id |
- |
getChangedCpcGrpId
获取从指定时间到当前时间段内有变化的推广组 id 。
输入信息: getChangedCpcGrpIdRequest
属性名 |
类型 |
说明 |
限制 |
startTime |
datetime |
更新的起始时间 |
必填;不能早于 3 个月以前,例如现在是 9 月 10 日,则 startTime 最早只能到 7 月 1 日,即查询 7 、 8 、 9 三个月 |
cpcPlanIds |
Long |
指定的计划 id 数组 |
选填,为空表示获取全账户范围下的变化推广组 id |
cpcGrpLevel |
Boolean |
是否获取推广组层级有变化的 cpcGrpId
返回对象中对应 operator 标识为 4,5,6 |
选填,默认值为 true ;
true: 获取
false :不获取 |
cpcMaterialLevel |
Boolean |
是否获取关键词 / 创意层级有变化的 cpcGrpId
返回对象中对应 operator 标识为 7,8,9,10,11,12 |
选填,默认值为 true;
true: 获取
false :不获取 |
返回信息: getChangedCpcGrpIdResponse
属性名 |
类型 |
说明 |
限制 |
endTime |
datetime |
当前时间点 |
- |
changedCpcGrpIds |
ChangedCpcGrpIdType [] |
变化的推广组 id |
- |
对 ChangedCpcGrpIdType 对象解释如下:
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
1 : 新增推广组
2 : 删除推广组
3 : 推广组属性有修改
4 : 新增关键词
5 : 删除关键词
6 : 关键词有修改
7 : 新增创意
8 : 删除创意
9 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
getChangedCpcMaterialId
获取从指定时间到当前时间段内有变化的物料 ( 关键词、创意 )id 。
输入信息: getChangedCpcMaterialIdRequest
属性名 |
类型 |
说明 |
限制 |
startTime |
datetime |
更新的起始时间 |
必填;不能早于 3 个月以前,例如现在是 9 月 10 日,则 startTime 最早只能到 7 月 1 日,即查询 7 、 8 、 9 三个月 |
ids |
Long |
指定的 id 数组 |
选填,为空表示获取全账户范围下的变化关键词和创意 id |
LevelType |
Integer |
指定的 id 数组为计划 id 还是推广组 id |
id 不为空时必填,
id 为空时无论 type 填何值,均默认为获取全账户范围下的变化
3 :表示指定 id 数组为计划 id
5 :表示指定 id 数组为推广组 id |
返回信息: getChangedCpcMaterialIdResponse
属性名 |
类型 |
说明 |
限制 |
endTime |
datetime |
当前时间点 |
- |
changedCpcIdeaIds |
ChangedCpcIdeaIdType [] |
变化的创意 id |
- |
changedCpcIds |
ChangedCpcIdType [] |
变化的关键词 id |
|
对 ChangedCpcIdeaIdType 对象解释如下:
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
1 : 新增计划
2 : 删除计划
3 : 计划属性有修改
4 : 新增推广组
5 : 删除推广组
6 : 推广组属性有修改
7 : 新增关键词
8 : 删除关键词
9 : 关键词有修改
10 : 新增创意
11 : 删除创意
12 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
cpcIdeaId |
Long |
变化创意 id |
|
对 ChangedCpcIdType 对象解释如下:
属性名 |
类型 |
说明 |
限制 |
operator |
Integer |
变化标识 |
1 : 新增计划
2 : 删除计划
3 : 计划属性有修改
4 : 新增推广组
5 : 删除推广组
6 : 推广组属性有修改
7 : 新增关键词
8 : 删除关键词
9 : 关键词有修改
10 : 新增创意
11 : 删除创意
12 : 创意属性有修改 |
cpcPlanId |
Long |
变化计划 id |
|
cpcGrpId |
Long |
变化推广组 id |
|
cpcId |
Long |
变化关键词 id |
|
getChangedId
获取从指定时间到当前时间段内有变化的计划 id 。
输入信息: getChangedCpcPlanIdRequest
属性名 |
类型 |
说明 |
限制 |
startTime |
datetime |
更新的起始时间 |
必填;不能早于 3 个月以前,例如现在是 9 月 10 日,则 startTime 最早只能到 7 月 1 日,即查询 7 、 8 、 9 三个月 |
返回信息: getChangedCpcPlanIdResponse
属性名 |
类型 |
说明 |
限制 |
endTime |
datetime |
当前时间点 |
- |
changedCpcPlanIds |
ChangedCpcPlanIdType [] |
变化的计划 id |
- |
changedCpcGrpIds |
ChangedCpcGrpIdType [] |
变化的推广组 id |
- |
changedCpcIdeaIds |
ChangedCpcIdeaIdType [] |
变化的创意 id |
- |
changedCpcIds |
ChangedCpcIdType [] |
变化的关键词 id |
- |