Scorecard API v1.2

The Scorecard API returns values displayed in the Hotel Ads Center's Scorecard view.

Request Syntax

Path: /scorecard/get?partner=partner_name&query_type=query_type

Parameters:

Parameter Required? Description
partner Optional Identifies the specific account for which you are requesting data. The value of this parameter is the partner name (not the partner ID, which is a number). If you do not know the partner name, contact us to request it.
query_type Required

Specifies the type of Scorecard data to remove. Possible values are:

  • "price_accuracy_score": Gets the Price Accuracy Score of the specified partner.
  • "hotel_list_stats": Returns the statistics about the list of hotels that are displayed in the Account Health section of the Hotel Ads Center Scorecard view.
  • "price_coverage_stats": Returns the coverage statistics that are displayed in the Account Health section of the Hotel Ads Center Scorecard view. For more information, see the Prices Coverage Report section.
  • "price_coverage_stats_history": Returns the coverage statistics history that is displayed in the Account Health section of the Hotel Ads Center Scorecard view. For more information, see the Prices Coverage Report section.
  • "performance_stats": Returns the performance statistics that are displayed in the Performance section of the Hotel Ads center Scorecard view. For more information, see the Opportunity Report section.
  • "opportunity_stats": Returns the values displayed on the Opportunity section of the Hotel Ads Center Scorecard view. For more information, see the Performance Report with Conversion Metrics section.
  • "configuration_stats": Returns the configuration statistics that are displayed in the Scorecard view of the Hotel Ads Center.

Example Request

The following example request gets the Price Accuracy Score for the specified partner:

https://www.googleapis.com/travelpartner/v1.2/scorecard/get?partner=3way&query_type=price_accuracy_score

Response Syntax

The Scorecard API returns a resource object in JSON format:

Field Description
resource Contains objects based on the type of data requested. Possible objects are:
  • priceaccuracy_stats: Indicates the partner's Price Accuracy Score. Contains one object:
    • score: Contains one property:

      • state: Possible values of the state property are:
        • "EXCELLENT"
        • "GOOD"
        • "POOR"
        • "AT_RISK"
        • "FAILED"

For information about these values, see Price Accuracy Policy.

The following example shows a response for a "price_accuracy_score" request:

{
  "resource": {
    "priceaccuracy_stats": {
      "score": {
        "state": "GOOD"
      }
    }
  }
}

Scorecard API Changes

There were six new query_type values added to version 1.2 of the Scorecard API since version 1.1 (sunsetted).

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.