Felo API PlatformFelo API Platform

データ API / DataForSEO / Keywords Data

Setting Live ‘Google Ads Search Volume’ Tasks

Google Ads search volume for a list of keywords. Returns keyword, location_code, language_code, search_partners, competition, competition_index, search_volume, low_top_of_page_bid, high_top_of_page_bid, cpc and monthly_searches, plus spell when Google corrected the term. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is the classical search-volume number; for how often people ask an assistant instead, use post_dataforseo_ai_keyword_volume_live. 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 keywords you specify will be converted to a lowercase format Note #1: Google Ads may return no data for certain groups of keywords; Note #2: Google Ads provides combined search volume values for groups of similar keywords to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests; Note #3: Google Ads doesn’t allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can’t use them when setting a task; to learn more about which symbols and characters can be used, please refer to this article learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

  • location_namestring任意

    full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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/google_ads/locations example: London,England,United Kingdom

  • location_codeinteger任意

    search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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/google_ads/locations example: 2840

  • location_coordinatestring任意

    GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; 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 optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: English

  • language_codestring任意

    search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/google_ads/languages example: en

  • search_partnersboolean任意

    include Google search partners optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search; default value: false – results are returned for Google search sites

  • date_fromstring任意

    starting date of the time range optional field date format: "yyyy-mm-dd" minimal value: 4 years from the current date by default, data is returned for the past 12 months; Note: the indicated date cannot be greater than that specified in date_to and/or yesterday’s date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior; if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior

  • date_tostring任意

    ending date of the time range optional field Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month; if you don’t specify this field, yesterday’s date will be used by default date format: "yyyy-mm-dd" example: "2022-11-30"

  • include_adult_keywordsboolean任意

    include keywords associated with adult content optional field if set to true, adult keywords will be included in the response default value: false note that the API may return no data for such keywords due to Google Ads restrictions

  • sort_bystring任意

    results sorting parameters optional field use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order default value: relevance

  • 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 array of the response

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/search_volume/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keywords": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "search_partners": false,
  "date_from": "<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 the 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

  • datastring[]任意

    contains the same parameters that you specified in the POST request

  • resultstring[]任意

    array of results

  • keywordstring任意

    keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

  • spellstring任意

    correct spelling of the keyword Note:if the keyword in the POST array appears to be misspelled, data will be returned for the correctly spelled keyword; we use the functionality of Google Ads API to check and validate the spelling of keywords, learn more by this link

  • 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

  • search_partnersboolean任意

    indicates whether data from partner networks included in the response

  • competitionstring任意

    competition represents the relative amount of competition associated with the given keyword in paid SERP only; this value is based on Google Ads data and can take the following values: HIGH, MEDIUM, LOW; if there is no data the value is null; learn more about the metric in this help center article

  • competition_indexinteger任意

    competition represents the relative amount of competition associated with the given keyword in paid SERP only; this value is based on Google Ads data and can be between 0 and 100 (inclusive); if there is no data the value is null; learn more about the metric in this help center article

  • search_volumeinteger任意

    monthly average search volume rate; represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting; if there is no data then the value is null

  • low_top_of_page_bidnumber任意

    minimum bid for the ad to be displayed at the top of the first page indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers); the value may differ depending on the location specified in a POST request

  • high_top_of_page_bidnumber任意

    maximum bid for the ad to be displayed at the top of the first page indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers); the value may differ depending on the location specified in a POST request

  • cpcnumber任意

    cost per click indicates the amount paid (USD) for each click on the ad displayed for a given keyword

  • monthly_searchesstring[]任意

    monthly searches represents the (approximate) number of searches on this keyword idea (as available for the past twelve months by default), targeted to the specified geographic locations; if there is no data then the value is null

  • yearinteger任意

    year

  • monthinteger任意

    month

  • search_volumeinteger任意

    monthly average search volume rate