Bids API v1.2

The Bids API retrieves the most recent bids that you have submitted, including any multipliers applied to those bids.

Bids API Path

  • Path: /bids

Bids API Input Parameters

The following table lists the input parameters for the Bids API endpoint:

Input Parameter Required? Description
alt Optional Specifies the result format. Valid values are:
  • "csv": Returns results as CSV (comma-separated values).
  • "json": Returns results as JSON. This is the default.
nextrow Optional Specifies an offset for your query. For more information, see Using Offsets.
maxresults Optional Specifies the maximum number of hotel bids to be shown in results. Valid values are positive integers up to 16,384 (2^14). The default value is 16,384.
partner Optional Identifies the technical name of the account that you are requesting data for. The value of this parameter is not the same as the partner name in the Hotel Ads Center or the partner ID (which is a number). If you do not know the technical name, contact us to request it.
partnerHotelIds Optional Restricts the retrieved bids to the specified hotels. You can specify more than one by using a comma-separated list. If you do not specify a value for this property, then the Bids API returns bids for all properties, up to the maximum number of results (maxresults).

For more information, see Submitting Bids.

The following example request gets all bids:

https://www.googleapis.com/travelpartner/v1.2/bids

The following example request gets bids for two specific hotels (with IDs "hotel3" and "hotel42") in CSV format:

https://www.googleapis.com/travelpartner/v1.2/bids?alt=csv&partnerHotelIds=hotel3,hotel42

Bids API Results

The Bids API returns details about bids that you have made. The following table describes possible values for the returned fields:

Field Name Description
Property/GroupName/[empty] One of the following:
  • Property: This is the unique identifier for the hotel. If this value appears, then the bid was for an individual hotel.
  • GroupName: This is the name of a bidding group. If this value appears, then the bid was for an entire Hotel Group.

If neither Property nor GroupName appears, then the bid was the account default bid.

BiddingGroupMembership Name of the bidding group from which this property derives its bids.
Type The type of bid. Possible values are:
  • "BID_FIXED": The bid is a fixed value.
  • "BID_PERCENTAGE": The bid is a percentage of the total cost for the property.
BidRate The amount of the bid as either a fixed number or a percentage (see Type).
BaseBidSource The hotel bid may inherit base bid information from the Group bid or the Account (Partner) Default bid (or it may not inherit at all). Possible values are "FROM_PARTNER", "FROM_GROUP", and "FROM_HOTEL".
MultiplierSource Like BaseBidSource, the multipliers may be inherited. Possible values are "FROM_PARTNER", "FROM_GROUP", and "FROM_HOTEL".
Currency The three-letter currency code for the currency in which the bid was placed.
LastUpdateTime The time of the most recent bid for the property, as a timestamp.
BidMultipliers Specifies an array of bid multipliers, if any. Each object in the array includes the value of the multiplier, plus an array of values for that dimension. Child elements are:

MultiplierThe value of the bid multiplier for the current dimension, as a floating point value.
SitesSpecifies an array of values for the bid's site dimension; valid values are "mapsresults", "localuniversal", and "placepage".
UserCountrySpecifies an array of two-letter country codes for the bid's country dimension.
DeviceTypesSpecifies an array of device types for the bid's device type dimension.
LengthOfStayMinNightsSpecifies an array of integers for the bid's length of stay dimension. Values are an integer from 1 through 14.
CheckinDaysOfWeekSpecifies an array of days for the bid's day of week dimension. Possible values are "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", and "Sunday".
AdvanceBookingWindowMinDaysSpecifies a multiplier based on the number of days in advance an end-user books.

CSV Result Example

The following example shows the response from a Bids API call in CSV format:

Download the following example CSV result file: v11-Bids.csv

JSON Result Example

The following example shows the response from a Bids API call in JSON format:

