Method: accounts.priceAccuracyViews.summarize

  • The summarize method returns the price accuracy summary for a specified account.

  • The request uses a GET HTTP method and requires the account ID as a path parameter.

  • The request body must be empty.

  • The response body contains current and predicted price accuracy scores for website, Book on Google, and overall, along with an update timestamp.

  • The API requires authorization with the https://www.googleapis.com/auth/travelpartner scope.

Returns the price accuracy summary.

HTTP request

GET https://travelpartner.googleapis.com/v3/{parent=accounts/*}/priceAccuracyViews:summarize

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The resource name of the account that is being queried. The format is accounts/{account_id}.

Request body

The request body must be empty.

Response body

Response message for PriceAccuracyViewService.SummarizePriceAccuracy.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "currentScore": enum (PriceAccuracyState),
  "currentWebsiteScore": enum (PriceAccuracyState),
  "currentBookOnGoogleScore": enum (PriceAccuracyState),
  "currentOverallScore": enum (PriceAccuracyState),
  "updateTime": string,
  "predictedScore": enum (PriceAccuracyState),
  "predictedWebsiteScore": enum (PriceAccuracyState),
  "predictedBookOnGoogleScore": enum (PriceAccuracyState),
  "predictedOverallScore": enum (PriceAccuracyState)
}
Fields
currentScore
(deprecated)

enum (PriceAccuracyState)

The current price accuracy score. Contains the same value as currentWebsiteScore. For clarity, use either currentWebsiteScore or 'currentOverallScore` depending upon which is needed.
currentWebsiteScore

enum (PriceAccuracyState)

The current website price accuracy score.
currentBookOnGoogleScore

enum (PriceAccuracyState)

The current Book on Google price accuracy score.
currentOverallScore

enum (PriceAccuracyState)

The current price accuracy score combining both website and Book on Google scores.
updateTime

string (Timestamp format)

The update timestamp for the current score.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
predictedScore
(deprecated)

enum (PriceAccuracyState)

The predicted price accuracy score. Contains the same value as predictedWebsiteScore. For clarity, use either predictedWebsiteScore or 'predictedOverallScore` depending upon which is needed.
predictedWebsiteScore

enum (PriceAccuracyState)

The predicted website price accuracy score.
predictedBookOnGoogleScore

enum (PriceAccuracyState)

The predicted Book on Google price accuracy score.
predictedOverallScore

enum (PriceAccuracyState)

The predicted price accuracy score combining both website and Book on Google scores.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/travelpartner

For more information, see the OAuth 2.0 Overview.

PriceAccuracyState

Enumerates supported price accuracy states.

Enums
PRICE_ACCURACY_STATE_UNSPECIFIED Not specified.
PRICE_ACCURACY_STATE_UNKNOWN The value is unknown in this version.
EXCELLENT Average score exceeds the positioning threshold.
GOOD Average score is slightly below the positioning threshold. “Good” has been renamed to “Fair” in Hotel Center.
POOR Average score is well below the positioning threshold.
AT_RISK Average score is close to the account suspension threshold.
FAILED Average score is below the account suspension threshold.