REST Resource: accounts.priceCoverageViews
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PriceCoverageView
JSON representation |
{
"calculationDate": {
object (Date )
},
"matchedPropertyCount": integer,
"priceCoverageBinaryPercent": number,
"priceCoveragePercent": number,
"priceCoverageBuckets": [
{
object (PriceCoverageBucket )
}
]
} |
Fields |
calculationDate |
object (Date )
The date on which the calculations were made.
|
matchedPropertyCount |
integer
The total number of properties that have prices for the given itineraries.
|
priceCoverageBinaryPercent |
number
The ratio between the number of hotels which have at least one price for the calculation period and matchedPropertyCount .
|
priceCoveragePercent |
number
The overall price coverage for an account. This value is the ratio between the number of hotel prices for the calculation booking window and length of stay range divided by the number of all possible prices, which is matchedPropertyCount times 330 (for advance book window) times 30 (for length of stay).
|
priceCoverageBuckets[] |
object (PriceCoverageBucket )
Price coverage stats for combinations of advance booking window and length of stay ranges.
|
PriceCoverageBucket
Coverage stats for one combination of advance booking window and length of stay.
Fields |
advanceBookingWindowRange |
enum (AdvanceBookingWindowRange )
Advance booking window range.
|
lengthOfStayRange |
enum (LengthOfStayRange )
Length of stay range.
|
availablePriceCount |
string (int64 format)
Number of prices for this advance booking window bucket and length of stay bucket.
|
priceCoveragePercent |
number
The percent of itineraries for which you have coverage for this advance booking window bucket and length of stay bucket.
|
AdvanceBookingWindowRange
Enumerates booking window ranges.
Enums |
ADVANCE_BOOKING_WINDOW_RANGE_UNSPECIFIED |
Not specified. |
ADVANCE_BOOKING_WINDOW_RANGE_UNKNOWN |
The value is unknown in this version. |
DAYS_0_TO_30 |
Represents advance booking window between 0 and 30 days. |
DAYS_31_TO_60 |
Represents advance booking window between 31 and 60 days. |
DAYS_61_TO_90 |
Represents advance booking window between 61 and 90 days. |
DAYS_91_TO_120 |
Represents advance booking window between 91 and 120 days. |
DAYS_121_TO_150 |
Represents advance booking window between 121 and 150 days. |
DAYS_151_TO_180 |
Represents advance booking window between 151 and 180 days. |
DAYS_181_TO_210 |
Represents advance booking window between 181 and 210 days. |
DAYS_211_TO_240 |
Represents advance booking window between 211 and 240 days. |
DAYS_241_TO_270 |
Represents advance booking window between 241 and 270 days. |
DAYS_271_TO_300 |
Represents advance booking window between 271 and 300 days. |
DAYS_301_TO_330 |
Represents advance booking window between 301 and 330 days. |
LengthOfStayRange
Enumerates length of stay ranges.
Enums |
LENGTH_OF_STAY_RANGE_UNSPECIFIED |
Not specified. |
LENGTH_OF_STAY_RANGE_UNKNOWN |
The value is unknown in this version. |
LENGTH_OF_STAY_1_TO_7 |
Represents length of stay from 1 to 7 nights. |
LENGTH_OF_STAY_8_TO_14 |
Represents length of stay from 8 to 14 nights. |
LENGTH_OF_STAY_15_TO_30 |
Represents length of stay from 15 to 30 nights. |
Methods |
|
Returns the latest price coverage view in full detail. |
|
Returns the entire price coverage history. |
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003e\u003ccode\u003ePriceCoverageView\u003c/code\u003e provides insights into your hotel price coverage across different booking windows and lengths of stay, aiding in identifying potential areas for improvement to maximize visibility and bookings.\u003c/p\u003e\n"],["\u003cp\u003eIt includes key metrics like overall price coverage percentage, a breakdown of coverage by booking window and length of stay ranges, and the number of properties with available prices.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAdvanceBookingWindowRange\u003c/code\u003e and \u003ccode\u003eLengthOfStayRange\u003c/code\u003e enums further categorize the data for detailed analysis of price coverage patterns.\u003c/p\u003e\n"],["\u003cp\u003eYou can access the latest price coverage view or the entire history through the provided methods: \u003ccode\u003egetLatest\u003c/code\u003e and \u003ccode\u003elist\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# REST Resource: accounts.priceCoverageViews\n\n- [Resource: PriceCoverageView](#PriceCoverageView)\n - [JSON representation](#PriceCoverageView.SCHEMA_REPRESENTATION)\n- [PriceCoverageBucket](#PriceCoverageBucket)\n - [JSON representation](#PriceCoverageBucket.SCHEMA_REPRESENTATION)\n- [AdvanceBookingWindowRange](#AdvanceBookingWindowRange)\n- [LengthOfStayRange](#LengthOfStayRange)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PriceCoverageView\n---------------------------\n\nA price coverage view. Covers the `price_coverage_stats` Scorecard functionality in pre-v3.0 API versions. For more information, refer to [Price Coverage for Push and Hint partners](//support.google.com/hotelprices/answer/6317686).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"calculationDate\": { object (/hotels/hotel-prices/api-reference/rest/v3/Date) }, \"matchedPropertyCount\": integer, \"priceCoverageBinaryPercent\": number, \"priceCoveragePercent\": number, \"priceCoverageBuckets\": [ { object (/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#PriceCoverageBucket) } ] } ``` |\n\n| Fields ||\n|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `calculationDate` | `object (`[Date](/hotels/hotel-prices/api-reference/rest/v3/Date)`)` The date on which the calculations were made. |\n| `matchedPropertyCount` | `integer` The total number of properties that have prices for the given itineraries. |\n| `priceCoverageBinaryPercent` | `number` The ratio between the number of hotels which have at least one price for the calculation period and `matchedPropertyCount`. |\n| `priceCoveragePercent` | `number` The overall price coverage for an account. This value is the ratio between the number of hotel prices for the calculation booking window and length of stay range divided by the number of all possible prices, which is `matchedPropertyCount` times 330 (for advance book window) times 30 (for length of stay). |\n| `priceCoverageBuckets[]` | `object (`[PriceCoverageBucket](/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#PriceCoverageBucket)`)` Price coverage stats for combinations of advance booking window and length of stay ranges. |\n\nPriceCoverageBucket\n-------------------\n\nCoverage stats for one combination of advance booking window and length of stay.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"advanceBookingWindowRange\": enum (/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#AdvanceBookingWindowRange), \"lengthOfStayRange\": enum (/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#LengthOfStayRange), \"availablePriceCount\": string, \"priceCoveragePercent\": number } ``` |\n\n| Fields ||\n|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advanceBookingWindowRange` | `enum (`[AdvanceBookingWindowRange](/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#AdvanceBookingWindowRange)`)` Advance booking window range. |\n| `lengthOfStayRange` | `enum (`[LengthOfStayRange](/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews#LengthOfStayRange)`)` Length of stay range. |\n| `availablePriceCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Number of prices for this advance booking window bucket and length of stay bucket. |\n| `priceCoveragePercent` | `number` The percent of itineraries for which you have coverage for this advance booking window bucket and length of stay bucket. |\n\nAdvanceBookingWindowRange\n-------------------------\n\nEnumerates booking window ranges.\n\n| Enums ||\n|--------------------------------------------|-------------------------------------------------------------|\n| `ADVANCE_BOOKING_WINDOW_RANGE_UNSPECIFIED` | Not specified. |\n| `ADVANCE_BOOKING_WINDOW_RANGE_UNKNOWN` | The value is unknown in this version. |\n| `DAYS_0_TO_30` | Represents advance booking window between 0 and 30 days. |\n| `DAYS_31_TO_60` | Represents advance booking window between 31 and 60 days. |\n| `DAYS_61_TO_90` | Represents advance booking window between 61 and 90 days. |\n| `DAYS_91_TO_120` | Represents advance booking window between 91 and 120 days. |\n| `DAYS_121_TO_150` | Represents advance booking window between 121 and 150 days. |\n| `DAYS_151_TO_180` | Represents advance booking window between 151 and 180 days. |\n| `DAYS_181_TO_210` | Represents advance booking window between 181 and 210 days. |\n| `DAYS_211_TO_240` | Represents advance booking window between 211 and 240 days. |\n| `DAYS_241_TO_270` | Represents advance booking window between 241 and 270 days. |\n| `DAYS_271_TO_300` | Represents advance booking window between 271 and 300 days. |\n| `DAYS_301_TO_330` | Represents advance booking window between 301 and 330 days. |\n\nLengthOfStayRange\n-----------------\n\nEnumerates length of stay ranges.\n\n| Enums ||\n|------------------------------------|-------------------------------------------------|\n| `LENGTH_OF_STAY_RANGE_UNSPECIFIED` | Not specified. |\n| `LENGTH_OF_STAY_RANGE_UNKNOWN` | The value is unknown in this version. |\n| `LENGTH_OF_STAY_1_TO_7` | Represents length of stay from 1 to 7 nights. |\n| `LENGTH_OF_STAY_8_TO_14` | Represents length of stay from 8 to 14 nights. |\n| `LENGTH_OF_STAY_15_TO_30` | Represents length of stay from 15 to 30 nights. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------------|--------------------------------------------------------|\n| ### [getLatest](/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews/getLatest) | Returns the latest price coverage view in full detail. |\n| ### [list](/hotels/hotel-prices/api-reference/rest/v3/accounts.priceCoverageViews/list) | Returns the entire price coverage history. |"]]