Data API / DataForSEO / App Data
Setting Apple App List Tasks
Queues one of the App Store's curated collections, chosen with app_collection, returning a task id. depth caps how far down the chart to read. Asynchronous: submit returns a task id in tasks[0].id and the fetch tool returns the result once ready. Retrieve with get_dataforseo_app_apple_app_list_fetch. No HTML variant exists on the Apple half.
Параметры
Параметров пути, запроса и заголовков нет.
Тело запроса
app_collectionstringОбязательныйapp collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios
location_namestringНеобязательныйfull name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code 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/app_data/apple/locations example: West Los Angeles,California,United States
location_codeintegerНеобязательныйsearch engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121
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 languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English
language_codestringНеобязательныйsearch engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en
priorityintegerНеобязательныйtask priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.
depthintegerНеобязательныйparsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page.
app_categorystringНеобязательныйapplication category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories
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
postback_urlstringНеобязательныйURL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
postback_datastringНеобязательныйpostback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced
pingback_urlstringНеобязательныйnotification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
Пример запроса
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/app_data/apple/app_list/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"app_collection": "<string>",
"location_name": "<string>",
"location_code": 0,
"language_name": "<string>",
"language_code": "<string>",
"priority": 0,
"depth": 0,
"app_category": "<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 tasksarray
tasks_errorintegerНеобязательныйthe number of tasks in the tasks array returned with an error
tasksstring[]Необязательныйarray of tasks
idstringНеобязательныйunique task identifier in our system in the Universally unique identifier (UUID) format
status_codeintegerНеобязательныйstatus code of the task generated by DataForSEO; can be within the following range: 10000-60000
status_messagestringНеобязательныйinformational message of the task
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 in this case, the value will be null