데이터 API / DataForSEO / Keywords Data
Setting ‘Keywords For Site’ Tasks
Queues a Bing keywords-for-site task, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_keywords_bing_kw_for_site_fetch.
파라미터
경로, 쿼리, 헤더 파라미터가 없습니다.
요청 본문
targetstring필수domain or URL required field the URL of the webpage or the domain to scan for possible keywords
location_namestring선택full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations example: London,England,United Kingdom
location_codeinteger선택search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/locations example: 2840
location_coordinatestring선택GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude” format the data will be provided for the country the specified coordinates belong to example: 52.6178549,-155.352142
language_namestring선택full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code supported languages: English, French, German
language_codestring선택search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name supported languages: en, fr, de
keywords_negativestring[]선택keywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to lowercase format
devicestring선택device type optional field specify this field if you want to get the data for a particular device type possible values: all, mobile, desktop, tablet default value: all
sort_bystring선택results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance
date_fromstring선택starting date of the time range optional field minimal value: 24 months from today’s date; if you don’t specify this field, data will be provided for the last 12 months date format: "yyyy-mm-dd" example: "2020-01-01" Note: we do not recommend using a custom time range for the past year’s dates
date_tostring선택ending date of the time range optional field if you don’t specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today’s date; date format: "yyyy-mm-dd" example: "2020-03-15" Note: we do not recommend using a custom time range for the past year’s dates
postback_urlstring선택URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
pingback_urlstring선택notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
search_partnersboolean선택Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search. default value: false – results are returned for Bing, AOL, and Yahoo search networks
tagstring선택user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
요청 예시
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/bing/keywords_for_site/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "<string>",
"location_name": "<string>",
"location_code": 0,
"location_coordinate": "<string>",
"language_name": "<string>",
"language_code": "<string>",
"keywords_negative": [
"<string>"
],
"device": "<string>"
}'응답
응답 필드
versionstring선택the current version of the API
status_codeinteger선택general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestring선택general informational message
timestring선택execution time, seconds
costnumber선택total tasks cost, USD
tasks_countinteger선택the number of tasks in the tasks array
tasks_errorinteger선택the number of tasks in the tasks array returned with an error
tasksstring[]선택array of tasks
idstring선택task identifier unique task identifier in our system in the UUID format
status_codeinteger선택status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of response codes here
status_messagestring선택informational message of the task you can find the full list of general informational messages here
timestring선택execution time, seconds
costnumber선택cost of the task, USD
result_countinteger선택number of elements in the result array
pathstring[]선택URL path
dataobject선택contains the same parameters that you specified in the POST request
resultstring[]선택array of results in this case, the value will be null