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

API参考  |  关键词推荐服务

关键词推荐服务 (KR Service)

KR Service 即关键词推荐服务,通过调用该服务,可以输入一个查询词,得到搜狗返回给您的推荐结果词。提供了2种调用方式:
1. 同步接口,一次调用只允许输入1个查询词: getKRbySeedWords
2. 异步接口,一次调用最多允许输入1个查询词: getKRFileId
为了保证对外服务的性能和控制系统访问压力,搜狗搜索推广API 对 KRService 的调用进行了限制。

数据类型

FilterType: 请求关键词推荐时的设置条件

属性名 类型 说明 限制
exclusiveWords string[] 返回结果字面中不能包含该词 选填,默认为null
数组最大元素限制:5个
不同元素之间以逗号分割
inclusiveWords string[] 返回结果字面中能包含该词 选填,默认为null
数组最大元素限制:5个
不同元素之间以逗号分割
flags Int[] 数组 推荐理由 取值范围[0,12],不同位标识对应不同理由 ,默认为0
0、全部 1、周末好词 2、夜间好词
3、黑马词 4、移动黑马 5、价格词
6、品牌词 7、时间词 8、长尾词
9、地域词 10、咨询词 11、促销词
12、口碑词
deviceType Int 设备类型 选填,默认为0
0:全部
1:计算机
2:移动
pv Int 限定只返回搜索量等于低的词 选填,默认为全部
1:低
2:中
3:高
Int 限定只返回搜索量等于中的词
Int 限定只返回搜索量等于高的词
competition Int 限定只返回竞争激烈程度低的词 选填,默认为全部
1:低
2:中
3:高
Int 限定只返回竞争激烈程度中的词
Int 限定只返回竞争激烈程度高的词
maxNum Int 返回结果的最大可能条数(实际返回条数一般小于等于maxNum)。返回结果是按照相关性排序的,maxNum越大,越往后返回的结果,相关性越降低。 选填,默认350
取值范围:[1,3000]

KRResultType: 关键词推荐的返回词对象

属性名 类型 说明 限制
word string 返回推荐词字面 最大长度无限制
broadPV Int 返回网民的搜索量 取值范围[1,3]
1:低
2:中
3:高
competition Int 该关键词的客户竞争激烈程度 取值范围[1,3]
1:低
2:中
3:高
flags Int[] 数组 推荐理由 取值范围[1,12],不同位标识对应不同理由,一个推荐词可能对于多个推荐理由
1、周末好词 2、夜间好词
3、黑马词 4、移动黑马 5、价格词
6、品牌词 7、时间词 8、长尾词
9、地域词 10、咨询词 11、促销词
12、口碑词
cpcPlanName(量身推荐时有) string 推荐计划 最大长度36字节
cpcGrpName(量身推荐时有) string 推荐组 最大长度30字节

SeedWordKRResultType: 以词推词返回结果

属性名 类型 说明 限制
seedWord string 返回种子词 -
krResultTypes KRResultType[] 关键词推荐的返回词对象 -

接口描述

getKRBySeedWords

方法说明:根据输入的查询词返回推荐词,一次调用仅允许请求1个查询词
输入信息: getKRBySeedWordsRequest

属性名 类型 说明 限制
seedWords String[] 请求的查询词 必填
不同元素之间以逗号分割
数组最大元素限制:1个
每个词长度不超过40字节
filterType FilterType 请求查询词的设置条件 选填,不填则按默认选项进行查询

返回信息: getKRBySeedWordsResponse

属性名 类型 说明
krResults SeedWordKRResultType 返回的词对象数组

getKRFileId

方法说明:异步接口,根据输入的查询词返回推荐词,一次调用允许请求1个查询词
输入信息: GetKRFileIdRequest

属性名 类型 说明 限制
seedWords String[] 请求的查询词 必填
数组元素最大个数:1
每个词长度不超过40字节
filterType FilterType 请求查询词的设置条件 选填,不填则按默认选项进行查询

返回信息: GetKRFileIdResponse

属性名 类型 说明
krFileId string 关键词推荐处理任务id

getKRFileStatus

方法说明:查询关键词推荐结果文件是否生成
输入信息: getKRFileStatusRequest

属性名 类型 说明 限制
krFileId string 关键词推荐处理任务id 必填

返回信息: getKRFileStatusResponse

属性名 类型 说明 限制
isGenerated Int 文件任务状态检查 0:未生成
1:已生成
-1:生成过程出现异常

getKRFilePath

方法说明:获取关键词推荐结果文件的下载路径
输入信息: getKRFilePathRequest

属性名 类型 说明 限制
krFileId string 关键词推荐处理任务id 必填

返回信息: getKRFilePathResponse

属性名 类型 说明
krFilePath string 关键词推荐结果文件下载路径

getKRCustom

方法说明:量身推荐接口:根据用户的账户和业务内容,返回对应的为用户量身定制的推荐词(以下简称为量身推荐词)。 对于userid,计划id,组id这三个层级的id,每个层级的id都有自己专属的量身推荐词。
输入信息: getKRCustomRequest

属性名 类型 说明 限制
id long 输入的计划/组id,将根据输入id返回对应的量身推荐词 选填,默认为null
为null时返回userid对应的专属量身推荐词
type Int 指定输入id的类型 选填
2:计划id
3:组id
输入id为null时,type可在2,3之间任填
filterType FilterType 量身推荐词的查询条件 选填

返回信息: getKRCustomResponse

属性名 类型 说明
krResults KRResultType[] 量身推荐词对象数组