資料 API / DataForSEO / Business Data
Setting Google Hotel Searches Tasks
Queues a Google Hotels search, 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_hotel_searches_fetch.
參數
沒有路徑、查詢或請求標頭參數。
請求主體
keywordstring選填keyword optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify up to 700 characters in the
keywordfiled 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”; Note: in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations ofkeywordandkeywordsfields in DataForSEO APIs 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 tohttps://api.dataforseo.com/v3/business_data/google/locationsexample:London,England,United KingdomNote: in order to obtain accurate search results, thelocation_nameyou specify will be automatically appended to the keywordlocation_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” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example:53.476225,-2.243572language_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 tohttps://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 tohttps://api.dataforseo.com/v3/business_data/google/languagesexample:endepthinteger選填parsing depth optional field number of results in Google Hotels default value:
20organic results max value:140Note: your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above20may result in additional charges if Google Hotels return more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balancecheck_instring選填check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; date format:
"yyyy-mm-dd"example:"2019-01-15"Note: the value cannot precede the today’s datecheck_outstring選填check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format:
"yyyy-mm-dd"example:"2019-01-15"Note: the value cannot be less than or equal tocheck_in; the range betweencheck_inandcheck_outvalues cannot exceed 30 dayscurrencystring選填currency optional field example:
"USD"adultsinteger選填number of adults optional field if you don’t specify this field, the default value of
2will be applied; note that you can specify up to 6 persons including both adults and children example:1childreninteger[]選填number and age of children optional field if you don’t specify this field, no children will be included in the search; age of child can be from
0to17; note that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child:[14]set the following value if you want to include one 13-year-old child and one 8-year-old child:[13,8]starsinteger[]選填hotel stars optional field set this field to
[5]if you want to get the list of 5-star hotels only example:[3,4,5]min_ratingnumber選填minimum rating optional field you can use this field to specify guest rating higher than a certain value example:
2.5sort_bystring選填results sorting parameters optional field you can use this field to sort the results possible types of sorting:
relevance– sort by most relevantlowest_price– sort by the lowest pricehighest_rating– sort by highest ratingmost_reviewed– sort by most reviewed default value:relevancemin_priceinteger選填minimum price per night optional field the currency of this value depends on the
currencyfield example:100max_priceinteger選填maximum price per night optional field the currency of this value depends on the
currencyfield example:600free_cancellationboolean選填hotels with a free cancellation optional field set this field to
trueif you want to get the list of hotels with free cancellation of reservations default value:falseis_vacation_rentalsboolean選填search for vacation rentals optional field set this field to
trueif you want to get the list of vacation rentals instead of hotels default value:falseamenitiesstring[]選填hotel amenities optional field you can use this field to specify different hotel amenities example:
[ "free_parking", "pets_allowed" ]possible values:"air_conditioning","all_inclusive_available","bar","free_breakfast","fitness_center","kid_friendly","free_parking","pets_allowed","pool","restaurant","room_service","spa","free_wifi","parking","indoor_pool","outdoor_pool","wheelchair_accessible","beach_access"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
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/hotel_searches/task_post" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<string>",
"priority": 0,
"location_name": "<string>",
"location_code": 0,
"location_coordinate": "<string>",
"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