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

关键词服务  |  关键词服务

关键词服务 (CpcService)

通过 CpcService ,您可以管理您账户下的所有推广关键词。包括添加、删除、更新关键词。例如,您可以修改关键词的出价、状态,设置匹配类型、设置访问链接等操作。

数据类型

CpcGrpCpcIdType :按推广组 ID 分组的关键词 Id 集合

属性名 类型 说明 限制
cpcGrpId Long 推广组 id -
cpcIds Long[] 该推广组 id 下的关键词 id 集合 -

CpcGrpCpcType :按推广组 ID 分组的关键词对象

属性名 类型 说明 限制
cpcGrpId Long 推广组 id -
cpcTypes CpcType[] 该推广组 id 下的关键词对象集合 -

CpcType 类型说明:

属性名 类型 说明 限制
cpcId long 关键词 id -
cpcGrpId long 推广组 id -
cpc string 关键词字面 长度限制:最大 40 个字节, 1 个中文按 2 个字节计算
price double 关键词出价 取值范围: (0,999.99]
matchType int 匹配方式 取值范围:
0 – 精确匹配
1 – 广泛匹配
2 - 短语匹配(核心包含)
4 - 短语匹配(精确包含)
5 - 短语匹配(同义包含)
pause boolean 暂停 / 取消暂停关键词 取值范围 :
true - 暂停
false – 取消暂停
status int 关键词状态 状态码:
31 (审核未通过)
32 ( 暂停 )
33 (审核中)
35 (正常)
37 (低于起价)
opt Opt 扩展字段 在optDouble中有key值CpcMobileQuality,代表移动关键词质量度
含义: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星
mobileVisitUrl String 关键词移动访问URL 域名需和账户网站URL域名相同长度限制:最大1024字

接口描述

getCpcIdByCpcGrpId



方法说明:根据推广组 id 获取该推广组下所有的关键词数据;由于计算关键词状态需要一些时间,所以有可能造成返回的状态信息延迟,请耐心等待

属性名 类型 说明 限制
cpcGrpIds Long 指定的推广组 id 必填
getTemp Integer 是否查询修改未生效列表 无效属性

返回信息: getCpcIdByCpcGrpIdResponse

属性名 类型 说明
cpcGrpCpcIdTypes CpcGrpCpcIdType[] 按输入推广组 ID 顺序返回关键词 ID 集合

getCpcByCpcGrpId

方法说明:根据指定的推广组 id 获取关键词 ( 推广组 id 可批量 )
输入信息: getCpcByCpcGrpIdRequest

属性名 类型 说明 限制
cpcGrpIds Long[] 指定的推广组 id 必填
getTemp Integer 是否查询修改未生效列表 无效属性

返回信息: getCpcByCpcGrpIdResponse

属性名 类型 说明
cpcGrpCpcTypes CpcGrpCpcType[] 按输入推广组 ID 顺序返回关键词集合

getCpcByCpcId

方法说明:根据指定的关键词 id 获取关键词
输入信息: getCpcByCpcIdRequest

属性名 类型 说明 限制
cpcIds Long[] 指定的关键词 id 必填
getTemp Integer 是否查询修改未生效列表 无效属性

返回信息: getCpcByCpcIdResponse

属性名 类型 说明
cpcTypes CpcType [] -

addCpc

方法说明:通过 addCpc() 方法,您可以在您的推广组下增加新的关键词。关键词使用 CpcType 类型表示。在新增关键词前,您首先需要创建 CpcType 类型的对象,并设置该对象必须的属性。 ( 详情请见下面的 API 参考 ) 构造完成合适的 CpcType 对象后,即可调用 addCpc() 方法添加该关键词到指定的推广组中。添加成功后,您可以获得新增关键词的 id ,此 id 全局唯一。您可以根据此 id 对关键词进行更新 / 删除操作。 该接口支持批量增加关键词,您可在一次请求中批量添加多个关键词。由于计算关键词状态需要一些时间,所以有可能造成返回的状态信息延迟,请耐心等待。
输入参数: addCpcRequest

属性名 类型 说明 限制
cpcTypes CpcType [] 新增关键词对象数组 参见下表

新增 CpcType [] 的限制如下:

属性名 限制
cpcId 无效属性
cpc 必填
cpcGrpId 必填
price 选填
默认值为该关键词所属推广组出价
matchType 必填
pause 选填
默认值为 false
status 无效属性
isShow 能否展现( 1 :可展现; 0 :不可展现; 2 :部分展现)
mobileVisitUrl 选填

新增的关键词质量度默认的是2.5星。

返回信息: addCpcResponse

属性名 类型 说明 限制
cpcTypes CpcType[] 新增关键词对象数组 按输入顺序返回全部 CpcType[] 数组,添加失败的关键词 cpcid 值为 0 。

updateCpc


方法说明:通过 updateCpc() 方法,您可以更新关键词的属性。在更新之前需要创建 CpcType 类型的对象,设定该对象的 cpcId 值和其它所需要更新的属性, 设置完成后即可调用 updateCpc() 进行关键词属性的更新。由于计算关键词状态需要一些时间,所以有可能造成返回的状态信息延迟,请耐心等待。
输入参数: updateCpcRequest

属性名 类型 说明 限制
cpcTypes CpcType[] 新增关键词对象数组 参见下表

更新 CpcType[] 的限制如下:

属性名 限制
cpcId 必填
cpc 无效属性
cpcGrpId 无效属性
price 选填
默认值为 NULL :不更新该属性
0 :取消该关键词出价,此时采用所属推广组出价
matchType 选填
默认值为 NULL :不更新该属性
pause 选填
默认值为 NULL :不更新该属性
status 无效属性
mobileVisitUrl 选填
默认值为NULL:不更新该属性

返回信息: updateCpcResponse

属性名 类型 说明 限制
cpcTypes CpcType[] 更新关键词对象数组 按输入顺序返回成功的 CpcType[] 数组,更新失败的关键词对象不返回。

deleteCpc

方法说明:通过 deleteCpc() 方法,以关键词 id 为参数,您可以删除指定的一个或多个关键词
输入信息: deleteCpcRequest

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

返回信息: deleteCpcResponse