{
  "kind": "travelpartner#bids",
  "Bids": [
    {
      // no GroupName or Property indicates an account default bid
      "Type": "BID_PERCENTAGE",
      "BidRate": 4.75,
      "LastUpdateTime": "2014-05-27 12:10:34",
      "BaseBidSource": "FROM_PARTNER",
      "MultiplierSource": "FROM_PARTNER",
      "BidMultipliers": [
        {
          "Multiplier": 0.8,
          "DeviceTypes": [
            "mobile"
          ]
        }
      ]
    },
    {
      "GroupName": "EdwardBrand",
      "Type": "BID_FIXED",
      "BidRate": 3.5,
      "Currency": "USD",
      "LastUpdateTime": "2014-10-16 17:44:15",
      "BaseBidSource": "FROM_GROUP",
      "MultiplierSource": "FROM_PARTNER",
      "BidMultipliers": [
        {
          "Multiplier": 0.2,
          "LengthOfStayMinNights": 11
        },
        {
          "Multiplier": 1.25,
          "DeviceTypes": [
            "mobile"
          ]
        },
      ]
    },
    {
      "Property": "AOCEAA",
      "Type": "BID_PERCENTAGE",
      "BidRate": 2.0,
      "LastUpdateTime": "2014-05-27 12:13:41",
      "BaseBidSource": "FROM_HOTEL",
      "MultiplierSource": "FROM_PARTNER",
      "BidMultipliers": [
        {
          "Multiplier": 0.8,
          "DeviceTypes": [
            "mobile"
          ]
        }
      ]
    },
    {
      "Property": "GPFNBH",
      "Type": "BID_FIXED",
      "BidRate": 5.0,
      "Currency": "USD",
      "LastUpdateTime": "2014-05-27 11:15:46",
      "BaseBidSource": "FROM_HOTEL",
      "MultiplierSource": "FROM_GROUP",
      "BiddingGroupMembership": "Conrad",
      "BidMultipliers": [
        {
          "Multiplier": 0.2,
          "LengthOfStayMinNights": 11
        },
        {
          "Multiplier": 1.25,
          "DeviceTypes": [
            "mobile"
          ]
        },
      ]
    },
  {
   "Property": "PFNBH",
   "Type": "BID_FIXED",
   "BidRate": 5.0,
   "Currency": "USD",
   "LastUpdateTime": "2014-05-27 11:15:46",
   "BaseBidSource": "FROM_HOTEL",
   "MultiplierSource": "FROM_HOTEL",
   "BidMultipliers": [
    {
     "Multiplier": 0.8,
     "DeviceTypes": [
      "mobile"
     ]
    },
    {
      "Multiplier": 1.1,
      "CheckinDaysOfWeek": [
        "Monday",
        "Wednesday",
        "Friday",
        "Sunday"
      ]
    },
    {
      "Multiplier": 1.1,
      "AdvanceBookingWindowMinDays": 7
    },
    {
      "Multiplier": 1.2,
      "AdvanceBookingWindowMinDays": 14
    },
    {
      "Multiplier": 1.0,
      "AdvanceBookingWindowMinDays": 30
    },
    {
      "Multiplier": 0.8,
      "AdvanceBookingWindowMinDays": 60
    }
   ]
  }
  ],
  "nextPageToken": 4
}

Bids API Changes

The CSV and JSON results have changed since version 1.1 (sunsetted):

Support for the Advance Booking Window and Days of Week bid multipliers.

The JSON response has the following new objects:

  • AdvanceBookingWindowMinDays
  • CheckinDaysOfWeek

The CSV file has the following new fields:

  • checkin_monday
  • checkin_tuesday
  • checkin_wednesday
  • checkin_thursday
  • checkin_friday
  • checkin_saturday
  • checkin_sunday
  • advance_booking_window_min_days_1
  • advance_booking_window_multiplier_1
  • advance_booking_window_min_days_2
  • advance_booking_window_multiplier_2
  • advance_booking_window_min_days_3
  • advance_booking_window_multiplier_3
  • advance_booking_window_min_days_4
  • advance_booking_window_multiplier_4
  • advance_booking_window_min_days_5
  • advance_booking_window_multiplier_5
  • advance_booking_window_min_days_6
  • advance_booking_window_multiplier_6
  • advance_booking_window_min_days_7
  • advance_booking_window_multiplier_7
  • advance_booking_window_min_days_8
  • advance_booking_window_multiplier_8
  • advance_booking_window_min_days_9
  • advance_booking_window_multiplier_9
  • advance_booking_window_min_days_10
  • advance_booking_window_multiplier_10

Send feedback about...

Need help? Visit our support page.