Skip to main content
POST
设置“网站关键词”任务
此端点将提供与指定网站相关的关键词列表,以及这些关键词上个月的搜索量、最多过去 24 个月的搜索量趋势(用于估算搜索量变化)、当前每次点击费用和付费搜索竞争程度。最多返回 3000. 个关键词。

示例

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
target
string
必填

域名或 URL,必填字段;要扫描以查找可能关键词的网页 URL 或域名

location_name
string
必填

搜索引擎位置的完整名称。如果未指定 location_code 或 location_coordinate,则此字段为必填字段。如果使用此字段,则无需指定 location_code 或 location_coordinate。您可以单独请求 https://api.dataforseo.com/v3/keywords_data/bing/locations,获取搜索引擎的可用位置及其 location_name 列表。示例:London,England,United Kingdom

location_code
integer
必填

搜索引擎位置代码。如果未指定 location_name 或 location_coordinate,则为必填字段。如果使用此字段,则无需指定 location_name 或 location_coordinate。可通过向 https://api.dataforseo.com/v3/keywords_data/bing/locations 单独发送请求,获取搜索引擎的可用位置及其 location_code。示例:2840

location_coordinate
string
必填

位置的 GPS 坐标;如果未指定 location_name 或 location_code,则为必填字段;如果使用此字段,则无需指定 location_name 或 location_code;location_coordinate 参数应采用“latitude,longitude”格式;将提供指定坐标所属国家/地区的数据;示例:52.6178549,-155.352142

language_name
string
必填

搜索引擎语言的全名。如果未指定 language_code,则此字段为必填字段。如果使用此字段,则无需指定 language_code。支持的语言:英语、法语、德语

language_code
string
必填

搜索引擎语言代码。如果未指定 language_name,则此字段为必填字段;如果使用此字段,则无需指定 language_name。支持的语言:en、fr、de

keywords_negative
string[]

否定关键词数组,可选字段;这些关键词将在结果数组中被忽略;最多可以指定 200 个要从结果中排除的词;指定的关键词将转换为小写格式

device
string

设备类型,可选字段。如果要获取特定设备类型的数据,请指定此字段;可能的值:all、mobile、desktop、tablet;默认值:all

sort_by
string

结果排序参数,可选字段。使用这些参数可按 search_volume、cpc、competition 或 relevance 对结果进行降序排序。默认值:relevance

date_from
string

时间范围的起始日期;可选字段;最小值:自今天起向前 24 个月;如果未指定此字段,将提供最近 12 个月的数据;日期格式:"yyyy-mm-dd";示例:"2020-01-01";注意:不建议对过去一年的日期使用自定义时间范围

date_to
string

时间范围的结束日期;可选字段。如果未指定此字段,将提供过去 12 个月的数据;最小值:自今天起向前两年;最大值:自今天起一个月;日期格式:"yyyy-mm-dd";示例:"2020-03-15"。注意:不建议对过去一年的日期使用自定义时间范围

postback_url
string

用于发送任务结果的 URL,可选字段;任务完成后,我们会向指定的 postback_url 发送 POST 请求,其结果采用 gzip 格式压缩;可以使用字符串 ‘$id’ 作为 $id 变量,并使用 ‘$tag’ 作为经过 URL 编码的 $tag 变量。我们会在发送请求前设置必要的值。示例:http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag 注意:postback_url 中的特殊字符将经过 URL 编码;例如,# 字符将被编码为 %23;有关更多信息,请参阅我们的帮助中心

pingback_url
string

已完成任务的通知 URL。可选字段。任务完成后,我们将通过向您指定的 URL 发送 GET 请求来通知您。您可以使用字符串 ‘$id’ 作为 $id 变量,并使用 ‘$tag’ 作为经过 urlencoded 编码的 $tag 变量。我们会在发送请求前设置必要的值。示例:http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag 注意:pingback_url 中的特殊字符将经过 urlencoded 编码;例如,# 字符将被编码为 %23。请在我们的帮助中心了解更多信息

search_partners
boolean

Bing 搜索合作伙伴类型,可选字段。如果指定 true,则会返回 Bing、Yahoo、AOL 的自有、运营及联合网络,以及托管 Bing、AOL 和 Yahoo 搜索的合作伙伴网站的结果。默认值:false – 返回 Bing、AOL 和 Yahoo 搜索网络的结果

tag
string

用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配;您将在响应的 data 对象中找到指定的 tag 值

响应

成功响应

version
string

API 的当前版本

status_code
integer

通用状态码;您可以在此处查看完整的响应码列表。注意:我们强烈建议设计必要的系统来处理相关异常或错误情况

status_message
string

一般信息性消息

time
string

执行时间(秒)

cost
number

任务总成本(美元)

tasks_count
integer

tasks 数组中的任务数量

tasks_error
integer

返回错误的 tasks 数组中的任务数量

tasks
string[]

任务数组

tasks.id
string

任务标识符,系统中采用 UUID 格式的唯一任务标识符

tasks.status_code
integer

DataForSEO 生成的任务状态码;取值范围为:10000-60000,完整的响应码列表可在此处查看

tasks.status_message
string

任务的信息性消息,你可以在此处查看通用信息性消息的完整列表

tasks.time
string

执行时间(秒)

tasks.cost
number

任务成本(美元)

tasks.result_count
integer

结果数组中的元素数量

tasks.path
string[]

URL 路径

tasks.data
object

包含您在 POST 请求中指定的相同参数

tasks.result
string[]

结果数组;在此情况下,该值将为 null