Felo API PlatformFelo API Platform

데이터 API / DataForSEO / Keywords Data

Setting Live ‘Keywords For Site’ Tasks

The Google Ads keywords a whole site ranks or bids for, from a target domain, each with 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. target_type selects the page or the domain. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on.

파라미터

경로, 쿼리, 헤더 파라미터가 없습니다.

요청 본문

  • targetstring필수

    domain or page required field the domain name of the target website or the url of the target page; note: to obtain keywords for the target website, use the target_type parameter

  • target_typestring선택

    search keywords for site or for url optional field possible values: site, page; default value: page; if set to site, keywords will be provided for the entire site; if set to page, keywords will be provided for the specified webpage

  • 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 yesterday’s date; 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 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 object of the response

요청 예시

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/keywords_for_site/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "<string>",
  "target_type": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "search_partners": false
}'

응답

응답 필드

  • 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, the value is null

  • language_codestring선택

    language code in a POST array if there is no data, the value is null

  • search_partnersboolean선택

    include Google search partners the value you specified when setting the task if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only

  • competitionstring선택

    competition represents the relative level of competition associated with the given keyword in paid SERP only possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article

  • competition_indexinteger선택

    competition index the competition index for the query indicating how competitive ad placement is for the keyword can take values from 0 to 100 the level of competition from 0 to 100 is determined by the number of ad slots filled divided by the total number of ad slots available if not enough data is available, the value is null; learn more about the metric in this help center article

  • search_volumeinteger선택

    monthly average search volume rate represents the (approximate) number of searches for the given keyword idea either on google.com or google.com and partners, depending on the user’s targeting if there is no data, 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), targeted to the specified geographic locations if there is no data, the value is null

  • yearinteger선택

    year

  • monthinteger선택

    month

  • search_volumeinteger선택

    monthly average search volume rate

  • keyword_annotationsobject선택

    the annotations for the keyword

  • conceptsstring[]선택

    the list of concepts for the keyword

  • namestring선택

    the concept name for the keyword in the concept_group

  • concept_groupobject선택

    the concept group of the concept details

  • namestring선택

    the concept group name

  • typestring선택

    the concept group type