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

API参考  |  推广组服务

推广组服务 (CpcGrpService)

通过 CpcGrpService, 您可以管理您账户下的所有推广组。包括添加、删除、更新推广组。例如,您可以修改某个推广组的名称、状态,设置出价,暂定 / 取消暂停推广组等操作。

数据类型

cpcPlanGrpIdType :按计划 ID 分组的 CpcGrpId 集合

属性名 类型 说明 限制
cpcPlanId Long 推广计划 id -
cpcGrpIds Long[] 该计划 id 下的推广组 Id 集合 -

CpcPlanGrpType :按计划 ID 分组的 CpcGrp 对象

属性名 类型 说明 限制
cpcPlanId Long 推广计划 id -
CpcGrpType CpcGrpType[] 该计划 id 下的推广组对象集合 -

CpcGrpType 对象介绍:

属性名 类型 说明 限制
cpcGrpId Long 推广组 id -
cpcPlanId Long 推广计划 id -
cpcGrpName String 推广组名称 长度限制:最大 30 个字节, 1 个中文按 2 个字节计算
maxPrice Double 推广组最高出价 取值范围: (0,999.99]
negativeWords String[] 推广组否定关键词列表 否定词长度:最大 40 字节, 1 个中文按 2 个字节计算
NULL :无否定词限制
exactNegativeWords String[] 推广组精确否定关键词列表 否定词长度:最大 40 字节, 1 个中文按 2 个字节计算
NULL :无精确否定词限制
pause Boolean 暂停 / 取消暂停推广组 取值范围:
true - 暂停
false – 取消暂停
deepLink String Deeplink协议头+{landingpage}通配符({landingpage}选填,本推广组下的关键词URL/创意URL/高级样式URL将回插至{landingpage}与deeplink拼接指向APP落地页) 最长1024字节
status Integer 推广组状态 状态代码:
21------ 正常
22------ 暂停
23------ 推广计划暂停
opt Opt 扩展属性

接口描述

getAllCpcGrpId



方法说明:获取账户内的全部推广组 ID
输入信息: getAllCpcGrpIdRequest

返回信息: getAllCpcGrpIdResponse

属性名 类型 说明 限制
cpcPlanGrpIdTypes CpcPlanGrpIdType[] - -

CpcPlanGrpIdType 按计划 ID 分组的 CpcGrpId 集合

属性名 类型 说明 限制
cpcPlanId Long - 计划 Id -
cpcGrpIds Long[] 该计划 id 下的推广组 id 集合

getCpcGrpIdByCpcPlanId

方法说明 :根据指定的计划 id 获取推广推广组 id
输入信息: getCpcGrpIdByCpcPlanIdRequest

属性名 类型 说明 限制
cpcPlanIds Long[] 指定的计划 id 必填

返回信息: getCpgGrpIdByCpcPlanIdResponse

属性名 类型 说明
cpcPlanGrpIdTypes CpcPlanGrpIdType[]

getCpcGrpByCpcPlanId

方法说明 :根据指定的计划 id 获取推广推广组 ( 计划 id 可批量 )
输入信息: getCpcGrpByCpcPlanIdRequest

属性名 类型 说明 限制
cpcPlanIds Long[] 指定的计划 id 必填

返回信息: getCpcGrpByCpcPlanIdResponse

属性名 类型 说明
cpcPlanGrpTypes CpcPlanGrpType[] 按输入计划 ID 顺序返回推广组集合

getCpcGrpByCpcGrpId

方法说明:根据指定的推广组 id 获取推广组
输入信息: getCpcGrpByCpcGrpIdRequest

属性名 类型 说明 限制
cpcGrpIds Long[] 指定的推广组 id 数组 必填

返回信息: getCpcGrpByCpcGrpIdResponse

属性名 类型 说明
cpcGrpTypes CpcGrpType [] -

addCpcGrp



方法说明:新增推广组 ( 可批量 )

通过 addCpcGrp() 方法,您可以在您的账户下批量添加新的推广组。在调用该方法前,您首先需要构造 CpcGrpType 对象,并设置该对象的必要的属性。 ( 详情请见下面的 API 参考 ) 构造完成合适的 CpcGrpType 对象后,即可调用 addCpcGrp() 方法添加新的推广组到指定的推广计划中。 添加成功后,您可以获得新增推广组的 id ,此 id 全局唯一。您可以根据此 id 对推广组进行更新 / 删除操作。

输入信息: addCpcGrpRequest

属性名 类型 说明 限制
cpcGrpTypes CpcGrpType[] 新增推广组对象数组 参见下表

新增 CpcGrpType [] 时,限制如下:

属性名 限制
cpcGrpId 无效属性
cpcPlanId 必填
cpcGrpName 必填
maxPrice 必填
negativeWords 选填
默认为 NULL : 不设定否定词
exactNegativeWords 选填
默认为 NULL : 不设定精确否定词
pause 选填
默认为 false
status 无效属性

返回信息: addCpcGrpResponse

属性名 类型 说明 限制
cpcGrpTypes CpcGrpType [] 新增推广组对象数组 按照输入顺序返回全部 CpcGrpType [] 数组,添加失败的推广组对象的 cpcGrpId 属性值为 0.

updateCpcGrp



方法说明:更新推广推广组 ( 可批量 )

通过 updateCpcGrp() 方法,您可以更新除 cpcPlanId 、 cpcGrpId 、 status 之外的任何一个属性。在调用该方法前,您需要首先构造一个 CpcGrpType 对象。设置该对象的属性为您所需要的值,然后把该对象传递给 updateCpcGrp() 方法即可。如果您在一次请求中,不想更新某些属性 ( 如 cpcGrpName) ,可把这些属性置为 NULL 即可。服务器端会忽略属性值为 NULL 的更新。

输入信息: updateCpcGrpRequest

属性名 类型 说明 限制
cpcGrpTypes CpcGrpType [] 更新推广组对象数组 参见下表

更新 CpcGrpType[] 时,限制如下:

属性名 限制
cpcGrpId 必填
cpcPlanId 无效
cpcGrpName 选填
默认为 NULL :不更新该属性
maxPrice 选填
默认为 NULL :不更新该属性
negativeWords 选填
默认为 NULL : 不修改该属性
值为 $( 数组仅 1 个元素 , 且为 $) :取消否定词
exactNegativeWords 选填
默认为 NULL : 不修改该属性
值为 $( 数组仅 1 个元素 , 且为 $) :取消精确否定词
pause 选填
默认为 NULL :不更新该属性
deepLink 选填
Deeplink协议头+{landingpage}通配符(通配符选填),最长1024字节
status 无效属性

返回信息: addCpcGrpResponse

属性名 类型 说明 限制
cpcGrpTypes CpcGrpType [] 更新推广组对象数组 按照输入参数顺序返回 CpcGrpType [] 数组,更新失败的推广组不返回 .

deleteCpcGrp


方法说明:删除指定的推广组 ( 可批量 )

通过 deleteCpcGrp() 方法,您可以删除您账户下的一个或者多个推广组。推广组被删除后,其名下的关键词、创意数据均会被同时删除。

输入信息: deleteCpcGrpRequest

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

返回信息: deleteCpcGrpResponse