API参考 | 创意服务
创意服务 (CpcIdeaService)
通过 CpcIdeaService ,您可以管理您账户下的所有推广创意。包括添加、删除、更新推广创意。例如,您可以修改某个创意的标题、描述、展现 / 点击链接,设置创意状态等操作。
数据类型
CpcGrpIdeaIdType
按推广组 ID 分组的创意 Id 集合
属性名 |
类型 |
说明 |
限制 |
cpcGrpId |
Long |
推广组 id |
- |
cpcIdeaIds |
Long |
该推广组 id 下的创意 id 集合 |
- |
CpcGrpIdeaType
按推广组 ID 分组的创意对象
属性名 |
类型 |
说明 |
限制 |
cpcGrpId |
Long |
推广组 id |
- |
cpcIdeaTypes |
CpcIdeaType[] |
该推广组 id 下的创意对象集合 |
- |
cpcIdeaType 对象数据结构如下表:
属性名 |
类型 |
说明 |
限制 |
cpcIdeaId |
Long |
创意 id |
- |
cpcGrpId |
Long |
推广组 id |
- |
title |
String |
创意标题 |
长度限制:最大 50 个字节,最小 9 字节, 1 个中文按 2 个字节计算;
通配符限制:标题中最多可以出现4个通配符,其中关键词通配符不超过3个,地域符不超过1个,节日符不超过1个,倒数符不超过1个,且关键词通配符不可连续出现;
|
description1 |
String |
创意描述第一行 |
长度限制:最大 80 个字节,最小 9 字节, 1 个中文按 2 个字节计算;
通配符限制:描述第一行中最多可以出现3个通配符,其中关键词通配符不可超过2个,地域符不超过1个,节日符不超过1个,且关键词通配符不可连续出现; |
description2 |
String |
创意描述第二行 |
长度限制:最大 80 个字节, 1 个中文按 2 个字节计算;
通配符限制:描述第二行中最多可以出现3个通配符,其中关键词通配符不可超过2个,地域符不超过1个,节日符不超过1个,且关键词通配符不可连续出现;
通配符不计入; |
visitUrl |
String |
访问 url |
长度限制:不得超过 1024 个字符;域名需与账户网站域名相同 |
showUrl |
String |
显示 url |
长度限制:不得超过 36 个字符;域名需与账户网站域名相同 |
mobileVisitUrl |
String |
移动访问 url |
长度限制:不得超过1024个字符;域名需与账户网站域名相同 |
mobileShowUrl |
String |
移动显示 url |
长度限制:不得超过 36 个字符;域名需与账户网站域名相同 |
pause |
Boolean |
暂停 / 取消暂停创意 |
取值范围 :
true - 暂停
false – 取消暂停 |
status |
Integer |
创意状态 |
状态码: 41 (审核未通过)
42 (暂停)
43 (审核中)
44 (正常)
45 (移动显示URL无效) |
接口描述
getCpcIdeaIdByCpcGrpId
方法说明:根据指定的推广组 id 获取创意 id
输入信息: getCpcIdeaIdByCpcGrpIdRequest
属性名 |
类型 |
说明 |
限制 |
cpcGrpIds |
Long[] |
指定的推广组 id |
必填 |
getTemp |
Integer |
是否查询修改未生效列表 |
选填,默认为 0
0 :只查询生效创意列表(不包括修改未生效列表)
1 :只查询修改未生效列表
想要获得创意的全集,需要调用该方法两次 , 分别为 getTemp=0 和 getTemp=1 |
返回信息: getCpcIdeaIdByCpcGrpIdResponse
属性名 |
类型 |
说明 |
cpcGrpIdeaIdTypes |
CpcGrpIdeaIdType [] |
按输入推广组 ID 顺序返回创意 ID 集合 |
getCpcIdeaByCpcGrpId
方法说明
根据指定的推广组 id 获取创意 ( 推广组 id 可批量 )
输入信息: getCpcIdeaByCpcGrpIdRequest
属性名 |
类型 |
说明 |
限制 |
cpcGrpIds |
Long[] |
指定的推广组 id |
必填 |
getTemp |
Integer |
是否查询修改未生效列表 |
选填,默认为 0
0 :只查询生效创意列表(不包括修改未生效列表)
1 :只查询修改未生效列表
想要获得创意的全集,需要调用该方法两次 , 分别为 getTemp=0 和 getTemp=1 |
返回信息: getCpcIdeaByCpcGrpIdResponse
属性名 |
类型 |
说明 |
cpcGrpIdeaTypes |
CpcGrpIdeaType[] |
按输入推广组 ID 顺序返回创意集合 |
getCpcIdeaByCpcIdeaId
方法说明:根据指定的创意 id 获取创意
输入信息: getCpcIdeaByCpcIdeaIdRequest
属性名 |
类型 |
说明 |
限制 |
cpcIdeaIds |
Long[] |
指定的创意 id |
必填 |
getTemp |
Integer |
是否查询修改未生效列表 |
选填,默认为 0
0 :只查询生效创意列表(不包括修改未生效列表)
1 :只查询修改未生效列表
想要获得创意的全集,需要调用该方法两次 , 分别为 getTemp=0 和 getTemp=1 |
返回信息: getCpcIdeaByCpcIdeaIdResponse
属性名 |
类型 |
说明 |
cpcIdeaTypes |
CpcIdeaType [] |
- |
addCpcIdea
方法说明:通过 addCpcIdea() 方法,您可以在您的推广组下增加创意。创意使用 CpcIdeaType 类型表示。在新增创意前,您首先需要创建 CpcIdeaType 类型的对象,并设置该对象必须的属性。 ( 详情请见下面的 API 参考 ) 构造完成合适的 CpcIdeaType 对象后,即可调用 addCpcIdea() 方法添加该创意到指定的推广组中。添加成功后,您可以获得新增创意的 id ,此 id 全局唯一。您可以根据此 id 对创意进行更新 / 删除操作。该接口支持批量增加创意,您可在一次请求中批量添加多个创意。
输入参数: addCpcIdeaRequest
属性名 |
类型 |
说明 |
限制 |
cpcIdeaTypes |
CpcIdeaType [] |
新增创意对象数组 |
参见下表 |
新增 CpcIdeaType[] 的限制如下:
属性名 |
限制 |
cpcIdeaId |
无效属性 |
cpcGrpId |
必填 |
title |
必填 |
description1 |
必填 |
description2 |
必填 |
visitUrl |
必填 |
showUrl |
选填
默认值为 visitUrl 的域名 |
mobileVisitUrl |
选填 |
mobileShowUrl |
选填 |
pause |
选填
默认为 false |
status |
无效属性 |
返回信息: addCpcIdeaResponse
属性名 |
类型 |
说明 |
限制 |
cpcIdeaTypes |
CpcIdeaType [] |
新增创意对象数组 |
按输入顺序返回全部 CpcIdeaType [] 数组,添加失败的创意属性 cpcIdeaId 值为 0 。 |
updateCpcIdea
注:此方法在更新的时候是一个整体,所有属性必须全部填写,如果某一属性不想更新,需将其原貌输入。
方法说明:通过 updateCpcIdea() 方法,您可以更新创意的属性。在更新之前需要创建 CpcIdeaType 类型的对象,设定该对象的 cpcIdeaId 值和其它所需要更新的属性,设置完成后即可调用 updateCpcIdea() 进行创意属性的更新。
输入参数: updateCpcIdeaRequest
属性名 |
类型 |
说明 |
限制 |
cpcIdeaTypes |
CpcIdeaType[] |
更新创意对象数组 |
参见下表 |
更新 CpcIdeaType[] 的限制如下:
属性名 |
限制 |
cpcIdeaId |
必填 |
cpcGrpId |
无效属性 |
title |
选填,默认值为 NULL :不更新该属性 |
description1 |
选填,默认值为 NULL :不更新该属性 |
description2 |
选填,默认值为 NULL :不更新该属性 |
visitUrl |
选填,默认值为 NULL :不更新该属性 |
showUrl |
选填
默认值为 NULL :不更新该属性 |
mobileVisitUrl |
选填
默认值为NULL:不更新该属性 |
moblieShowUrl |
选填
默认值为NULL:不更新该属性 |
pause |
选填
默认值为 NULL :不更新该属性 |
status |
无效属性 |
返回信息: updateCpcIdeaResponse
属性名 |
类型 |
说明 |
限制 |
cpcIdeaTypes |
CpcIdeaType[] |
更新创意对象数组 |
按输入顺序返回正确更新的 CpcIdeaType[] 数组,更新失败的创意对象不返回。 |
deleteCpcIdea
方法说明:通过 deleteCpcIdea() 方法,以创意 id 为参数,您可以删除指定的一个或多个创意
输入信息: deleteCpcIdeaRequest
属性名 |
类型 |
说明 |
限制 |
cpcIdeaIds |
Long |
- |
必填 |
temp |
Integer |
是否删除修改未生效列表 |
选填,默认为 0
0 :只删除生效创意列表
1 :只删除修改未生效列表
|
返回信息: deleteCpcIdeaResponse
无