データ API / DataForSEO / DataForSEO Labs
Related Keywords
Amazon search terms related to a seed keyword. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The Google-side equivalent is post_dataforseo_labs_google_related_keywords_live; shopping intent and web intent diverge sharply, so do not substitute one for the other.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
keywordstring必須keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestring任意full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States
location_codeinteger任意location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840
language_namestring任意full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
language_codestring任意language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
depthinteger任意keyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords
include_seed_keywordboolean任意include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false
ignore_synonymsboolean任意ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
limitinteger任意the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetinteger任意offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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/dataforseo_labs/amazon/related_keywords/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<string>",
"location_name": "<string>",
"location_code": 0,
"language_name": "<string>",
"language_code": "<string>",
"depth": 0,
"include_seed_keyword": false,
"ignore_synonyms": 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 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
dataobject任意contains the same parameters that you specified in the POST request
resultstring[]任意array of results
se_typestring任意search engine type
seed_keywordstring任意keyword in a POST array
seed_keyword_dataobject任意keyword data for the seed keyword fields in the object are identical to that of keyword_data
location_codeinteger任意location code in a POST array
language_codestring任意language code in a POST array
total_countinteger任意total amount of results in our database relevant to your request
items_countinteger任意the number of results returned in the items array
itemsstring[]任意contains objects with keywords and related data
se_typestring任意search engine type
keyword_dataobject任意keyword data for the returned keyword
se_typestring任意search engine type
keywordstring任意related keyword
location_codeinteger任意location code in a POST array
language_codestring任意language code in a POST array
keyword_infoobject任意keyword info for the returned keyword
se_typestring任意search engine type
last_updated_timestring任意date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
search_volumeinteger任意average monthly search volume rate represents the (approximate) number of searches for the provided keyword idea on Amazon
depthinteger任意keyword search depth
related_keywordsstring[]任意list of related keywords represents the list of search queries which are related to the keyword returned in the array above