Data API / DataForSEO / Business Data
Setting Business Data Google Reviews Tasks
Queues Google Business Profile reviews, 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_google_reviews_fetch; the profile itself is post_dataforseo_business_google_gmb_info_live.
Параметры
Параметров пути, запроса и заголовков нет.
Тело запроса
keywordstringНеобязательныйkeyword required field if you don’t specify
cidorplace_idthe keyword you specify should indicate the name of the local establishment; 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”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations ofkeywordandkeywordsfields in DataForSEO APIs in this Help Center articlecidstringНеобязательныйunique, google-defined id of the business entity required field if you don’t specify
keywordorplace_idexample:194604053573767737learn more about the identifier in this help center articleplace_idstringНеобязательныйidentifier of the business entity in Google Maps required field if you don’t specify
keywordorcidexample:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the identifier in this help center articlepriorityintegerНеобязательный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.
location_namestringНеобязательныйfull name of search engine location required field if you don’t specify
location_codeorlocation_coordinateif you use this field, you don’t need to specifylocation_codeorlocation_coordinateyou can receive the list of available locations withlocation_nameby making a separate request to thehttps://api.dataforseo.com/v3/business_data/google/locationsexample:London,England,United Kingdomlocation_codeintegerНеобязательныйsearch engine location code required field if you don’t specify
location_nameorlocation_coordinateif you use this field, you don’t need to specifylocation_nameorlocation_coordinateyou can receive the list of available locations withlocation_codeby making a separate request to thehttps://api.dataforseo.com/v3/business_data/google/locationsexample:2840location_coordinatestringНеобязательныйGPS coordinates of a location required field if you don’t specify
location_nameorlocation_codeif you use this field, you don’t need to specifylocation_nameorlocation_codelocation_coordinateparameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example:53.476225,-2.243572,200language_namestringНеобязательныйfull name of search engine language required field if you don’t specify
language_codeif you use this field, you don’t need to specifylanguage_codeyou can receive the list of available languages withlanguage_nameby making a separate request to thehttps://api.dataforseo.com/v3/business_data/google/languagesexample:Englishlanguage_codestringНеобязательныйsearch engine language code required field if you don’t specify
language_nameif you use this field, you don’t need to specifylanguage_nameyou can receive the list of available languages with theirlanguage_codeby making a separate request to thehttps://api.dataforseo.com/v3/business_data/google/languagesexample:endepthintegerНеобязательный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:
10maximum 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.sort_bystringНеобязательныйresults sorting parameters optional field you can use this field to sort the results possible types of sorting:
newest– sort by newest firsthighest_rating– sort by highest ratinglowest_rating– sort by lowest ratingrelevant– sort by relevance default value:relevanttagstringНеобязательный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/google/reviews/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<string>",
"cid": "<string>",
"place_id": "<string>",
"priority": 0,
"location_name": "<string>",
"location_code": 0,
"location_coordinate": "<string>",
"language_name": "<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
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