{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "DataForSEO App Data API Schemas", "definitions": { "AppDataAppleAppReviewsTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppReviewsTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppReviewsTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppReviewsTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppReviewsTaskGetAdvancedResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "application id received in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "title": { "type": "string", "description": "title of the app\ntitle of the application for which the reviews are collected", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating of the app\nrating of the application for which the reviews are collected", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews\nin this case, the value will be null as App Store does not indicate the total number of app reviews", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of reviews items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppStoreReviewsSearch" } ], "nullable": true }, "description": "found reviews", "nullable": true } } }, "RatingInfo": { "properties": { "rating_type": { "type": "string", "description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax", "nullable": true }, "value": { "type": "number", "description": "the value of the rating", "format": "double", "nullable": true }, "votes_count": { "type": "integer", "description": "the amount of feedback", "format": "int64", "nullable": true }, "rating_max": { "type": "integer", "description": "the maximum value for a rating_type", "nullable": true } } }, "AppStoreReviewsSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: left", "nullable": true }, "version": { "type": "string", "description": "version of the app\nversion of the app for which the review is submitted", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when the review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "id": { "type": "string", "description": "id of the review", "nullable": true }, "title": { "type": "string", "description": "title of the review", "nullable": true }, "review_text": { "type": "string", "description": "content of the review", "nullable": true }, "user_profile": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppUserProfileInfo" } ], "description": "user profile of the reviewer", "nullable": true } } }, "AppUserProfileInfo": { "type": "object", "properties": { "profile_name": { "type": "string", "description": "profile name of the reviewer", "nullable": true }, "profile_image_url": { "type": "string", "description": "URL to the reviewer\u2019s profile image", "nullable": true } } }, "BaseResponseTaskInfo": { "properties": { "id": { "type": "string", "description": "task identifier\nunique task identifier in our system in the UUID format", "nullable": true }, "status_code": { "type": "integer", "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here", "nullable": true }, "status_message": { "type": "string", "description": "informational message of the task\nyou can find the full list of general informational messages here", "nullable": true }, "time": { "type": "string", "description": "execution time, seconds", "nullable": true }, "cost": { "type": "number", "description": "total tasks cost, USD", "format": "double", "nullable": true }, "result_count": { "type": "integer", "description": "number of elements in the result array", "format": "int64", "nullable": true }, "path": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "URL path", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "contains the same parameters that you specified in the POST request", "nullable": true } } }, "BaseResponseInfo": { "properties": { "version": { "type": "string", "description": "the current version of the API", "nullable": true }, "status_code": { "type": "integer", "description": "general status code\nyou can find the full list of the response codes here", "nullable": true }, "status_message": { "type": "string", "description": "general informational message\nyou can find the full list of general informational messages here", "nullable": true }, "time": { "type": "string", "description": "total execution time, seconds", "nullable": true }, "cost": { "type": "number", "description": "total tasks cost, USD", "format": "double", "nullable": true }, "tasks_count": { "type": "integer", "description": "the number of tasks in the tasks array", "format": "int64", "nullable": true }, "tasks_error": { "type": "integer", "description": "the number of tasks in the tasks array returned with an error", "format": "int64", "nullable": true } } }, "AppDataGoogleLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 1006473,\n\"location_name\": \"Altrincham,England,United Kingdom\",\n\"location_name_parent\": \"England,United Kingdom\", where location_name_parent corresponds to:\n\"location_code\": 20339,\n\"location_name\": \"England,United Kingdom\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type", "nullable": true } } }, "AppDataAppleAppSearchesTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppSearchesTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppSearchesTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppSearchesTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppSearchesTaskGetAdvancedResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST request", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nin this case, the value will be null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppStoreSearchOrganic" } ], "nullable": true }, "description": "found apps", "nullable": true } } }, "AppStoreSearchOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank in SERP\nabsolute position among all the elements in SERP", "nullable": true }, "position": { "type": "string", "description": "the alignment of the element in SERP\ncan take the following values:\nleft, right", "nullable": true }, "app_id": { "type": "string", "description": "id of the app", "nullable": true }, "title": { "type": "string", "description": "title of the app", "nullable": true }, "url": { "type": "string", "description": "URL to the app page on App Store", "nullable": true }, "icon": { "type": "string", "description": "URL to the app icon", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews of the app", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "average rating of the app", "nullable": true }, "is_free": { "type": "boolean", "description": "indicates whether the app is free", "nullable": true }, "price": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "description": "price of the app", "nullable": true } } }, "PriceInfo": { "type": "object", "properties": { "current": { "type": "number", "description": "current price\nindicates the current price of the product or service featured in the result", "format": "double", "nullable": true }, "regular": { "type": "number", "description": "regular price\nindicates the regular price of the product or service with no discounts applied", "format": "double", "nullable": true }, "max_value": { "type": "number", "description": "the maximum price\nthe maximum price of the product or service as indicated in the result", "format": "double", "nullable": true }, "currency": { "type": "string", "description": "currency of the listed price\nISO code of the currency applied to the price", "nullable": true }, "is_price_range": { "type": "boolean", "description": "price is provided as a range\nindicates whether a price is provided in a range", "nullable": true }, "displayed_price": { "type": "string", "description": "price string in the result\nraw price string as provided in the result", "nullable": true } } }, "AppDataAppleCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleCategoriesResultInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "contains full list of supported app categories", "nullable": true } } }, "AppDataAppleAppReviewsTaskPostRequestInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "id of the app\nrequired field\nID of the mobile application on App Store;\nyou can find the ID in the URL of every app listed on App Store;\nexample:\nin the URL https://apps.apple.com/us/app/id835599320\nthe id is 835599320" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou 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\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews to be returned in the API response;\nwe strongly recommend setting the parsing depth in the multiples of 50, because our system processes 50 reviews in a row;\ndefault value: 50;\nmaximum value: 500;\nYour account will be billed per each SERP containing up to 50 results;\nSetting depth above 50 may result in additional charges if the search engine returns more than 50 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results;\npossible types of sorting:\nmost_recent \u2014 sort by the most recent reviews;\nmost_helpful \u2014 sort by the most relevant reviews;\ndefault rule: most_helpful", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true } }, "example": [ { "app_id": "835599320", "location_code": 2840, "language_code": "en", "depth": 200 } ] }, "AppDataAppleLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleLanguagesResultInfo": { "type": "object", "properties": { "language_name": { "type": "string", "description": "language name", "nullable": true }, "language_code": { "type": "string", "description": "language code according to ISO 639-1", "nullable": true } } }, "AppDataIdListRequestInfo": { "type": "object", "properties": { "datetime_from": { "type": "string", "description": "start time for filtering results\nrequired field\nif include_metadata is set to true, maximum value: a month from current datetime;\nif include_metadata is set to false, maximum value: six months from current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00" }, "datetime_to": { "type": "string", "description": "finish time for filtering results\nrequired field\nmaximum value: current datetime;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-31 13:57:46 +00:00" }, "limit": { "type": "integer", "description": "the maximum number of returned task IDs\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned task IDs\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten tasks in the results array will be omitted", "nullable": true }, "sort": { "type": "string", "description": "sorting by task execution time\noptional field\npossible values: \"asc\", \"desc\"\ndefault value: \"asc\"", "nullable": true }, "include_metadata": { "type": "boolean", "description": "include task metadata in the respond\noptional field\ndefault value: false", "nullable": true } }, "example": [ { "datetime_from": "2026-04-12 04:39:39 +00:00", "datetime_to": "2026-04-14 04:39:39 +00:00", "limit": 100, "offset": 0, "sort": "desc", "include_metadata": true } ] }, "AppDataAppleAppListingsCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListingsCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppListingsCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListingsCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppListingsCategoriesResultInfo": { "type": "object", "properties": { "category": { "type": "string", "description": "name of the supported app category", "nullable": true }, "count": { "type": "integer", "description": "number of app listings that make up the supported app category", "format": "int64", "nullable": true } } }, "AppDataAppleAppSearchesTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character);\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nif you need to use the \u201c+\u201d character for your keyword, please specify it as \u201c%2B\u201d\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if language_code is not specified\nif you use this field, you don\u2019t need to specify language_code\nyou 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\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if language_name is not specified\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of results to be returned from the App Store SERP;\nwe strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;\ndefault value: 100\nmaximum value: 700\nYour account will be billed per each SERP containing up to 100 results;\nSetting depth above 100 may result in additional charges if the search engine returns more than 100 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true } }, "example": [ { "keyword": "vpn", "location_code": 2840, "language_code": "en", "depth": 200 } ] }, "AppDataGoogleAppInfoTaskPostRequestInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "id of the app\nrequired field\nID of the mobile application on Google Play;\nyou can find the ID in the URL of every app listed on Google Play;\nexample:\nin the URL https://play.google.com/store/apps/details?id=org.telegram.messenger\nthe id is org.telegram.messenger" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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/google/locations\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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/google/locations\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if language_code is not specified\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if language_name is not specified\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced, html", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true } }, "example": [ { "app_id": "org.telegram.messenger", "location_code": 2840, "language_code": "en" } ] }, "AppDataGoogleAppListTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppListTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Google App List task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Google App List HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataGoogleAppListTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppListTaskGetAdvancedResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "app collection received in a POST array", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of app items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GooglePlaySearchOrganic" } ], "nullable": true }, "description": "found apps", "nullable": true } } }, "GooglePlaySearchOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank in SERP\nabsolute position among all the elements in SERP", "nullable": true }, "position": { "type": "string", "description": "the alignment of the element in SERP\ncan take the following values:\nleft, right", "nullable": true }, "app_id": { "type": "string", "description": "id of the app", "nullable": true }, "title": { "type": "string", "description": "title of the app", "nullable": true }, "url": { "type": "string", "description": "URL to the app page on Google Play", "nullable": true }, "icon": { "type": "string", "description": "URL to the app icon", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews of the app", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "average rating of the app", "nullable": true }, "is_free": { "type": "boolean", "description": "indicates whether the app is free", "nullable": true }, "price": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "description": "price of the app", "nullable": true }, "developer": { "type": "string", "description": "name of the app developer", "nullable": true }, "developer_url": { "type": "string", "description": "URL to the developer page on Google Play", "nullable": true } } }, "AppDataGoogleAppReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Google App Reviews task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Google App Reviews HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataGoogleAppListTaskPostRequestInfo": { "type": "object", "properties": { "app_collection": { "type": "string", "description": "app collection\nrequired field\napp collection on Google Play from which apps will be collected;\nyou can specify the following values:\nfeatured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers\nNote: if featured is selected, the app_category parameter cannot be used" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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/google/locations\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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/google/locations\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if language_code is not specified\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if language_name is not specified\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of apps to be returned in the API response;\nwe strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;\ndefault value: 100;\nmaximum value: 200;\nYour account will be billed per each SERP containing up to 100 results;\nSetting depth above 100 may result in additional charges if the search engine returns more than 100 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "app_category": { "type": "string", "description": "application category on Google Play\noptional field\nyou can filter the results by app category;\nexample:\nfamily;\nyou can receive the full list of available categories by making a separate request to https://api.dataforseo.com/v3/app_data/google/categories\nNote: app_category cannot be used if app_collection parameter is set to featured", "nullable": true }, "age_rating": { "type": "string", "description": "filter results by age rating\noptional field\nyou can use this field to filter the results by age rating;\npossible types of filtering:\nages_up_to_5 \u2014 return apps approved for children up to 5 years old;\nages_6_8 \u2014 return apps approved for children from 6 to 8 years old;\nages_9_12 \u2014 return apps approved for children from 9 to 12 years old;\nby default, the API returns apps for all ages;\nNote: this filter works only in conjunction with the \"category\": \"family\" parameter", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced, html", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true } }, "example": [ { "app_collection": "topselling_free", "location_code": 2840, "language_code": "en", "depth": 100 } ] }, "AppDataTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Apple App Reviews task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Apple App Reviews HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataGoogleLanguagesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLanguagesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleLanguagesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLanguagesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleLanguagesResultInfo": { "type": "object", "properties": { "language_name": { "type": "string", "description": "language name", "nullable": true }, "language_code": { "type": "string", "description": "language code according to ISO 639-1", "nullable": true } } }, "AppDataGoogleAppListingsCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListingsCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListingsCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListingsCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppListingsCategoriesResultInfo": { "type": "object", "properties": { "category": { "type": "string", "description": "name of the supported app category", "nullable": true }, "count": { "type": "integer", "description": "number of app listings that make up the supported app category", "format": "int64", "nullable": true } } }, "AppDataAppleAppInfoTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppInfoTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppInfoTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppInfoTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppInfoTaskGetAdvancedResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "application id received in a POST request", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppStoreInfoOrganic" } ], "nullable": true }, "description": "found app info", "nullable": true } } }, "AppStoreInfoOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed apps\nabsolute position among all apps on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the element in SERP\ncan take the following values: left", "nullable": true }, "app_id": { "type": "string", "description": "ID of the app", "nullable": true }, "title": { "type": "string", "description": "title of the app", "nullable": true }, "url": { "type": "string", "description": "URL to the app page on App Store", "nullable": true }, "icon": { "type": "string", "description": "URL to the app icon", "nullable": true }, "description": { "type": "string", "description": "description of the app", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews of the app", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "average rating of the app", "nullable": true }, "price": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "description": "price of the app", "nullable": true }, "is_free": { "type": "boolean", "description": "indicates whether the app is free", "nullable": true }, "main_category": { "type": "string", "description": "main category/genre of the app", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "all relevant categories/genres of the app\nNote: this field returns only one relevant category in the array", "nullable": true }, "languages": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "languages supported in the app\nNote: this field returns only one supported language in the array", "nullable": true }, "advisories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "age rating and age-based content advisories", "nullable": true }, "developer": { "type": "string", "description": "name of the app developer", "nullable": true }, "developer_id": { "type": "string", "description": "ID of the app developer", "nullable": true }, "developer_url": { "type": "string", "description": "URL to the developer page on App Store", "nullable": true }, "version": { "type": "string", "description": "current version of the app", "nullable": true }, "minimum_os_version": { "type": "string", "description": "minimum OS version required to install the app", "nullable": true }, "size": { "type": "string", "description": "size of the app", "nullable": true }, "released_date": { "type": "string", "description": "date and time when the app was released\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00\nNote: this field is deprecated and always returns null", "nullable": true }, "last_update_date": { "type": "string", "description": "date and time when the app was last updated\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "update_notes": { "type": "string", "description": "update notes\ncontains the latest update notes from the developer", "nullable": true }, "images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "app images\ncontains URLs to the images used on the app page on App Store", "nullable": true }, "similar_apps": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppsInfo" } ], "nullable": true }, "description": "similar apps\ndisplays apps similar to the app in a POST request", "nullable": true }, "more_apps_by_developer": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppsInfo" } ], "nullable": true }, "description": "similar apps\ninformation about apps built by the same developer", "nullable": true } } }, "AppsInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "ID of the app", "nullable": true }, "title": { "type": "string", "description": "title of the app", "nullable": true }, "url": { "type": "string", "description": "URL to the app page on Google Play", "nullable": true } } }, "AppDataGoogleAppListingsSearchLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListingsSearchLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListingsSearchLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListingsSearchLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppListingsSearchLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "the total number of relevant results in the database", "format": "int64", "nullable": true }, "count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned apps", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nyou can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListingsSearchLiveItem" } ], "nullable": true }, "description": "array of apps and related data", "nullable": true } } }, "AppDataGoogleAppListingsSearchLiveItem": { "type": "object", "properties": { "app_id": { "type": "string", "description": "ID of the returned app", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "time_update": { "type": "string", "description": "date and time when SERP data was last updated\nin the ISO 8601 format: \u201cYYYY-MM-DDThh:mm:ss.sssssssZ\u201d\nexample:\n2023-05-23 10:16:19 +00:00", "nullable": true }, "item": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GooglePlayInfoOrganic" } ], "description": "detailed information about the app", "nullable": true } } }, "GooglePlayInfoOrganic": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed apps\nabsolute position among all apps on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the element in SERP\ncan take the following values: left", "nullable": true }, "app_id": { "type": "string", "description": "ID of the app", "nullable": true }, "title": { "type": "string", "description": "title of the app", "nullable": true }, "url": { "type": "string", "description": "URL to the app page on Google Play", "nullable": true }, "icon": { "type": "string", "description": "URL to the app icon", "nullable": true }, "description": { "type": "string", "description": "description of the app", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews the app has", "format": "int64", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "average rating of the app", "nullable": true }, "price": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PriceInfo" } ], "description": "price of the app", "nullable": true }, "is_free": { "type": "boolean", "description": "indicates whether the app is free", "nullable": true }, "main_category": { "type": "string", "description": "main category of the app", "nullable": true }, "installs": { "type": "string", "description": "number of installs of the app\napproximate number of installs as displayed on the app page", "nullable": true }, "installs_count": { "type": "integer", "description": "number of installs of the app\nthe exact number of installs of the app", "format": "int64", "nullable": true }, "developer": { "type": "string", "description": "name of the app developer", "nullable": true }, "developer_id": { "type": "string", "description": "ID of the app developer", "nullable": true }, "developer_url": { "type": "string", "description": "URL to the developer page on Google Play", "nullable": true }, "developer_email": { "type": "string", "description": "email address of the developer", "nullable": true }, "developer_address": { "type": "string", "description": "physical address of the developer", "nullable": true }, "developer_website": { "type": "string", "description": "official website of the developer", "nullable": true }, "version": { "type": "string", "description": "current version of the app", "nullable": true }, "minimum_os_version": { "type": "string", "description": "minimum OS version required to install the app", "nullable": true }, "size": { "type": "string", "description": "size of the app", "nullable": true }, "released_date": { "type": "string", "description": "date and time when the app was released\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "last_update_date": { "type": "string", "description": "date and time when the app was last updated\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "update_notes": { "type": "string", "description": "update notes\ncontains the latest update notes from the developer", "nullable": true }, "images": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "app images\ncontains URLs to the images published on the app page on Google Play", "nullable": true }, "videos": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "app videos\ncontains URLs to the video published on the app page on Google Play", "nullable": true }, "similar_apps": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppsInfo" } ], "nullable": true }, "description": "similar apps\ndisplays apps similar to the app in a POST request", "nullable": true }, "more_apps_by_developer": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppsInfo" } ], "nullable": true }, "description": "similar apps\ninformation about apps built by the same developer", "nullable": true }, "genres": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "app genres\ncontains relevant app categories", "nullable": true }, "tags": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "app tags\ncontains relevant app tags", "nullable": true } } }, "AppDataGoogleAppSearchesTaskGetHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTaskGetHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTaskGetHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTaskGetHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTaskGetHtmlResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST request", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages and related data", "nullable": true } } }, "HtmlItemInfo": { "type": "object", "properties": { "page": { "type": "integer", "description": "serial number of the returned HTML page", "nullable": true }, "date": { "type": "string", "description": "date and time when the HTML page was scanned\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "html": { "type": "string", "description": "HTML\u00a0page", "nullable": true } } }, "AppDataErrorsRequestInfo": { "type": "object", "properties": { "limit": { "type": "integer", "description": "the maximum number of returned tasks that responded with an error\noptional field\ndefault value: 1000\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned tasks\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks", "nullable": true }, "filtered_function": { "type": "string", "description": "return tasks with a certain function\nuse this field to obtain a list of tasks that returned an error filtered by a certain function\nyou can filter the results by the values you receive in the function fields of the API response\ni.e., once you receive unfiltered results, you can call this API again to filter them by function\nexample: app_data/task_get/advanced, postback_url, pingback_url", "nullable": true }, "datetime_from": { "type": "string", "description": "start time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 12:57:46 +00:00", "nullable": true }, "datetime_to": { "type": "string", "description": "finish time for filtering results\noptional field\nallows filtering results by the datetime parameter within the range of the last 7 days;\nmust be specified in the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2021-11-15 13:57:46 +00:00", "nullable": true } }, "example": [ { "limit": 10, "offset": 0, "filtered_function": "pingback_url" } ] }, "AppDataAppleAppListTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppListTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataGoogleAppInfoTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppInfoTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppInfoTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Google App Info task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Google App Info HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataGoogleCategoriesResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleCategoriesTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleCategoriesTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleCategoriesResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleCategoriesResultInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string", "nullable": true }, "description": "contains full list of supported app categories", "nullable": true } } }, "AppDataGoogleAppSearchesTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataGoogleLocationsCountryResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLocationsCountryTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleLocationsCountryTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleLocationsCountryResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleLocationsCountryResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 1006473,\n\"location_name\": \"Altrincham,England,United Kingdom\",\n\"location_name_parent\": \"England,United Kingdom\", where location_name_parent corresponds to:\n\"location_code\": 20339,\n\"location_name\": \"England,United Kingdom\"", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type", "nullable": true } } }, "AppDataGoogleAppInfoTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppInfoTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppInfoTaskGetAdvancedResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "application id received in a POST request", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GooglePlayInfoOrganic" } ], "nullable": true }, "description": "found app info", "nullable": true } } }, "AppDataGoogleAppSearchesTaskPostRequestInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword\nrequired field\nyou can specify up to 700 characters in the keyword field;\nall %## will be decoded (plus character \u2018+\u2019 will be decoded to a space character);\nif you need to use the \u201c%\u201d character for your keyword, please specify it as \u201c%25\u201d;\nif you need to use the \u201c+\u201d character for your keyword, please specify it as \u201c%2B\u201d\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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/google/locations\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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/google/locations\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\noptional field\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\noptional field\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of results to be returned to be returned from the Google Play SERP;\nwe strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;\ndefault value: 30;\nmaximum value: 200;\nYour account will be billed per each SERP containing up to 30 results;\nSetting depth above 30 may result in additional charges if the search engine returns more than 30 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced, html", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true } }, "example": [ { "keyword": "vpn", "location_code": 2840, "language_code": "en", "depth": 30 } ] }, "AppDataAppleAppSearchesTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppSearchesTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppSearchesTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataAppleAppSearchesTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppSearchesTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppSearchesTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppSearchesTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppSearchesTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Apple App Searches task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Apple App Searches HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataAppleAppInfoTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppInfoTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppInfoTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataGoogleAppListTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataAppleAppInfoTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppInfoTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppInfoTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppInfoTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppInfoTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Apple App Info task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Apple App Info HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataAppleAppReviewsTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppReviewsTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppReviewsTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataAppleAppInfoTaskPostRequestInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "id of the app\nrequired field\nID of the mobile application on App Store;\nyou can find the ID in the URL of every app listed on App Store;\nexample:\nin the URL https://apps.apple.com/us/app/id835599320\nthe id is 835599320" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou 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\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority \nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true } }, "example": [ { "app_id": "835599320", "location_code": 2840, "language_code": "en" } ] }, "AppDataAppleLocationsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleLocationsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleLocationsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleLocationsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleLocationsResultInfo": { "type": "object", "properties": { "location_code": { "type": "integer", "description": "location code", "nullable": true }, "location_name": { "type": "string", "description": "full name of the location", "nullable": true }, "location_name_parent": { "type": "string", "description": "the name of the superordinate location\nexample:\n\"location_code\": 1006473,\n\"location_name\": \"Altrincham,England,United Kingdom\",\n\"location_name_parent\": \"England,United Kingdom\", where location_name_parent corresponds to:\n\"location_code\": 20339,\n\"location_name\": \"England,United Kingdom\"\nnote: Apple App Data API currently supports countries only, that is why this value will always be null", "nullable": true }, "country_iso_code": { "type": "string", "description": "ISO country code of the location", "nullable": true }, "location_type": { "type": "string", "description": "location type", "nullable": true } } }, "AppDataAppleAppReviewsTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppReviewsTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppReviewsTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppReviewsTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppReviewsTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Apple App Reviews task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Apple App Reviews HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataAppleAppListingsSearchLiveRequestInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "app categories\noptional field\nthe categories you specify are used to search for app listings;\nyou can get the full list of available app listing categories by this link\nyou can specify up to 10 categories", "nullable": true }, "description": { "type": "string", "description": "keyword in the app\u2019s description\noptional field\nkeywords that occur in the description of the app;\ncan contain up to 200 characters", "nullable": true }, "title": { "type": "string", "description": "keyword in the app\u2019s title\noptional field\nkeywords that occur in the title of the app;\ncan contain up to 200 characters", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "nullable": true }, "description": "array of results filtering parameters\noptional field\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"rating.value\",\">\",3]\nyou can receive the list of available filters\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"item.rating.value,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"item.rating.value,desc\",\"item.rating.value,desc\"]", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned apps\noptional field\ndefault value: 100\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned apps\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities\nNote: we recommend using this parameter only when retrieving up to 10,000 results\nfor retrieving over 10,000 results, use the offset_token instead.", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\noptional field\nprovided in the identical filed of the response to each request;\nuse this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;\nby specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task\nNote: if the offset_token is specified in the request, all other parameters should be identical to the previous request\nlearn more about this parameter on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "title": "vpn", "description": "vpn", "categories": [ "Tools" ], "order_by": [ "item.rating.value,desc" ], "filters": [ [ "item.rating.value", ">", 4.5 ] ], "limit": 2 } ] }, "AppDataAppleAppListTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppListTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppListTaskGetAdvancedResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "app collection received in a POST array", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nin this case, the value will be null", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of app items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppStoreSearchOrganic" } ], "nullable": true }, "description": "found apps\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "AppDataGoogleAppSearchesTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTaskGetAdvancedResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "keyword received in a POST request", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "se_results_count": { "type": "integer", "description": "the total number of results", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GooglePlaySearchOrganic" } ], "nullable": true }, "description": "found apps", "nullable": true } } }, "AppDataAppleAppListingsSearchLiveResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListingsSearchLiveTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppListingsSearchLiveTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListingsSearchLiveResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppListingsSearchLiveResultInfo": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "the total number of relevant results in the database", "format": "int64", "nullable": true }, "count": { "type": "integer", "description": "the number of items in the results array", "format": "int64", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned apps", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\nyou can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListingsSearchLiveItem" } ], "nullable": true }, "description": "array of apps and related data", "nullable": true } } }, "AppDataAppleAppListingsSearchLiveItem": { "type": "object", "properties": { "app_id": { "type": "string", "description": "ID of the returned app", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "time_update": { "type": "string", "description": "date and time when SERP data was last updated\nin the ISO 8601 format: \u201cYYYY-MM-DDThh:mm:ss.sssssssZ\u201d\nexample:\n2023-05-23 10:16:19 +00:00", "nullable": true }, "item": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppStoreInfoOrganic" } ], "description": "detailed information about the app", "nullable": true } } }, "AppDataIdListResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataIdListTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataIdListTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataIdListResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataIdListResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "url": { "type": "string", "description": "URL of the task\nURL you used for making an API call", "nullable": true }, "datetime_posted": { "type": "string", "description": "date and time when the task was made\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "datetime_done": { "type": "string", "description": "date and time when the task was completed\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2023-01-15 12:57:46 +00:00", "nullable": true }, "status": { "type": "string", "description": "informational message of the task\nyou can find the full list of general informational messages here", "nullable": true }, "cost": { "type": "number", "description": "cost of the task, USD", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "object", "nullable": true }, "description": "contains parameters you specified in the POST request", "nullable": true } } }, "AppDataGoogleAppReviewsTaskPostRequestInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "id of the app\nrequired field\nID of the mobile application on Google Play;\nyou can find the ID in the URL of every app listed on Google Play;\nexample:\nhttps://play.google.com/store/apps/details?id=org.telegram.messenger" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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/google/locations\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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/google/locations\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/google/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of reviews to be returned in the API response;\nwe strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;\ndefault value: 150;\nmaximum value: 100000;\nYour account will be billed per each SERP containing up to 150 results;\nSetting depth above 150 may result in additional charges if the search engine returns more than 150 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "rating": { "type": "integer", "description": "filter reviews by rating\noptional field\nyou can use this field to filter the results;\npossible types of filtering:\n5 \u2014 return reviews with five-star rating only;\n4 \u2014 return reviews with four-star rating only;\n3 \u2014 return reviews with three-star rating only;\n2 \u2014 return reviews with two-star rating only;\n1 \u2014 return reviews with one-star rating only;\nby default, the API returns all reviews regardless of the number of stars", "nullable": true }, "sort_by": { "type": "string", "description": "results sorting parameters\noptional field\nyou can use this field to sort the results;\npossible types of sorting:\nnewest \u2014 sort by the most recent reviews;\nmost_relevant \u2014 sort by the most relevant reviews;\ndefault rule: most_relevant", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced, html", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23", "nullable": true } }, "example": [ { "app_id": "org.telegram.messenger", "location_code": 2840, "language_code": "en", "depth": 150 } ] }, "AppDataErrorsResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataErrorsTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataErrorsTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataErrorsResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataErrorsResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the task", "nullable": true }, "datetime": { "type": "string", "description": "date and time when an error occurred\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "function": { "type": "string", "description": "corresponding API function", "nullable": true }, "error_code": { "type": "integer", "description": "error code", "nullable": true }, "error_message": { "type": "string", "description": "error message or error URL\nerror message (see full list) or URL that caused an error", "nullable": true }, "http_url": { "type": "string", "description": "URL that caused an error\nURL you used for making an API call or pingback/postback URL", "nullable": true }, "http_method": { "type": "string", "description": "HTTP method", "nullable": true }, "http_code": { "type": "integer", "description": "HTTP status code", "nullable": true }, "http_time": { "type": "number", "description": "time taken by HTTP request\nfor tasks set with a pingback/postback, this field will show the time it took your server to respond", "nullable": true }, "http_response": { "type": "string", "description": "HTTP response\nserver response", "nullable": true } } }, "AppDataGoogleAppListingsSearchLiveRequestInfo": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "description": "app categories\noptional field\nthe categories you specify are used to search for app listings;\nyou can get the full list of available app listing categories by this link\nyou can specify up to 10 categories", "nullable": true }, "description": { "type": "string", "description": "keyword in the app\u2019s description\noptional field\nkeywords that occur in the description of the app;\ncan contain up to 200 characters", "nullable": true }, "title": { "type": "string", "description": "keyword in the app\u2019s title\noptional field\nkeywords that occur in the title of the app;\ncan contain up to 200 characters", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "nullable": true }, "description": "array of results filtering parameters\noptional field\nyou can add several filters at once (8 filters maximum)\nyou should set a logical operator and, or between the conditions\nthe following operators are supported:\nregex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like\nyou can use the % operator with like and not_like to match any string of zero or more characters\nexample:\n[\"item.rating.value\",\">\",3]\nyou can receive the list of available filters\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/google/app_listings/available_filters", "nullable": true }, "order_by": { "type": "array", "items": { "type": "string" }, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc \u2013 results will be sorted in the ascending order\ndesc \u2013 results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"item.installs_count,asc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"item.rating.value,desc\",\"item.installs_count,asc\"]", "nullable": true }, "limit": { "type": "integer", "description": "the maximum number of returned apps\noptional field\ndefault value: 100\nmaximum value: 1000", "nullable": true }, "offset": { "type": "integer", "description": "offset in the results array of returned apps\noptional field\ndefault value: 0\nif you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities\nNote: we recommend using this parameter only when retrieving up to 10,000 results\nfor retrieving over 10,000 results, use the offset_token instead.", "nullable": true }, "offset_token": { "type": "string", "description": "token for subsequent requests\noptional field\nprovided in the identical filed of the response to each request;\nuse this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;\nby specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;\noffset_token values are unique for each subsequent task\nNote: if the offset_token is specified in the request, all other parameters should be identical to the previous request\nlearn more about this parameter on our Help Center", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true } }, "example": [ { "title": "vpn", "description": "vpn", "categories": [ "Tools" ], "order_by": [ "item.installs_count,asc" ], "filters": [ [ "item.rating.value", ">", 4.5 ] ], "limit": 10 } ] }, "AppDataAppleAppListTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataAppleAppListTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataAppleAppListTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataAppleAppListTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Apple App List task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Apple App List HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataGoogleAppListTaskGetHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTaskGetHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppListTaskGetHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppListTaskGetHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppListTaskGetHtmlResultInfo": { "type": "object", "properties": { "keyword": { "type": "string", "description": "app collection received in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages and related data", "nullable": true } } }, "AppDataGoogleAppInfoTaskPostResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTaskPostTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppInfoTaskPostTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "object", "description": "array of results\nin this case, the value will be null", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskGetAdvancedResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskGetAdvancedTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTaskGetAdvancedResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskGetAdvancedResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "application id received in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "check_url": { "type": "string", "description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "title": { "type": "string", "description": "title of the app\ntitle of the application for which the reviews are collected", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "rating of the app\nrating of the application for which the reviews are collected", "nullable": true }, "reviews_count": { "type": "integer", "description": "the total number of reviews", "format": "int64", "nullable": true }, "items_count": { "type": "integer", "description": "the number of reviews items in the results array\nyou can get more results by using the depth parameter when setting a task", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/GooglePlayReviewsSearch" } ], "nullable": true }, "description": "found reviews\nyou can get more results by using the depth parameter when setting a task", "nullable": true } } }, "GooglePlayReviewsSearch": { "type": "object", "properties": { "type": { "type": "string", "description": "type of element", "nullable": true }, "rank_group": { "type": "integer", "description": "position within a group of elements with identical type values\npositions of elements with different type values are omitted from rank_group", "nullable": true }, "rank_absolute": { "type": "integer", "description": "absolute rank among all the listed reviews\nabsolute position among all reviews on the list", "nullable": true }, "position": { "type": "string", "description": "the alignment of the review in SERP\ncan take the following values: left", "nullable": true }, "version": { "type": "string", "description": "version of the app\nversion of the app for which the review is submitted", "nullable": true }, "rating": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/RatingInfo" } ], "description": "the rating score submitted by the reviewer", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when the review was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "id": { "type": "string", "description": "id of the review", "nullable": true }, "helpful_count": { "type": "integer", "description": "number of helpful votes\nindicates how many users considered the review helpful and voted with the thumbs up icon", "format": "int64", "nullable": true }, "title": { "type": "string", "description": "title of the review\nGoogle Play doesn\u2019t provide an option to title reviews, so this parameter will always equal null", "nullable": true }, "review_text": { "type": "string", "description": "content of the review", "nullable": true }, "user_profile": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppUserProfileInfo" } ], "description": "user profile of the reviewer", "nullable": true }, "responses": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ResponseDataInfo" } ], "nullable": true }, "description": "response from the developer", "nullable": true } } }, "ResponseDataInfo": { "type": "object", "properties": { "author": { "type": "string", "description": "author of the response", "nullable": true }, "title": { "type": "string", "description": "title of the response\nin this case, will equal null", "nullable": true }, "text": { "type": "string", "description": "content of the response", "nullable": true }, "timestamp": { "type": "string", "description": "date and time when the response was published\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d;\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true } } }, "AppDataGoogleAppReviewsTaskGetHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTaskGetHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskGetHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppReviewsTaskGetHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppReviewsTaskGetHtmlResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "app id received in a POST array", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages and related data", "nullable": true } } }, "AppDataGoogleAppSearchesTasksReadyResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTasksReadyTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTasksReadyTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppSearchesTasksReadyResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppSearchesTasksReadyResultInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "task identifier of the completed task\nunique task identifier in our system in the UUID format", "nullable": true }, "se": { "type": "string", "description": "search engine specified when setting the task", "nullable": true }, "se_type": { "type": "string", "description": "search engine type", "nullable": true }, "date_posted": { "type": "string", "description": "date when the task was posted (in the UTC format)", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier", "nullable": true }, "endpoint_advanced": { "type": "string", "description": "URL for collecting the results of the Google App Searches task", "nullable": true }, "endpoint_html": { "type": "string", "description": "URL for collecting the results of the Google App Searches HTML task\nif HTML tasks are not supported in the specified endpoint, the value will be null", "nullable": true } } }, "AppDataAppleAppListTaskPostRequestInfo": { "type": "object", "properties": { "app_collection": { "type": "string", "description": "app collection\nrequired field\napp collection on App Store from which apps will be collected;\nyou can specify the following values:\ntop_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios" }, "location_name": { "type": "string", "description": "full name of search engine location\nrequired field if you don\u2019t specify location_code\nif you use this field, you don\u2019t need to specify location_code\nyou 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\nexample:\nWest Los Angeles,California,United States", "nullable": true }, "location_code": { "type": "integer", "description": "search engine location code\nrequired field if you don\u2019t specify location_name\nif you use this field, you don\u2019t need to specify location_name\nyou 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\nexample:\n9061121", "nullable": true }, "language_name": { "type": "string", "description": "full name of search engine language\nrequired field if you don\u2019t specify language_code\nif you use this field, you don\u2019t need to specify language_code\nyou 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\nexample:\nEnglish", "nullable": true }, "language_code": { "type": "string", "description": "search engine language code\nrequired field if you don\u2019t specify language_name\nif you use this field, you don\u2019t need to specify language_name\nyou can receive the list of available languages with their language_code\u00a0by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages\nexample:\nen", "nullable": true }, "priority": { "type": "integer", "description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.", "nullable": true }, "depth": { "type": "integer", "description": "parsing depth\noptional field\nnumber of apps to be returned from the App Store SERP;\nwe strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;\ndefault value: 100\nmaximum value: 1000\nYour account will be billed per each SERP containing up to 100 results;\nSetting depth above 100 may result in additional charges if the search engine returns more than 100 results;\nThe cost can be calculated on the Pricing page.", "nullable": true }, "app_category": { "type": "string", "description": "application category on the App Store\noptional field\nyou can filter the results by app category;\nexample:\nlifestyle;\nyou 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", "nullable": true }, "tag": { "type": "string", "description": "user-defined task identifier\noptional field\nthe character limit is 255\nyou can use this parameter to identify the task and match it with the result\nyou will find the specified tag value in the data object of the response", "nullable": true }, "postback_url": { "type": "string", "description": "URL for sending task results\noptional field\nonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nNote: special characters in postback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true }, "postback_data": { "type": "string", "description": "postback_url datatype\nrequired field if you specify postback_url\ncorresponds to the datatype that will be sent to your server\npossible values:\nadvanced", "nullable": true }, "pingback_url": { "type": "string", "description": "notification URL of a completed task\noptional field\nwhen a task is completed we will notify you by GET request sent to the URL you have specified\nyou can use the \u2018$id\u2019 string as a $id variable and \u2018$tag\u2019 as urlencoded $tag variable. We will set the necessary values before sending the request.\nexample:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nNote: special characters in pingback_url will be urlencoded;\ni.a., the # character will be encoded into %23\nlearn more on our Help Center", "nullable": true } }, "example": [ { "app_collection": "top_free_ios", "location_code": 2840, "language_code": "en", "depth": 200, "app_category": "games" } ] }, "AppDataGoogleAppInfoTaskGetHtmlResponseInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTaskGetHtmlTaskInfo" } ], "nullable": true }, "description": "array of tasks", "nullable": true } } } ] }, "AppDataGoogleAppInfoTaskGetHtmlTaskInfo": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AppDataGoogleAppInfoTaskGetHtmlResultInfo" } ], "nullable": true }, "description": "array of results", "nullable": true } } } ] }, "AppDataGoogleAppInfoTaskGetHtmlResultInfo": { "type": "object", "properties": { "app_id": { "type": "string", "description": "application ID received in a POST request", "nullable": true }, "type": { "type": "string", "description": "type of element", "nullable": true }, "se_domain": { "type": "string", "description": "search engine domain in a POST array", "nullable": true }, "location_code": { "type": "integer", "description": "location code in a POST array", "nullable": true }, "language_code": { "type": "string", "description": "language code in a POST array", "nullable": true }, "datetime": { "type": "string", "description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00", "nullable": true }, "items_count": { "type": "integer", "description": "the number of results returned in the items array", "format": "int64", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HtmlItemInfo" } ], "nullable": true }, "description": "HTML pages and related data", "nullable": true } } } } }