获取关键词推荐结果

开发环境

POST

/v1.3/keyword_recommend/get

请求参数

标有*的参数为必填项

名称	类型	描述
site_sets*	enum[]	拓词版位集，[枚举详情] 数组最小长度 1，最大长度 2 枚举列表：{ SITE_SET_QBSEARCH, SITE_SET_WECHAT_SEARCH }
recommend_category*	enum	推荐类别，[枚举详情] 枚举列表：{ RECOMMEND_BY_INDUSTRY, RECOMMEND_BY_WORD }
account_id*	integer	推广帐号 id，有操作权限的广告主账号 id
system_industry_id*	integer	系统行业 id，可通过账户管理->广告账号->查询腾讯广告广告主信息接口来获取具体值，[系统行业 id]
query_word	string[]	种子词集合，当拓词类型是 RECOMMEND_BY_WORD 时，必填数组最小长度 1，最大长度 10 字段长度最大 40 字节
business_point_id	string	业务点 id，当拓词类型是 RECOMMEND_BY_INDUSTRY 时必填，具体值可通过接口获取：[查询行业业务点信息]。只支持三级、四级、五级行业业务点拓词数据查询
adgroup_id	int64	广告组 id，当选择过滤广告内已购词时，必填
campaign_id	int64	推广计划 id，当选择过滤广告内已购词时，必填
include_word	string[]	包含词数组最小长度 1，最大长度 10 字段长度最大 40 字节
exclude_word	string[]	排除词数组最小长度 1，最大长度 100 字段长度最大 40 字节
filter_ad_word	boolean	是否过滤广告词可选值：{ true, false }
filter_account_word	boolean	是否过滤账户下面的词可选值：{ true, false }
recommend_reasons	enum[]	推荐理由，[枚举详情] 数组最小长度 1，最大长度 4 枚举列表：{ DARK_HORSE_WORD, SAME_TRADE_BUY_WORD, HIGH_CLICK_WORD, BLUE_OCEAN_WORD }
province	array	省份编码，具体值参照附录中的 [地域信息]
city	array	市编码，具体值参照附录中的 [地域信息]
order_by	struct[]	排序字段结构数组最小长度 0，最大长度 1
sort_field*	string	排序字段可选值：{ month_query_count, click_count, price, total_accts }
sort_type*	enum	排序方式，[枚举详情] 枚举列表：{ ASCENDING, DESCENDING }

使用说明
1.
支持以词拓词、行业拓词两种方式。
2.
行业拓词只支持查询三级、四级、五级行业业务点拓词数据。

应答字段

名称	类型	描述
total_num	integer	词总数
recommend_word_list	struct[]	推荐词列表信息
word	string	推荐词
month_query_count	integer	月均搜索量
click_count	integer	点击量
price	float	指导价单位：元
total_accts	integer	竞争程度
recommend_reason	string	推荐理由

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.3/keyword_recommend/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--data-urlencode 'site_sets=[]' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'system_industry_id=21474840687' \
--data-urlencode 'query_word=[]' \
--data-urlencode 'adgroup_id=<ADGROUP_ID>' \
--data-urlencode 'campaign_id=<CAMPAIGN_ID>' \
--data-urlencode 'include_word=[]' \
--data-urlencode 'exclude_word=[]' \
--data-urlencode 'recommend_reasons=[]' \
--data-urlencode 'province=[]' \
--data-urlencode 'city=[]' \
--data-urlencode 'order_by=[]'

响应示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "recommend_word_list": []
    }
}

请求参数

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

Body 参数application/x-www-form-urlencoded

site_sets

string

必需

拓词版位集，[枚举详情]
数组最小长度 1，最大长度 2
枚举列表：{ SITE_SET_QBSEARCH, SITE_SET_WECHAT_SEARCH }

示例值:

[]

account_id

integer

必需

推广帐号 id，有操作权限的广告主账号 id

示例值:

<ACCOUNT_ID>

system_industry_id

integer

必需

系统行业 id，可通过账户管理->广告账号->查询腾讯广告广告主信息接口来获取具体值，[系统行业 id]

示例值:

21474840687

query_word

string

可选

种子词集合，当拓词类型是 RECOMMEND_BY_WORD 时，必填
数组最小长度 1，最大长度 10
字段长度最大 40 字节

示例值:

[]

adgroup_id

integer

可选

广告组 id，当选择过滤广告内已购词时，必填

示例值:

<ADGROUP_ID>

campaign_id

integer

可选

推广计划 id，当选择过滤广告内已购词时，必填

示例值:

<CAMPAIGN_ID>

include_word

string

可选

包含词
数组最小长度 1，最大长度 10
字段长度最大 40 字节

示例值:

[]

exclude_word

string

可选

排除词
数组最小长度 1，最大长度 100
字段长度最大 40 字节

示例值:

[]

recommend_reasons

string

可选

推荐理由，[枚举详情]
数组最小长度 1，最大长度 4
枚举列表：{ DARK_HORSE_WORD, SAME_TRADE_BUY_WORD, HIGH_CLICK_WORD, BLUE_OCEAN_WORD }

示例值:

[]

province

string

可选

省份编码，具体值参照附录中的 [地域信息]

示例值:

[]

city

string

可选

市编码，具体值参照附录中的 [地域信息]

示例值:

[]

order_by

string

可选

排序字段结构
数组最小长度 0，最大长度 1

示例值:

[]

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

recommend_word_list

array[string]

推荐词列表信息

必需

修改于 2023-11-09 03:06:32

查询关键词流量接口

查询行业业务点信息

获取关键词推荐结果

请求参数#

应答字段#

请求参数

返回响应

请求参数

应答字段