数据 API / DataForSEO / Keywords Data

Setting Live ‘Bing Keyword Performance’ Tasks

How a list of keywords performs in Bing Ads for a given device and match type. ⚠️ language_name is required and its absence is reported as Invalid Field: 'language_name' inside an HTTP 200 - the message means missing as well as wrong. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Valid pairs come from get_dataforseo_keywords_bing_kw_performance_locales. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

参数

没有路径、查询或请求头参数。

请求体

keywordsstring[]必填
keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase, data will be provided in a separate array learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
devicestring可选
device type optional field specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all default value: all
matchstring可选
keywords match type optional field can take the following values: aggregate returns data across all match types; broad returns data for all user queries containing the specified keyword with varying word order; phrase returns data for all user queries containing the specified keyword with identical word order; exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default
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 and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: "United States"
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 and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages 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 you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: English
language_codestring可选
search engine language code required field if you don’t specify language_name you can receive the list of available locations and languages by making a separate request to https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages example: "en"
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/keyword_performance/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "device": "<string>",
  "match": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<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 you can find the full list of general informational messages here
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
keywordstring可选
keyword in a POST array
location_codeinteger可选
location code in a POST array if there is no data, then the value is null
language_codestring可选
language code in a POST array if there is no data, then the value is null
yearinteger可选
indicates the year for which the data is provided for example: 2020
monthinteger可选
indicates the month for which the data is provided for example: 10
keyword_kpiobject可选
object containing keyword metrics if there is no data, then the value is null
desktopstring[]可选
keyword data aggregated for desktop devices if there is no data, then the value is null
ad_positionstring可选
represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page
clicksinteger可选
ad clicks the number of clicks that the keyword and match type generated during the last month
impressionsinteger可选
ad impressions the number of impressions that the keyword and match type generated during the last month
average_cpcinteger可选
average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks
ctrinteger可选
click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100
total_costinteger可选
total cost of an ad, USD the cost of using the specified keyword and match type during the last month
average_bidinteger可选
average bid of the keyword
mobilestring[]可选
keyword data aggregated for mobile devices if there is no data, then the value is null
ad_positionstring可选
represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page
clicksinteger可选
ad clicks the number of clicks that the keyword and match type generated during the last month
impressionsinteger可选
ad impressions the number of impressions that the keyword and match type generated during the last month
average_cpcinteger可选
average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks
ctrinteger可选
click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100
total_costinteger可选
total cost of an ad, USD the cost of using the specified keyword and match type during the last month
average_bidinteger可选
average bid of the keyword
tabletstring[]可选
keyword data aggregated for tablet devices if there is no data, then the value is null
ad_positionstring可选
represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page
clicksinteger可选
ad clicks the number of clicks that the keyword and match type generated during the last month
impressionsinteger可选
ad impressions the number of impressions that the keyword and match type generated during the last month
average_cpcinteger可选
average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks
ctrinteger可选
click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100
total_costinteger可选
total cost of an ad, USD the cost of using the specified keyword and match type during the last month
average_bidinteger可选
average bid of the keyword