Feed Status v2.0

The Feed Status API returns a report of your feeds, including errors and warnings that Google encountered when processing those feeds. It provides the same results as the Feed Status tool in Hotel Ads Center.

Path

base_path/api_version/account_id/feed_status

Where:

Path Parameter Description
base_path https://www.googleapis.com/travelpartner
api_version v2.0
account_id The master account ID. If you specify a sub account, this API does not return any results.

Query String Parameters

Parameter Description
start_time Filters the results to only the past X microseconds, where X is the value of this parameter. If end_time is also set, then this value is the beginning of the date/time range, counted in microseconds since 1970-01-01 00:00:00 UTC. For example, "1447273853491000" refers to Wed, 11 Nov 2015 20:30:53 GMT.

This parameter is optional.

end_time Sets the end of the date/time range. The value of this parameter is the number of microseconds since 1970-01-01 00:00:00 UTC.

This parameter is optional.

file_type Filters the results by one of the following file types:
  • "hints"
  • "transactions"
  • "query_control"
  • "hotel_info"
  • "bid" (Hotel Ads only)

This parameter is required.

Supported Methods

HTTP Method Description
GET Gets details about the specified feed.

Examples

Gets the transactions report:

GET https://www.googleapis.com/travelpartner/v2.0/4200042/feed_status?file_type=transactions

Gets the transactions report starting at 1447273853491000:

GET https://www.googleapis.com/travelpartner/v2.0/4200042/feed_status?file_type=transactions&start_time=1447273853491000

Gets the transactions report starting at 1447273853491000 and ending at 1447273853551642:

GET https://www.googleapis.com/travelpartner/v2.0/4200042/feed_status?file_type=transactions&start_time=1447273853491000&end_time=1447273853551642

Getting Feed Status

You can use the Feed Status API to get information about various feeds. You typically get the status of a particular feed in a specified time period.

To get the status of a feed, send a GET request the following URL syntax:

GET https://www.googleapis.com/travelpartner/v2.0/account_id/feed_status?file_type=file_type&
  [start_time=time_in_milliseconds&end_time=time_in_milliseconds]

The following example requests transactions, with a specified start and end time, for the account 4200042:

GET https://www.googleapis.com/travelpartner/v2.0/4200042/feed_status?
  file_type=transactions&start_time=1447273853491000&end_time=1447273853551642

The Feed Status API sends a response that contains details about the specified feed.

The following sample response contains details and a list of errors for the transaction feed:

{
  "kind": "travelpartner#feed_status",
  "results": [
    {
      "partner": "PartnerStringID",
      "timestamp": "1425413283555203",
      "partner_timestamp": "14254132164242",
      "partner_id": "4200042",
      "feed_type": "transactions",
      "file_pulled": false,
      "status": "ERRORS",
      "error_count": 388,
      "success_count": 8012,
      "errors": [
        {
          "code": "1031",
          "issue_type": "ERROR",
          "byte_index": "5919",
          "message": "Unable to find a Google Hotel ID for partner PartnerStringID,
            partner hotel id 392048."
        },
        {
          "code": "1031",
          "issue_type": "ERROR",
          "byte_index": "17913",
          "message": "Unable to find a Google Hotel ID for partner PartnerStringID,
            partner hotel id 392167."
        },
        {
          "code": "1034",
          "issue_type": "ERROR",
          "byte_index": "113544",
          "message": "Hotel 481754, 2015-03-06 3: Invalid price -4873.379883 USD
            for Room Bundle 2017216342. Baserate: -4873.379883 invalid."
        },
        {
          "code": "1034",
          "issue_type": "ERROR",
          "byte_index": "113807",
          "message": "Hotel 481754, 2015-03-06 3: Invalid price -4806.180176 USD
            for Room Bundle 204216307. Baserate: -4806.180176 invalid."
        }
      ]
    },
    {
      "partner": "PartnerStringID",
      "timestamp": "1425413267861072",
      "feed_type": "hotel_info",
      "file_pulled": false,
      "status": "ERRORS",
      "error_count": 34,
      "success_count": 8181,
      "errors": [
        {
          "code": "4010",
          "issue_type": "ERROR",
          "byte_index": "356357",
          "message": "Cannot store data for partner PartnerStringID, property 310704;
            there is no matching Google hotel ID."
        },
        {
          "code": "4010",
          "issue_type": "ERROR",
          "byte_index": "1576615",
          "message": "Cannot store data for partner PartnerStringID, property 286729; 
            there is no matching Google hotel ID."
        }
      ]
    },
    {
      "partner": "PartnerStringID",
      "timestamp": "1425413117432568",
      "partner_timestamp": "1425413110",
      "partner_id": "7a069461-4905-4702-acce-de9bc1124d74",
      "feed_type": "transactions",
      "file_pulled": false,
      "status": "ERRORS",
      "error_count": 1215,
      "success_count": 7185,
      "errors": [
        {
          "code": "1031",
          "issue_type": "ERROR",
          "byte_index": "3111",
          "message": "Unable to find a Google Hotel ID for partner PartnerStringID,
            partner hotel id 389727."
        },
        {
          "code": "1031",
          "issue_type": "ERROR",
          "byte_index": "10927",
          "message": "Unable to find a Google Hotel ID for partner PartnerStringID,
            partner hotel id 389356."
        },
        {
          "code": "1051",
          "issue_type": "ERROR",
          "byte_index": "13589",
          "message": "Did not store results due to duplicated key 2ff42219b42ea41d:
            2015-04-01:001:PartnerStringID, with different existing partner hotel
            id 389363 and new value 389344."
        }
      ]
    }
  ]
}

The following table describes values for the returned fields:

Field Description
partner The partner ID of the account for which you are getting a feed status.
timestamp The epoch, in microseconds.
partner_timestamp The timestamp for when the data (such as a Transaction message) was submitted, if set. You set this value when you make an update request with the Bids API.
partner_id A unique ID for the transaction, if set. You set this value when you make an update request with the Bids API.
feed_type The type of data feed. Possible values are:

  • "hotel_info": The Hotel List feeds.
  • "bid": Bid messages (Hotel Ads only).
  • "taxes_fees": Tax and Fee table feed.
  • "transactions": The Query messages (Google's request) and Transaction messages (your response) if you use Pull or Pull with Hints.
  • "ota_push_avail": The pricing/availability feed.
file_pulled "true" if Google requested the file from the partner; "false" if the file was sent from the partner to Google.
status Indicates the feed's status. Possible values are:
  • "SUCCESS": The feed contains no errors or warnings. The entire feed was processed.
  • "WARNINGS": The feed contains warnings, which indicates that the feed was processed but it might contain issues that need attention.
  • "ERRORS": The feed contains errors, which means that part of the feed was not processed.
  • "FAILURE": No part of the feed was processed.
error_count The total number of "ERRORS" in this file.
warning_count The total number of "WARNINGS" in this file.
success_count The total number of successfully processed items in this file.
errors Contains an array of error objects. Error objects have the following properties:

  • code: A code indicating the type of error. You can view the descriptions, and possible remediations, by using the Feed Status tool.
  • issue_type: "ERROR".
  • byte_index: The position in the feed where the error was triggered.
  • message: The error message.
warnings Contains warning objects, which are the same as error objects, except the issue_type is "WARNING".

To download the file itself (that you sent), use the Hotel Ads Center.

Feed Status API Changes

Changes to v2.0 of the Feed Status API include the following:

  • All results are returned as JSON.
  • The Feed Status API uses the new RESTful syntax.