Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Setting Google Hotel Searches Tasks

伺服器:https://openapi.felo.ai
用戶端程式庫

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility 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.

請求本文
必填
application/json
  • 類型: array object[]
    • 類型: object
      • adults
        類型: integer

        number of adults optional field if you don’t specify this field, the default value of 2 will be applied; note that you can specify up to 6 persons including both adults and children example: 1

      • amenities
        類型: array string[]

        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"

      • 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 30 days

      • children
        類型: array integer[]

        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 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]

      • currency
        類型: string

        currency optional field example: "USD"

      • depth
        類型: integer

        parsing depth optional field number of results in Google Hotels default value: 20 organic results max value: 140 Note: your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above 20 may 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 balance

      • 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

      • 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 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, 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 of keyword and keywords fields in DataForSEO APIs in this Help Center article

      • language_code
        類型: string

        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/business_data/google/languages example: en

      • language_name
        類型: string

        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/business_data/google/languages example: English

      • location_code
        類型: integer

        search engine location code required field if you don’t 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 required field if you don’t 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” 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.243572

      • location_name
        類型: string

        full name of search engine location required field if you don’t 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 Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword

      • max_price
        類型: integer

        maximum price per night optional field the currency of this value depends on the currency field example: 600

      • min_price
        類型: integer

        minimum price per night optional field the currency of this value depends on the currency field example: 100

      • min_rating
        類型: number

        minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5

      • 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 characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center

      • 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 characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23learn more on our Help Center

      • priority
        類型: integer

        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.

      • sort_by
        類型: string

        results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest rating most_reviewed – sort by most reviewed default value: relevance

      • stars
        類型: array integer[]

        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]

      • 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

      空物件
      空物件
回應
  • 200
    類型: object

    Successful response

    • result
      類型: array string[]

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

    • tasks
      類型: array string[]

      array of tasks

    • tasks.cost
      類型: number

      cost of the task, USD

    • tasks.data
      類型: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      類型: string

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

    • tasks.path
      類型: array string[]

      URL path

    • tasks.result_count
      類型: integer

      number of elements in the result array

    • tasks.status_code
      類型: integer

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

    • tasks.status_message
      類型: string

      informational message of the task

    • tasks.time
      類型: string

      execution time, seconds

    • version
      類型: string

      the current version of the API

    • version.cost
      類型: number

      total tasks cost, USD

    • version.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

    • version.status_message
      類型: string

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

    • version.tasks_count
      類型: integer

      *the number of tasks in the **tasks*array

    • version.tasks_error
      類型: integer

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

    • version.time
      類型: string

      execution time, seconds

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/business_data/google/hotel_searches/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/hotel_searches/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'
{
  "version": "string",
  "version.status_code": 1,
  "version.status_message": "string",
  "version.time": "string",
  "version.cost": 1,
  "version.tasks_count": 1,
  "version.tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "result": [
    "string"
  ]
}
Setting Google Hotel Searches Tasks