データ API / DataForSEO / Business Data
Setting Business Data Tripadvisor Reviews Tasks
Queues Tripadvisor reviews for one property, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_business_tripadvisor_reviews_fetch; the Trustpilot equivalent is post_dataforseo_business_trustpilot_reviews_submit.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
url_pathstring任意URL path of the business entity required field if you do not specify
keywordURL path to the Tripadvisor page of the business entity; examples:Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.htmlhttps://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.htmlkeywordstring任意keyword required field if you do not specify
url_paththe keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in thekeywordfiled; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for yourkeyword, please specify it as “%25”location_namestring任意full name of search engine location required field if you don’t specify
location_codeorurl_pathyou can receive the list of available locations withlocation_nameby making a separate request to thehttps://api.dataforseo.com/v3/business_data/tripadvisor/locationsexample:London,England,United Kingdomlocation_codeinteger任意search engine location code required field if you don’t specify
location_nameorurl_pathyou can receive the list of available locations withlocation_codeby making a separate request to thehttps://api.dataforseo.com/v3/business_data/tripadvisor/locationsexample:1003854priorityinteger任意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.
language_namestring任意full name of search engine language optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with
language_nameby making a separate request to thehttps://api.dataforseo.com/v3/business_data/tripadvisor/languagesexample:EnglishYou will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the Pricing page.language_codestring任意search engine language code optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with
language_codeby making a separate request to thehttps://api.dataforseo.com/v3/business_data/tripadvisor/languagesexample:enYou will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the Pricing page.depthinteger任意parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value:
10; max value:4490Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.ratingsstring[]任意Tripadvisor traveler rating for a place of interest optional field rating based on the written reviews by a traveler after they visited a place. possible values:
excellent,very_good,average,poor,terribleyou can specify several values at oncevisit_typestring[]任意filter by type of travelers who left a review optional field possible values:
families,couples,solo,business,friendsyou can specify several values at oncemonthsstring[]任意filter by months when a traveler made a visit optional field possible values:
january,february,march,april,may,april,june,july,august,september,october,november,decemberyou can specify several values at oncesearch_reviews_keywordstring任意search reviews containing a specified keyword example:
dessertsort_bystring任意results sorting parameters optional field you can use this field to sort the results; possible types of sorting:
most_recentdetailed_reviewstranslate_reviewsboolean任意translate reviews according to the URL path optional field if set to
true, returned reviews will be translated to the language matching the specifiedurl_path; for example, ifurl_pathcontainstripadvisor.itandtranslate_reviewsistrue, reviews will be translated to the Italian language; default value:trueyou can learn more about how reviews are translated in this Help Center articletagstring任意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
tagvalue in thedataobject of the responsepostback_urlstring任意return URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the
gzipformat to thepostback_urlyou specified you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request. example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tagNote: special characters inpostback_urlwill be urlencoded; i.a., the#character will be encoded into%23learn more on our Help Centerpingback_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
$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request. example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tagNote: special characters inpingback_urlwill be urlencoded; i.a., the#character will be encoded into%23learn more on our Help Center
リクエスト例
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/business_data/tripadvisor/reviews/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url_path": "<string>",
"keyword": "<string>",
"location_name": "<string>",
"location_code": 0,
"priority": 0,
"language_name": "<string>",
"language_code": "<string>",
"depth": 0
}'レスポンス
レスポンスのフィールド
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
tasksarray 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
resultarraypathstring[]任意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