Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 5.71 KB

File metadata and controls

46 lines (34 loc) · 5.71 KB

root / docs

[Back to README.md]

AppDataAppleAppListTaskPostRequestInfo

Properties

Name Type Description Notes
app_collection str 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 [optional]
location_name str 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 [optional]
location_code int 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 [optional]
language_name str full name of search engine language optional field 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 [optional]
language_code str search engine language code optional field 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 [optional]
priority int 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. [optional]
depth int 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; Note: your account will be billed per each SERP containing up to 100 results; thus, setting a depth above 100 may result in additional charges if the search engine returns more than 100 results; if the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically default value: 100 maximum value: 1000 [optional]
app_category str 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 [optional]
tag str 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 [optional]
postback_url str return 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 symbols in postback_url will be urlencoded; i.a., the # symbol will be encoded into %23 [optional]
postback_data str postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced [optional]
pingback_url str 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 symbols in pingback_url will be urlencoded; i.a., the # symbol will be encoded into %23 [optional]

Example

from dataforseo_client.models.app_data_apple_app_list_task_post_request_info import AppDataAppleAppListTaskPostRequestInfo

# TODO update the JSON string below
json = "{}"
# create an instance of AppDataAppleAppListTaskPostRequestInfo from a JSON string
app_data_apple_app_list_task_post_request_info_instance = AppDataAppleAppListTaskPostRequestInfo.from_json(json)
# print the JSON string representation of the object
print AppDataAppleAppListTaskPostRequestInfo.to_json()

# convert the object into a dict
app_data_apple_app_list_task_post_request_info_dict = app_data_apple_app_list_task_post_request_info_instance.to_dict()
# create an instance of AppDataAppleAppListTaskPostRequestInfo from a dict
app_data_apple_app_list_task_post_request_info_form_dict = app_data_apple_app_list_task_post_request_info.from_dict(app_data_apple_app_list_task_post_request_info_dict)

root / docs

[Back to README.md]