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

API参考  |  附加创意服务

附加创意服务 (CpcExtraIdeaService)

通过CpcExtraIdeaService,您可以管理您账户下的附加创意,目前仅支持计算机皇冠样式。例如,您可以修改某个计算机皇冠样式的子链,图片,设置皇冠样式的状态等操作;(移动皇冠样式物料已迁移至创意组件(子链&单图)中,请及时对接创意组件接口服务)

数据类型

CpcGrpExIdeaType
按推广组 ID 分组的附加创意集合

属性名 类型 说明 限制
cpcGrpId Long 推广组 id -
cpcExIdeaTypes CpcExIdeaType[] 该推广组下的附加创意集合 -

CpcExIdeaType对象数据结构如下表:

属性名 类型 说明 限制
cpcExtraIdeaId Long 附加创意 id -
cpcGrpId Long 推广组 id -
cpcExtraIdeaDeviceType Integer 设备类型 1:计算机
exIdeaPic ExIdeaPicType 图片 一个附加创意可以有图片,也可以没有图片
exIdeaSubChains ExIdeaSubChainType[] 子链集合 限制:计算机最多5条,最少4条
pause Integer 暂停状态 0:非暂停
1:暂停
subchainCheckstatus Integer 子链审核状态 状态码: 51(审核未通过)
52(审核中)
53 (正常)
subChainModiCheckStatus Integer 影子子链审核状态 状态码:51(审核未通过)
52(审核中)
picCheckStatus Integer 图片审核状态 状态码: 61 (审核未通过)
62 (审核中)
63 (正常)
picModiCheckStatus Integer 影子图片审核状态 状态码:61 (审核未通过)
62 (审核中)
opt Opt 扩展字段

ExIdeaSubChainType对象数据结构如下表:

属性名 类型 说明 限制
cpcExtraIdeaId Long 附加创意 id -
exIdeaSubChainId Long 附加创意 id -
name String 子链名称 长度限制:计算机子链name不能小于6字节,超过16字节;计算机附加创意所有子链name长度不能超过42字节
url String 子链url 长度限制:不得超过1024个字符;域名需与账户网站域名相同
rank Integer 子链排序 计算机附加创意rank范围为1~5,必填rank为1,2,3,4
opt Opt 扩展字段 -

ExIdeaPicType对象数据结构如下表:

属性名 类型 说明 限制
cpcExtraIdeaId Long 附加创意 id -
exIdeaPicId Long 附加创意图片 id -
picUploadUrl String 图片上传cdn地址 如果获取的是审核通过的图片,则picUploadUrl是用户可访问的cdn地址,如果获取的不是审核通过的图片,则picUploadUrl是无效地址
picVisitUrl String 图片访问url 长度限制:不得超过1024个字符;域名需与账户网站域名相同
picBytes byte[] 图片二进制文件 图片不能超过220k;图片格式必须为jpg,jpeg或者png;计算机图片大小为128像素*128像素
opt Opt 扩展字段 -

接口描述

getExtraIdeaByCpcGrpId

方法说明:根据指定的推广组 id 获取附加创意;
输入信息:GetExtraIdeaByCpcGrpIdRequest

属性名 类型 说明 限制
cpcGrpIds Long[] 指定的推广组 id 必填
getTemp Integer 是否查询修改未生效列表 选填,默认为 0
0 :只查询生效附加创意列表(不包括修改未生效列表)
1 :只查询修改未生效列表
想要获得附加创意的全集,需要调用该方法两次 , 分别为 getTemp=0 和 getTemp=1

返回信息:GetExtraIdeaByCpcGrpIdResponse

属性名 类型 说明
cpcGrpExIdeas CpcGrpExIdea[] 按输入推广组 ID 顺序返回附加创意集合

getExtraIdeaByExIdeaId

方法说明:根据指定的附加创意 id 获取附加创意;
输入信息:GetExtraIdeaByExIdeaIdRequest

属性名 类型 说明 限制
exIdeaIds Long[] 指定的附加创意 id 必填
getTemp Integer 是否查询修改未生效列表 选填,默认为 0
0 :只查询生效附加创意列表(不包括修改未生效列表)
1 :只查询修改未生效列表
想要获得附加创意的全集,需要调用该方法两次 , 分别为getTemp=0 和getTemp=1

返回信息:GetExtraIdeaByExIdeaIdResponse

属性名 类型 说明
cpcExIdeaTypes CpcExIdeaType[] -

addExtraIdea


