Felo API PlatformFelo API Platform

데이터 API / DataForSEO / App Data

Setting Apple App Reviews Tasks

Queues the reviews of one App Store app by app_id, returning a task id. depth sets how many to collect. Asynchronous: submit returns a task id in tasks[0].id and the fetch tool returns the result once ready. Retrieve with get_dataforseo_app_apple_app_reviews_fetch.

파라미터

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

요청 본문

  • app_idstring필수

    id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320

  • location_namestring선택

    full name of search engine location required field if you don’t specify location_code if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: West Los Angeles,California,United States

  • location_codeinteger선택

    search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121

  • language_namestring선택

    full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English

  • language_codestring선택

    search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en

  • priorityinteger선택

    task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.

  • depthinteger선택

    parsing depth optional field number of reviews to be returned in the API response; we strongly recommend setting the parsing depth in the multiples of 50, because our system processes 50 reviews in a row; default value: 50; maximum value: 500; Your account will be billed per each SERP containing up to 50 results; Setting depth above 50 may result in additional charges if the search engine returns more than 50 results; The cost can be calculated on the Pricing page.

  • sort_bystring선택

    results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default rule: most_helpful

  • tagstring선택

    user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

  • postback_urlstring선택

    URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center

  • postback_datastring선택

    postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced

  • pingback_urlstring선택

    notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center

요청 예시

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/app_data/apple/app_reviews/task_post" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_id": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "priority": 0,
  "depth": 0,
  "sort_by": "<string>"
}'

응답

응답 필드

  • versionstring선택

    the current version of the API

  • status_codeinteger선택

    general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

  • status_messagestring선택

    general informational message you can find the full list of general informational messages here

  • timestring선택

    execution time, seconds

  • costnumber선택

    total tasks cost, USD

  • tasks_countinteger선택

    the number of tasks in the tasksarray

  • tasks_errorinteger선택

    the number of tasks in the tasks array returned with an error

  • tasksstring[]선택

    array of tasks

  • idstring선택

    unique task identifier in our system in the Universally unique identifier (UUID) format

  • status_codeinteger선택

    status code of the task generated by DataForSEO; can be within the following range: 10000-60000

  • status_messagestring선택

    informational message of the task

  • timestring선택

    execution time, seconds

  • costnumber선택

    cost of the task, USD

  • result_countinteger선택

    number of elements in the result array

  • pathstring[]선택

    URL path

  • dataobject선택

    contains the same parameters that you specified in the POST request

  • resultstring[]선택

    array of results in this case, the value will be null