Overview

Version 3 of the Travel Partner API gives you programmatic access to:

  • Hotel data via the Hotels View API
  • Itinerary and pricing data via the Prices View API
  • Price accuracy data via the Price Accuracy View API
  • Price coverage data via the Price Coverage View API
  • Management of commissions reconciliation reports via the Reconciliation API

API endpoints

The Travel Partner API endpoints are accessible through RESTful syntax from HTTPS calls. The base URL for all requests is:

https://www.googleapis.com/travelpartner/v3/account id

If you do not know your account ID, you can use the Account Info view on the Account tab in the Hotel Ads Center.

Travel Partner APIs and their endpoints
Hotel Views API

Returns the list of hotel views or a summary.


GET /accounts/account id/hotelViews
GET /accounts/account id/hotelViews:summarize

Price Accuracy Views API

Returns a particular price accuracy view, available accuracy views, or a summary.


GET /accounts/account id/priceAccuracyViews/report date
GET /accounts/account id/priceAccuracyViews
GET /accounts/account id/priceAccuracyViews:summarize

Price Coverage Views API

Returns the latest price coverage view or the entire coverage history.


GET /accounts/account id/priceCoverageViews:latest
GET /accounts/account id/priceCoverageViews

Price Views API

Returns the requested price view in full detail.


GET /accounts/account id/priceViews/partner hotel id

Reconciliation Reports API

Creates, validates, and retrieves commissions reconciliation reports.


POST /accounts/account id/reconciliationReports
POST /accounts/account id/reconciliationReports/validate
GET /accounts/account id/reconciliationReports/datetime~filename
GET /accounts/account id/reconciliationReports

Changelog

Many services in Travel Partner API v2.1 have been migrated to Google Ads API. As a result, Travel Partner API v3 retains only hotel specific services.

HotelViewService methods

  1. HotelViewService.ListHotelViews (formerly Hotels API)
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/hotels to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/hotelViews.
    • Removed the type request parameter.
    • Removed the field manifestOnly in the response.
    • Some fields have been renamed.
  2. HotelViewService.SummarizeHotelViews (formerly hotel_list_stats in Scorecard API)
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/scorecard/hotel_list_stats to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/hotelViews:summarize.
    • Some fields have been renamed.

PriceAccuracyViewService methods (formerly price_accuracy report API)

  1. PriceAccuracyViewService.ListPriceAccuracyViews
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reports/price_accuracy to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/priceAccuracyViews.
    • The new API returns a list of hotel view resource names as opposed to the previous version, which returns a list of report dates.
  2. PriceAccuracyViewService.ListPriceAccuracyViews
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reports/price_accuracy/20190909 to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/priceAccuracyViews/20190909.
    • CSV output is no longer supported.
    • Some fields have been renamed.

PriceCoverageViewService methods

  1. PriceAccuracyViewService.ListPriceCoverageViews (formerly price_coverage_stats_history in Scorecard API)
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/scorecard/price_coverage_stats_history to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/priceCoverageViews.
    • Some fields have been renamed.
  2. PriceAccuracyViewService.GetLatestPriceCoverageViews (formerly price_coverage_stats in Scorecard API)
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/scorecard/price_coverage_stats to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/priceCoverageViews:latest.
    • Some fields have been renamed.

PriceViewService method (formerly Prices API)

  • PriceViewService.GetPriceView
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/prices/hotel_id to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/priceViews/hotel_id.
    • Some fields have been renamed.
    • Removed bids information from the response.

ReconciliationReportService methods (formerly Reconciliation Reports API)

  1. ReconciliationReportService.ListReconciliationReports
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reconciliation_reports to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/reconciliationReports.
  2. ReconciliationReportService.GetReconciliationReport
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reconciliation_reports/datetime/filename to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/reconciliationReports/datetime~filename.
  3. ReconciliationReportService.CreateReconciliationReport
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reconciliation_reports to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/reconciliationReports.
  4. ReconciliationReportService.ValidateReconciliationReport
    • API endpoint has changed from https://www.googleapis.com/travelpartner/v2.1/4200042/reconciliation_reports/validate to https://travelpartner.googleapis.com/travelpartner/v3/accounts/4200042/reconciliationReports:validate.

Deprecation

Deprecated
indicates that the version of the API will continue to function as expected, but may not be updated with new features or bug fixes. In addition, when a version is deprecated, a sunset date is determined.
Sunsetted
indicates that the version of the API is removed and is no longer available. The minimum amount of time between deprecation and sunsetting is 3 months.

The following table shows the current schedule of API versions, as well as expected deprecation and sunset dates:

Version Deprecation Date Sunset Date
v3.0 N/A N/A
v2.1 September 2019 December 2019
v2.0 (Bids API) February 2018 May 2018
v2.0 (all other APIs) September 2019 December 2019
v1.2 February 2018 May 2018
v1.1 June 2016 October 2016
v1.0 April 2015 October 2015

Using offsets

When a set of data returned by the Travel Partner API is large enough, you must use an offset to page through the results. You do this with the nextrow query string parameter, as the following example shows:

https://www.googleapis.com/travelpartner/v3.0/420042/hotels?nextrow=131073

The nextrow parameter specifies an offset value which is a unique token that you pass to the API on your second and subsequent requests. When you include nextrow in your query, the Travel Partner API applies it to the request and gives you the next set of results, starting with the value of nextrow.

The value of nextrow is not an integer that simply defines an index offset. Instead, it is a unique identifier that the Travel Partner API uses to determine which set of results to use. As a result, your first request should never include this parameter. Responses that are incomplete will have NEXTROW: value as the first line in each response; for example:

NEXTROW: 131073

To offset your next request, you extract the value of NEXTROW from the response body and set it as the value of the nextrow query string parameter in your next request.

Authentication

To access the Travel Partner API, clients must authenticate using OAuth2 authentication.

For an example application and additional information about using OAuth to connect to the Travel Partner API, refer to API Authentication.