NAVNavbar
Logo
cURL php NodeJS Python cSharp

Setting Google Hotel Searches Tasks

‌‌
Hotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// example #1 - a simple way to set a task
// this way requires you to specify a location, a language of search, and a keyword.
$post_array[] = array(
	"location_code" => 1023191,
	"language_code" => "en",
	"keyword" => mb_convert_encoding("cheap hotel", "UTF-8")
);
// example #2 - a way to set a task with additional parameters
// high priority allows us to complete a task faster, but you will be charged more money.
// after a task is completed, we will send a GET request to the address you specify. Instead of $id and $tag, you will receive actual values that are relevant to this task.
$post_array[] = array(
	"location_name" => "New York,New York,United States",
	"language_name" => "English",
	"keyword" => mb_convert_encoding("cheap hotel", "UTF-8"),
	"check_in" => "2021-06-01",
	"check_out" => "2021-06-30",
	"currency" => "USD",
	"adults" => 2,
	"children" => [14],
	"sort_by" => "highest_rating",
	"pingback_url" => 'https://your-server.com/pingscript?id=$id&tag=$tag',
	"priority" => 2,
	"tag" => "example"
);
// this example has 2 elements, but in the case of large number of tasks - send up to 100 elements per POST request
if (count($post_array) > 0) {
	try {
		// POST /v3/business_data/google/hotel_searches/task_post
		$result = $client->post('/v3/business_data/google/hotel_searches/task_post', $post_array);
		print_r($result);
		// do something with post result
	} catch (RestClientException $e) {
		echo "n";
		print "HTTP code: {$e->getHttpCode()}n";
		print "Error code: {$e->getCode()}n";
		print "Message: {$e->getMessage()}n";
		print  $e->getTraceAsString();
		echo "n";
	}
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20210430",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.0886 sec.",
    "cost": 0,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "05111609-1535-0290-0000-9ca15a319474",
            "status_code": 20100,
            "status_message": "Task Created.",
            "time": "0.0059 sec.",
            "cost": 0,
            "result_count": 0,
            "path": [
                "v3",
                "business_data",
                "google",
                "hotel_searches",
                "task_post"
            ],
            "data": {
                "api": "business_data",
                "function": "hotel_searches",
                "se": "google",
                "language_code": "en",
                "location_name": "New York,New York,United States",
                "keyword": "cheap hotel",
                "check_in": "2021-06-01",
                "check_out": "2021-06-30",
                "currency": "USD",
                "adults": 2,
                "children": [
                    14
                ],
                "sort_by": "highest_rating",
                "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag",
                "priority": 2,
                "tag": "example",
                "se_type": "hotels",
                "device": "desktop",
                "os": "windows"
            },
            "result": null
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). Task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, with each POST call containing no more than 100 tasks. If your POST call contains over 100 tasks, the tasks over this limit will return the 40006 error.

You can retrieve the results of completed tasks using the unique task identifier id. Alternatively, we can send them to you as soon as they are ready if you specify the postback_url or pingback_url when setting a task. Note that if your server doesn’t respond within 10 seconds, the connection will be aborted by timeout, and the task will be transferred to the ‘Tasks Ready’ list. The error code and message depend on your server’s configuration. See Help Center to learn more about using pingbacks and postbacks with DataForSEO APIs.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
keyword string 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 symbols in the keyword filed
all %## will be decoded (plus symbol ‘+’ will be decoded to a space character)
if you need to use the “%” symbol for your keyword, please specify it as “%25”;
priority integer task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priority

location_name string full name of search engine location
optional field if you specify location_code or location_coordinate
if you use this field, you don’t need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:
London,England,United Kingdom
location_code integer search engine location code
optional field if you specify location_name or location_coordinate
if you use this field, you don’t need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:
2840
location_coordinate string GPS coordinates of a location
optional field if you specify location_name or location_code
if you use this field, you don’t need to specify location_name or location_code
location_coordinate parameter 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,200
language_name string full name of search engine language
optional field if you 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/business_data/google/languages
example:
English
language_code string search engine language code
optional field if you 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/business_data/google/languages
example:
en
depth integer parsing depth
optional field
number of results in Google Hotels
default value: 12 organic results
max value: 2000
Note: your account will be billed per each 12 organic results regardless of paid listings in the response;
thus, setting a depth above 12 may result in additional charges if Google Hotels return more than 12 results;
if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance
check_in string 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 date
check_out string 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 to check_in;
the range between check_in and check_out values cannot exceed 31 days
currency string currency
optional field
example:
"USD"
adults integer number of adults
optional field
if you don’t specify this field, two adults will be used by default;
note that you can specify up to 4 persons including both adults and children
example:
1
children array 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 0 to 17;
note that you can specify up to 4 persons including both adults and children
set the following value if you want to include one 14-years-old child:
[14]
set the following value if you want to include one 13-years-old child and one 8-years-old child:
[13,8]
stars array 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_rating float minimum rating
optional field
you can use this field to specify guest rating higher than a certain value
example:
2.5
sort_by string results sorting parameters
optional field
you can use this field to sort the results
possible types of sorting:
highest_rating – sort by highest rating
best_match – sort by best match
lower_price – sort by lower price
default value: highest_rating
min_price integer minimum price per night
optional field
the currency of this value depends on the currency field
example:
100
max_price integer maximum price per night
optional field
the currency of this value depends on the currency field
example:
600
free_cancellation boolean hotels with a free cancellation
optional field
set this field to true if you want to get the list of hotels with free cancellation of reservations
default value: false
is_vacation_rentals boolean search for vacation rentals
optional field
set this field to true if you want to get the list of vacation rentals instead of hotels
default value: false
amenities array 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"
tag string 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_url string 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 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 symbols in postback_url will be urlencoded;
i.a., the # symbol will be encoded into %23
pingback_url string 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 symbols in pingback_url will be urlencoded;
i.a., the # symbol will be encoded into %23

‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer 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_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasksarray
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string unique task identifier in our system
in the Universally unique identifier (UUID) format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
        status_message string informational message of the task
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
in this case, the value will be null

‌‌