方法说明:通过 addExtraIdea() 方法,您可以在您的推广组下增加附加创意。CpcExIdeaType类型表示附加创意。在新增附加创意前,需要创建CpcExIdeaType类型的对象,并设置该对象必须的属性。 ( 详情请见下面的 API 参考 ) 构造完成合适的 CpcExIdeaType 对象后,即可调用addExtraIdea() 方法添加该附加创意到指定的推广组中。添加成功后,您可以获得新增附加创意的 id ,此 id 全局唯一。您可以根据此 id 对附加创意进行更新 / 删除操作。该接口支持批量增加附加创意,您可在一次请求中批量添加多个附加创意。
输入参数:AddExtraIdeaRequest

属性名 类型 说明 限制
cpcExIdeaTypes CpcExIdeaType [] 新增附加创意对象数组 参见下表

CpcExIdeaType [] 的限制如下:

属性名 限制
cpcExtraIdeaId 无效属性
cpcGrpId 必填
pause 选填,默认为0
cpcExtraIdeaDeviceType 必填,默认为1
exIdeaPic 选填
exIdeaSubChains 设备类型为1时必填
设备为2时,和图片任填其一即可
subchainCheckstatus 无效属性
subChainModiCheckStatus 无效属性
picCheckStatus 无效属性
picModiCheckStatus 无效属性

ExIdeaPicType[] 的限制如下:

属性名 限制
exIdeaPicId 无效属性
cpcExtraIdeaId 无效属性
picUploadUrl 无效属性
picVisitUrl 选填,默认为nul,但如果填了picBytes,则为必填
picBytes 选填,默认为nul,但如果填了picVisitUrl,则为必填

ExIdeaSubChainType[] 的限制如下:

属性名 限制
cpcExtraIdeaId 无效属性
exIdeaSubChainId 无效属性
name 必填
url 必填
rank 必填

返回信息:AddExtraIdeaResponse

属性名 类型 说明 限制
cpcExIdeaTypes CpcExIdeaType[] 新增附加创意对象数组 按输入顺序返回全部 CpcExIdeaType[] 数组,

updateExtraIdea


注:此方法在更新的时候是一个整体,所有属性必须全部填写,如果某一属性不想更新,需将其置为null。
方法说明:通过 updateExtraIdea() 方法,您可以更新附加创意的属性。在更新之前需要创建 CpcExIdeaType 类型的对象,设定该对象的cpcExtraIdeaId 值和其它所需要更新的属性,设置完成后即可调用updateExtraIdea() 进行附加创意属性的更新。
输入参数:UpdateExtraIdeaRequest

属性名 类型 说明 限制
cpcIdeaTypes CpcExIdeaType[] 更新附加创意对象数组 参见下表

更新 CpcExtraIdeaType[] 的限制如下:

属性名 限制
cpcExtraIdeaId 必填
cpcGrpId 无效属性
pause 选填,默认值为 NULL :不更新该属性
cpcExtraIdeaDeviceType 无效属性
exIdeaSubChains 选填,默认值为 NULL :不更新该属性
exIdeaPic 选填,默认值为 NULL :不更新该属性
picCheckStatus 无效属性
subChainModiCheckStatus 无效属性
picCheckStatus 无效属性
subChainModiCheckStatus 无效属性

更新 ExIdeaPicType[] 的限制如下:

属性名 限制
cpcExtraIdeaId 无效属性
exIdeaPicId 无效属性
picUploadUrl 无效属性
picVisitUrl 选填,默认值为 NULL :不更新该属性
picBytes 选填,默认值为 NULL :不更新该属性

更新 ExIdeaSubChainType[] 的限制如下:

属性名 限制
cpcExtraIdeaId 无效属性
exIdeaSubChainId 无效属性
name 选填,默认值为 NULL :不更新该属性
url 选填,默认值为 NULL :不更新该属性
rank 必填

返回信息:UpdateExtraIdeaResponse

属性名 类型 说明 限制
cpcExIdeaTypes CpcExIdeaType[] 更新附加创意对象数组 按输入顺序返回正确更新的CpcExIdeaType[] 数组,更新失败的附加创意对象不返回。

deleteExtraIdea


方法说明:通过 deleteExtraIdea() 方法,以附加创意 id 为参数,您可以删除指定的一个或多个附加创意。
输入信息: DeleteExtraIdeaRequest

属性名 类型 说明 限制
exIdeaIds Long[] - 必填

返回信息:DeleteExtraIdeaResponse