資料 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