Ontology for the Travel Partner API v3 schema surface across hotel property matching, per-itinerary prices, price accuracy and coverage, participation reporting, brands, icons, listings and reconciliation reports.
Merged ontology containing all types and properties across all API versions. Use tspv:addedInVersion and tspv:removedInVersion annotations to determine version-specific availability.
An account link. Represents the link between a Google Ads customer and a Hotel Ads (Hotel Center) account. An account link defines the set of hotels under the Hotel Center account that is linked to the Google Ads customer.
Defines whether all properties or a subset of properties in the Hotel Center account can be managed with the linked Google Ads account. If a subset, the specific properties are specified.
The properties in the Hotel Center account that can be managed with the Google Ads account.
Brand-level icon and display name configuration. Once approved, the icon and display name appear in the search results for properties that the partner has assigned to this brand.
Disapproval reason of the display name in a specific language.
Localized variant of a text in a particular language.
Response message for ReconciliationReportService.CreateReconciliationReport.
Represents an issue encountered when validating a reconciliation report.
Reconciliation report (Hotel Ads only). Covers the Reconciliation Reports functionality in pre-v3.0 API versions. Lets you see the status, validate, and upload your Commissions reconciliation reports. This only applies if you are in the Google Hotel Ads Commissions Program (GHACP). For more information about working with reconciliation reports in Hotel Center, refer to [Reconciliation reports](//support.google.com/hotelprices/answer/7019060#sending).
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
**DEPRECATED:** Use `PropertyPerformanceResult` with `PropertyPerformanceReportService` instead. Represents a result from querying for free booking link stats for an account.
A single image in a VR Listing. Title and gallery URL are stored per locale. NEXT ID: 4
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
Response message for AccountLinkService.ListAccountLinks.
Response message for BrandService.ListBrands.
Response message for HotelViewService.ListHotelViews.
Response message for IconService.ListIcons.
Response message for PriceAccuracyViewService.ListPriceAccuracyViews.
A price accuracy view. Covers the price accuracy reports functionality in pre-v3.0 API versions. For more information, refer to [Price Accuracy report](https://support.google.com/hotelprices/answer/6318506).
Response message for PriceCoverageViewService.ListPriceCoverageViews.
A 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.
Coverage stats for one combination of advance booking window and length of stay.
Response message for ReconciliationReportService.ListReconciliationReports.
Missed participation count broken down by reason.
The reasons that contributed to the price unavailable count and the total count for each reason.
The reasons that contributed to the no price count and the total count for each reason.
The reasons that contributed to the price missing count and the total count for each reason.
The reasons that contributed to the price problem count and the total count for each reason.
A single review in a VR Listing. NEXT ID: 10
A rating for a vacation rentals listing. NEXT ID: 4
Represents a result from querying for participation stats for an account.
A price view. Covers the Prices functionality in pre-v3.0 API versions.
Represents a result from querying for the property performance report for an account.
Query Free Booking Links Report Response
**DEPRECATED:** Use `QueryPropertyPerformanceReportResponse` with `PropertyPerformanceReportService` instead. Response message for FreeBookingLinksReportService.QueryFreeBookingLinksReport.
Response message for ParticipationReportService.QueryParticipationReport.
Query Property Performance Report Response
Response message for PropertyPerformanceReportService.QueryPropertyPerformanceReport.
Request message for HotelService.SetLiveOnGoogle.
Response message for HotelService.SetLiveOnGoogle.
Response message for HotelViewService.SummarizeHotelViews.
Response message for PriceAccuracyViewService.SummarizePriceAccuracy.
Response message for ReconciliationReportService.ValidateReconciliationReport.
Request message for VRPartnerListingVerificationService.VerifyPartnerListings.
Response message for VRPartnerListingVerificationService.VerifyPartnerListings.
The account link status is not recognized by this API version.
The account link was initiated through Hotel Center and has not yet been approved in Google Ads.
The account link was initiated through Google Ads and has not yet been approved in Hotel Center.
Google is reviewing the icon or display name.
The icon or display name is approved and ready for public display.
The icon or display name is rejected. Google won't display it.
Values Brand.iconDisapprovalReasons accepts.
Icon image does not match the favicon or artwork on the advertiser’s final URL.
Icon image does not have a transparent or non-white background.
Icon image contains text that is too small.
Values DataIssueDetail.dataIssueSeverity accepts.
The data issue will make the listing ineligible for serving.
The listing will still be eligible for serving, but the data issue may have an adverse effect on the content shown.
The data issue is for informational purposes.
Values DataIssueDetail.dataIssueType accepts.
The address is the same as another property in the Hotel List Feed.
The provided address appears to contain a postal box instead of a physical street address.
The address does not appear to contain a street name.
The address does not appear to contain a street number.
The address does not appear to contain a street number, street name, or supported country code.
An invalid but recognized country code was provided.
The address contains an invalid postal code.
The address contains an invalid postal code suffix.
The address contains a postal code suffix when unsupported by the country's postal code system.
The address contains a postal code when unsupported by the country's postal code system.
The name and value at 'listing.content.attributes.attr' is either unsupported or has an invalid value.
The email at 'listing.content.attributes.attr[name='email']' is not a valid email address.
The latitude/longitude pair is the same as another property in the Hotel List Feed.
The latitude/longitude pair provided for the address is more than 500 meters away from the Google latitude/longitude generated from the address.
A valid pair of latitude/longitude fields is missing and Google latitude/longitude generation is disabled.
A valid pair of latitude/longitude fields is missing and Google could not generate them from the address.
An empty or whitespace only name is provided, but no valid name.
An invalid name is provided, but no valid name.
Google encountered an error while importing your Hotel List Feed.
Google encountered an unknown error while importing your Hotel List Feed.
The phone number you provided for this property is the same as the phone number for another property. More than one listing in the Hotel List Feed cannot have the same phone number.
No valid phone number for this property found.
Only invalid or fax phone numbers found.
The country code of the phone number is not valid.
The phone number contains too many digits.
The phone number contains has too few digits.
The specified `content.attributes.attr[name='website']` element is not a valid URL.
The category or `content.attributes.client_attr[name='hotel_brand']` element exceeds 70 Unicode characters, and/or `content.attributes.client_attr[name='custom_*']` exceeds 100 Unicode characters.
Contact your account manager for details.
Vacation rental properties must have at least five feed images. Eight or more images are strongly recommended; having fewer than 8 may impact performance (such as impressions and clicks).
The images for this vacation rental property are still being processed.
The images for this property cannot be fetched. Please check that the image URLs are valid (e.g. do not give a 404 error) and that the domain hosting the image URLs does not block crawling of these images in its robots.txt file or X-Robots-Tag HTTP Header.
The images provided for this property do not meet Google's requirements due to dimensions, size, or automated quality signals. Please ensure that the images are less than 10 MB large, less than 4K pixels wide, and less than 4K pixels tall. Please check additional guidance outlined at the [Property listing image requirements](/hotels/vacation-rentals/dev-guide/onboarding#property_listing_image_requirements)
Deprecated Issue Vacation rental raw listing is missing a language field.
Vacation rental listing has been characterized as a hotel and not a vacation rental.
Vacation rental listing is missing a required attribute.
Vacation rental listing is missing a name.
Vacation rental listing name is missing a language field.
Vacation rental listing name is too long.
Vacation rental listing's name or description is verfied to contain content that violates Google's content policy.
Vacation rental listing is a test property.
Non Vr Accommodation Type Based On Listing Name
Please use NON_VR_ACCOMMODATION_TYPE instead.
Listing that is sent as a vacation rental is suspected to be a non-vacation rental accommodation type, such as a hotel, hostel, etc.
Vacation rental listing brand name is too long.
Google no longer requires brand names; this issue no longer occurs.
This listing has a review that is missing a visit timestamp and the timestamp is required in the listing's country. The review should include "servicedate" if using XML markup or "contentReferenceTime" if using schema.org.
An address should be added to this listing.
The provided address is invalid. Review address requirements on the [dev guide](/hotels/vacation-rentals/dev-guide/vr-attributes). Debugging suggestions: 1. Confirm the address does not contain redundant information such as the country in both addr1 and country_code. 2. Use Google Maps to confirm if the address is formatted correctly for its region. 3. Use a [plus code](https://plus.codes) if the address continues to be invalid.
Deprecated: Replaced with more specifc errors or VR_ADDRESS_INVALID. Google detected that the provided address for this listing is incomplete. For example, it may be missing a unit number.
The provided address is missing a street name.
The provided address is missing a street number.
The provided address is missing a unit number.
The provided address and lat/long data for this listing doesn't match.
Vacation rental listing has an invalid review rating.
Vacation rental listing has an invalid check-in format.
Vacation rental listing has an invalid check-out format.
This listing is in an internal blocklist. Contact your account manager for help.
The "Live on Google" setting for this Vacation Rental is set to false. Note: once "Live on Google" is set to true, it will take a few days for this error to disappear.
This listing's XML failed to parse. Please fix the XML associated with this listing.
A listing that indicates the that feed ZIP file is corrupt. Please ensure the ZIP file is valid.
Vacation rental listing is undergoing initial processing.
Vacation rental listing has a website link that is blocked by a robots.txt
Vacation rental listing has a website link that is still undergoing crawling.
Vacation rental listing has a website link with a crawling error.
The brand of this vacation rental property doesn't have a landing page. Contact your account manager for details.
The room type is invalid. Private rooms and shared rooms are part of shared accommodations, which are not currently supported on the platform.
Values DisplayNameDisapprovalReason.disapprovalReason accepts.
The display name has bad formatting and/or contains punctuation.
The display name contains marketing language.
The display name does not match the landing page.
The display name does not appear to be a brand.
Values FreeBookingLinksResult.deviceType accepts.
Values HotelView.liveOnGoogleStatus accepts.
The property will show on Google unconditionally.
Live On Google Status Active Outside Dsa Region
The property will show on Google for users outside of DSA regions. Current regions include: EU.
This hotel does not correspond to a hotel on Google Maps.
This hotel corresponds to a hotel on Google Maps.
More than one of your hotels match this hotel on Google Maps.
Google has received the icon and is reviewing its contents.
The icon is approved and is ready for public display. You can link APPROVED icons to brands.
The icon is rejected. Google won't display this icon.
Values PriceAccuracyRow.deviceType accepts.
Values PriceAccuracyRow.mismatchReason accepts.
Values PriceAccuracyRow.signalSource accepts.
The price is read directly from the partner's website.
The price is provided by the partner via a price accuracy pixel.
Values PriceCoverageBucket.advanceBookingWindowRange accepts.
Advance Booking Window Range Unspecified
Represents advance booking window between 0 and 30 days.
Represents advance booking window between 31 and 60 days.
Represents advance booking window between 61 and 90 days.
Represents advance booking window between 91 and 120 days.
Represents advance booking window between 121 and 150 days.
Represents advance booking window between 151 and 180 days.
Represents advance booking window between 181 and 210 days.
Represents advance booking window between 211 and 240 days.
Represents advance booking window between 241 and 270 days.
Represents advance booking window between 271 and 300 days.
Represents advance booking window between 301 and 330 days.
Values PriceCoverageBucket.lengthOfStayRange accepts.
Represents length of stay from 1 to 7 nights.
Represents length of stay from 8 to 14 nights.
Represents length of stay from 15 to 30 nights.
Values PropertyPerformanceResult.advanceBookingWindow accepts.
Check-in date was next day after query date.
Check-in date was 2-7 days after query date.
Check-in date was 8-14 days after query date.
Check-in date was 15-30 days after query date.
Check-in date was 31-60 days after query date.
Check-in date was 61-90 days after query date.
Check-in date was 91-120 days after query date.
Check-in date was 121-150 days after query date.
Check-in date was 151-180 days after query date.
Check-in date was over 180 days after query date.
Values PropertyPerformanceResult.deviceType accepts.
Values PropertyPerformanceResult.lengthOfStay accepts.
Values PropertyPerformanceResult.occupancy accepts.
Values SetLiveOnGoogleRequest.liveOnGoogleStatus accepts.
Values SummarizePriceAccuracyResponse.currentBookOnGoogleScore accepts.
Average score exceeds the positioning threshold.
Average score is slightly below the positioning threshold. “Good” has been renamed to “Fair” in Hotel Center.
Average score is well below the positioning threshold.
Average score is close to the account suspension threshold.
Average score is below the account suspension threshold.
Values SummarizePriceAccuracyResponse.currentOverallScore accepts.
Values SummarizePriceAccuracyResponse.currentScore accepts.
Values SummarizePriceAccuracyResponse.currentWebsiteScore accepts.
Values SummarizePriceAccuracyResponse.predictedBookOnGoogleScore accepts.
Values SummarizePriceAccuracyResponse.predictedOverallScore accepts.
Values SummarizePriceAccuracyResponse.predictedScore accepts.
Values SummarizePriceAccuracyResponse.predictedWebsiteScore accepts.
Query alias: 1 model declares accountLinks.
Query alias: 1 model declares accountLinkTarget.
Query alias: 1 model declares activeDisplayNames.
Query alias: 1 model declares activeIcon.
Query alias: 1 model declares activeIconUri.
Query alias: 1 model declares adsClickCount.
Query alias: 1 model declares adsClickthroughRate.
Query alias: 1 model declares adsImpressionCount.
Query alias: 1 model declares adultOccupancy.
Query alias: 1 model declares advanceBookingWindowRange.
Query alias: 1 model declares affectsScore.
Query alias: 1 model declares allHotels.
Query alias: 1 model declares availablePriceCount.
Query alias: 1 model declares bandwidthDepletedCount.
Query alias: 1 model declares basePrice.
Query alias: 1 model declares basePriceViolationsCount.
Query alias: 1 model declares cachedPriceRecord.
Query alias: 1 model declares cacheRateMissingCount.
Query alias: 1 model declares calculationDate.
Query alias: 3 models declare checkinDate.
Query alias: 1 model declares childOccupancy.
Query alias: 2 models declare clickCount.
Query alias: 1 model declares clickthroughRate.
Query alias: 1 model declares correctionTime.
Query alias: 2 models declare currencyCode.
Query alias: 1 model declares currentBookOnGoogleScore.
Query alias: 1 model declares currentOverallScore.
Query alias: 1 model declares currentScore.
Query alias: 1 model declares currentWebsiteScore.
Query alias: 2 models declare dataIssueDetail.
Query alias: 1 model declares dataIssues.
Query alias: 1 model declares dataIssueSeverity.
Query alias: 1 model declares dataIssueType.
Query alias: 4 models declare deviceType.
Query alias: 1 model declares disapprovalReason.
Query alias: 1 model declares disapprovalReasons.
Query alias: 1 model declares displayNameDisapprovalReason.
Query alias: 1 model declares displayNames.
Query alias: 1 model declares displayNameState.
Query alias: 1 model declares failedHotelIds.
Query alias: 1 model declares fetchedPriceRecord.
Query alias: 1 model declares fieldName.
Query alias: 1 model declares finalDomain.
Query alias: 1 model declares galleryUri.
Query alias: 1 model declares googleAdsCustomerName.
Query alias: 1 model declares googleClusterId.
Query alias: 1 model declares googleHotelDisplayName.
Query alias: 1 model declares googleHotelId.
Query alias: 1 model declares highIntentUsers.
Query alias: 1 model declares hotelCountryCode.
Query alias: 1 model declares hotelList.
Query alias: 1 model declares hotelRegionCode.
Query alias: 2 models declare hotelSuspendedCount.
Query alias: 1 model declares hotelViews.
Query alias: 1 model declares iconDisapprovalReasons.
Query alias: 1 model declares iconState.
Query alias: 1 model declares imageData.
Query alias: 1 model declares imprecisionRadiusMeters.
Query alias: 1 model declares impressionCount.
Query alias: 1 model declares isSelfResolving.
Query alias: 1 model declares itineraryBlockedCount.
Query alias: 3 models declare languageCode.
Query alias: 1 model declares lastFeedSubmissionTime.
Query alias: 1 model declares lastManifestUpdateTime.
Query alias: 1 model declares lengthOfStay.
Query alias: 3 models declare lengthOfStayDays.
Query alias: 1 model declares lengthOfStayRange.
Query alias: 1 model declares listingName.
Query alias: 2 models declare liveOnGoogle.
Query alias: 1 model declares liveOnGooglePropertyCount.
Query alias: 2 models declare liveOnGoogleStatus.
Query alias: 1 model declares livePricingConfigIssueCount.
Query alias: 1 model declares livePricingErrorCount.
Query alias: 1 model declares livePricingNotAvailableCount.
Query alias: 1 model declares livePricingNotSetupCount.
Query alias: 1 model declares livePricingNotTriggeredCount.
Query alias: 1 model declares livePricingOtherReasonCount.
Query alias: 1 model declares livePricingTechnicalIssueCount.
Query alias: 1 model declares livePricingTimeoutCount.
Query alias: 1 model declares longitude.
Query alias: 1 model declares matchFailureReasons.
Query alias: 1 model declares matchStatus.
Query alias: 1 model declares mismatchReason.
Query alias: 1 model declares missedParticipationCount.
Query alias: 1 model declares missedParticipationCountDetails.
Query alias: 5 models declare nextPageToken.
Query alias: 1 model declares noAvailabilityCount.
Query alias: 1 model declares noLandingPageCount.
Query alias: 1 model declares noPriceCount.
Query alias: 1 model declares noPriceCountDetails.
Query alias: 1 model declares noTaxBreakdownCount.
Query alias: 1 model declares opportunityCount.
Query alias: 1 model declares otherReasonCount.
Query alias: 1 model declares overclusteredPartnerHotelIds.
Query alias: 1 model declares overclusteredPropertyCount.
overclustered property with errors count
Query alias: 1 model declares overclusteredPropertyWithErrorsCount.
Query alias: 1 model declares parsedListing.
Query alias: 1 model declares participationCount.
Query alias: 1 model declares participationNotLikelyCount.
Query alias: 1 model declares participationPercent.
Query alias: 3 models declare partnerHotelDisplayName.
Query alias: 3 models declare partnerHotelId.
Query alias: 2 models declare partnerHotelIds.
Query alias: 1 model declares partnerListId.
Query alias: 1 model declares partnerPropertyDisplayName.
Query alias: 1 model declares partnerPropertyId.
Query alias: 1 model declares perItineraryPrices.
Query alias: 1 model declares predictedBookOnGoogleScore.
Query alias: 1 model declares predictedOverallScore.
Query alias: 1 model declares predictedScore.
Query alias: 1 model declares predictedWebsiteScore.
Query alias: 1 model declares priceAccuracyIssueCount.
Query alias: 1 model declares priceAccuracyViews.
Query alias: 1 model declares priceCoverageBinaryPercent.
Query alias: 1 model declares priceCoverageBuckets.
Query alias: 2 models declare priceCoveragePercent.
Query alias: 1 model declares priceCoverageViews.
Query alias: 1 model declares priceMissingCount.
Query alias: 1 model declares priceMissingCountDetails.
Query alias: 1 model declares priceProblemCount.
Query alias: 1 model declares priceProblemCountDetails.
Query alias: 2 models declare priceUnavailableCount.
Query alias: 1 model declares priceUnavailableCountDetails.
Query alias: 1 model declares priceUnusuallyHighCount.
Query alias: 1 model declares priceUnusuallyLowCount.
Query alias: 1 model declares primaryOverclusteredPartnerHotelId.
Query alias: 1 model declares propertyCount.
Query alias: 1 model declares propertyDetails.
Query alias: 1 model declares propertyRegionCode.
Query alias: 1 model declares rateRuleId.
Query alias: 1 model declares ratingScale.
Query alias: 1 model declares reconciliationReport.
Query alias: 1 model declares reconciliationReports.
Query alias: 1 model declares reference.
Query alias: 1 model declares regionCode.
Query alias: 1 model declares reviewTime.
Query alias: 1 model declares signalSource.
Query alias: 1 model declares submittedDisplayNames.
Query alias: 1 model declares submittedIcon.
Query alias: 2 models declare successfulRecordCount.
Query alias: 1 model declares taxesAndFees.
Query alias: 1 model declares taxesAndFeesMissingCount.
Query alias: 1 model declares unitAttributes.
Query alias: 1 model declares unmatchedPropertyCount.
Query alias: 1 model declares unmatchedPropertyWithErrorsCount.
Query alias: 1 model declares updatedHotelIds.
Query alias: 2 models declare updateTime.
Query alias: 4 models declare userRegionCode.
Query alias: 1 model declares visitTime.
Query alias: 1 model declares vrWebsiteButtonClicks.
Query alias: 1 model declares xmlListing.
Required for CREATE requests. The properties in the Hotel Center account that can be managed using the linked Google Ads account.
Required for CREATE requests. The value representing the Google Ads customer ID in the format `customers/{google_ads_customer_id}`. For example: `customers/0123456789`. Note that the `googleAdsCustomerName` field is not returned in responses to GET requests.
The resource name for the account link in the format `accounts/{account_id}/accountLinks/{account_link_id}`.
True if all properties under the Hotel Center account are made available to the account link. The default is `false`.
List of properties that is made available to the account link.
Output only. The number of properties with the corresponding brand ID.
Output only. The brand's icon's review state. If there are both submitted and active icons, this refers to the submitted icon.
Output only. The resource name for the brand in the format `accounts/{account_id}/brands/{brand_id}`. The `brand_id` corresponds to the partner's brand identifier used for landing page matching and the property-level brand identifier. A default brand is applied to properties that do not have a brand. The `brand_id` of the default brand is `NO_BRAND_ID`. It can be fetched and updated like any configured brand.
Output only. The icon's disapproval reason(s). Only applies to submitted icons with `REJECTED` state.
Input only. The brand's [accounts.icon](/hotels/hotel-prices/api-reference/rest/v3/accounts.icons#resource:-iconresource) identifying the brand's icon. The value refers to the icons's resource name in the format `accounts/{account_id}/icons/{icon_id}`.
Output only. The brand's submitted [accounts.icon](/hotels/hotel-prices/api-reference/rest/v3/accounts.icons#resource:-iconresource). The value refers to the icons's resource name in the format `accounts/{account_id}/icons/{icon_id}`. A submitted icon is one that is new or rejected.
Output only. Display name's disapproval reason. Only applies to display names with the review state 'REJECTED'.
Output only. The brand's active display names in all provided languages, only present if the display name is approved for all provided languages.
Input only. The name Google displays for the brand's properties. Setting the display names is only necessary if you want to override the landing page display name or account-level display name for the brand. Google reviews the display names for appropriate content. When there are multiple languages, Google will only show the display names once Google approves all the languages.
Output only. URL of the active icon, only present when the icon has been approved.
Output only. The brand's submitted display names in all provided languages, only present if the display name is new or rejected for any language.
Output only. The brand's display names review state, which applies to all display name language entries. If there are both submitted and active display names, this refers to the submitted display names.
Output only. The brand's active [accounts.icon](/hotels/hotel-prices/api-reference/rest/v3/accounts.icons#resource:-iconresource). The value refers to the icons's resource name in the format `accounts/{account_id}/icons/{icon_id}`. An active icon is one that has been approved.
Language of the disapproved display name.
Localized string in the language corresponding to language_code below.
The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Issues that were encountered when validating the file.
The number of commission records that were successfully saved.
Resource name of the new reconciliation report. The format is `accounts/{account_id}`.
Text description of the issue, typically including what was seen and why it was invalid.
The line number on which the issue was detected. If this field is 0, the issue applies to the whole file.
Name of the invalid field. If no field name is given, this issue applies to the whole line (or file).
Resource name in the format `accounts/{account_id}/reconciliationReports/{datetime}~{filename}`. The value for `{datetime}` must be from 0001-01-01T00:00:00 to 9999-12-31T23:59:59 inclusive.
Required. Desired filename of the reconciliation report.
Required. The contents of the commission report. Report contents must conform to the requirements specified in [Reconciliation reports] (//support.google.com/hotelprices/answer/7019060#creating).
Whether or not the issue is self-resolving. If true, the issue is expected to resolve itself. If false or not set, action is needed to resolve the issue. Refer to documentation on the data issue’s type for further information.
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
Partner's hotel ID. Only present if `partnerHotelId` is specified in `aggregateBy` in the request.
A date within the requested date range. Only present if `date` is specified in `aggregateBy` in the request.
Partner's hotel name. Only present if `partnerHotelDisplayName` is specified in `aggregateBy` in the request.
The user’s device type. Only present if `deviceType` is specified in `aggregateBy` in the request.
The total number of clicks that were recorded for this result.
ISO 3116 region code of the country/region of the user. Only present if `userRegionCode` is specified in `aggregateBy` in the request
Currency for `price`, `taxes`, and `fees`.
The unique ID of the hotel that the partner provides in their Hotel List Feed.
Optional. A URL to the property on Google. Only available for properties that are listed.
The primary hotel in the overclustered set.
Optional. Whether the hotel appears in Google's hotel booking links. Declaration & behavior to get detection of presence/absence in JSON conversion.
The reasons why a hotel failed to match to a property on Maps.
Other hotels with which the hotel is overclustered. If your feed contains overclustered hotels, update the feed and resubmit it. To do this, you can use the manual match tool.
DEPRECATED. Indicates that the hotel has data quality issues. The value of this field indicates the type of error. This has been replaced with the data_issue_detail field. If your feed contains data issues, update the feed and resubmit it. For more information, refer to this article.
Optional. DEPRECATED. Prefer live_on_google_status. Whether the hotel appears in Google's hotel booking links. Declaration & behavior to get detection of presence/absence in JSON conversion.
The Google Maps identifier for the hotel.
The type and severity of each data quality issue in the feed. If your feed contains data issues, update the feed and resubmit it. For more information, refer to this article.
Required. Output only. The resource name for the icon in the format `accounts/{account_id}/icons/{icon_id}`. Google generates the `icon_id` during the `create` operation. Use the `icon_id` to associate the icon with a brand using the [accounts.brands](/hotels/hotel-prices/api-reference/rest/v3/accounts.brands#resource:-brand) API.
Output only. The icon's disapproval reason(s). Only applies to icons with `REJECTED` state.
Output only. The approved icon's Google-hosted URI. Only applies to icons with `APPROVED` state.
Optional. Value for tracking the icon. It could be the primary key to your icon in your system, or the icon's filename. Google does not use this value.
Required. Input only. The icon contents, which must be in PNG format, or convertible to PNG.
URL that is deeplink to the image in a gallery (or a webpage).
URL that points to the binary image content directly.
Partner's hotel ID. If `partnerHotelId` is not a value of the `aggregateBy` parameter in the request call, then the `partnerHotelId` field is not returned in the `Key`.
The number of nights for the itinerary. If `lengthOfStayDays` is not a value of the `aggregateBy` parameter in the request call, then the `lengthOfStayDays` field is not returned in the `Key`.
The total occupancy of the itinerary. If `occupancy` is not a value of the `aggregateBy` parameter in the request call, then the `occupancy` field is not returned in the `Key`.
The number of days in advance the user wants to book the itinerary. If `advanceBookingWindow` is not a value of the `aggregateBy` parameter in the request call, then the `advanceBookingWindow` field is not returned in the `Key`.
The check-in date of the itinerary. If `checkinDate` is not a value of the `aggregateBy` parameter in the request call, then the `checkinDate` field is not returned in the `Key`.
CLDR region code of the country/region of the hotel. If `hotelRegionCode` is not a value of the `aggregateBy` parameter in the request call, then the `hotelRegionCode` field is not returned in the `Key`.
The user’s device type. If `deviceType` is not a value of the `aggregateBy` parameter in the request call, then the `deviceType` field is not returned in the `Key`.
ISO 3116 region code of the country/region of the user. If `userRegionCode` is not a value of the `aggregateBy` parameter in the request call, then the `userRegionCode` field is not returned in the `Key`.
The date for which you are requesting metrics. If `date` is not a value of the `aggregateBy` parameter in the request call, then the `date` field is not returned in the `Key`.
The longitude in degrees. It must be in the range [-180.0, +180.0].
The latitude in degrees. It must be in the range [-90.0, +90.0].
A list of all account links associated with the Hotel Center account being queried.
A list of brands for the current page associated with the Hotel Center account being queried.
Token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Pagination token used to retrieve the next page of results.
A list of all icons associated with the queried partner account.
Resource name should be in the format `accounts/{account_id}/priceAccuracyViews/{report_date}`.
The reason why the fetched price didn't match the cached price.
The rate rule of the advertised price for non-public rates.
The domain of the final page from which prices are read.
The country of the hotel (based on address).
Time at which an incorrect price is updated to a correct price.
Initial URL visited on the partner website.
The number of children in the occupancy details of the validation query. Note: This field may not be consistently populated. If missing, partners should assume a default of 0 children.
True if this row affects the overall price accuracy score.
The number of adults in the occupancy details of the validation query. Note: This field may not be consistently populated due to technical constraints. If missing, partners should assume a default of 2 adults.
Price coverage stats for combinations of advance booking window and length of stay ranges.
The ratio between the number of hotels which have at least one price for the calculation period and `matched_property_count`.
The total number of properties that have prices for the given itineraries.
The date on which the calculations were made.
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 `matched_property_count` times 330 (for advance book window) times 30 (for length of stay).
The percent of itineraries for which you have coverage for this advance booking window bucket and length of stay bucket.
Number of prices for this advance booking window bucket and length of stay bucket.
The list of names of reconciliation reports. Note that the `contents` and `fileName` fields of each `ReconciliationReport` object are not returned by this call.
The reasons that contributed to the price unavailable count.
The reasons that contributed to the no price count (for example, live pricing not available) and the total count for each reason.
The total number of missed participations due to either a price not being present in Google's cache or failing to successfully respond to live pricing. Comprised of the following: * Bandwidth depleted * Cache rate missing * Itinerary blocked * Live pricing not set up * Live pricing timeout * Live pricing error
The total number of missed participation due to one or more of your hotels not specifying taxes and fees separately.
The reasons that contributed to the price missing count.
The total number of missed participations due to one or more of your hotels being suspended due to price accuracy violations.
Hotel did not participate for an unknown reason.
The total number of missed participation due to the hotel/itinerary combination being unavailable, or the traveler was ineligible for the rates. To participate in these auctions, you may need to provide more pricing information.
The total number of missed participation due to price listed as unavailable (-1) for the requested itinerary. Comprised of the following: * Price unavailable * Participation not likely * Other
The total number of missed participation due to an issue with the accuracy of the price provided for the itinerary. Comprised of the following: * Hotel suspended * Price unusually high * Price unusually low * Taxes and feeds missing
The reasons that contributed to the price problem count.
The total number of missed participations due to a price not being offered for the requested itinerary.
No price was cached for this itinerary, and no live query was done because your server usually tells us the hotel is unavailable or sold out.
Hotel did not participate because it wasn't available for the itinerary dates.
The total number of missed participation due to technical issues with live pricing for any of the following reasons: * You didn’t respond quickly enough and exceeded the response deadline (around 4000 milliseconds). * You returned an error. * Your response was malformed.
The total number of missed participation due to live pricing not being triggered for any of the following reasons: * You didn't set a bid. * You didn't have a valid landing page. * There weren't enough prices in the cache.
The total number of missed participation due to live pricing not being triggered for any of the following reasons: * You didn't have live pricing configured for these searches. * You restricted Google from accessing the hotel itinerary in question.
The number of missed participations due to other issues with live pricing.
The total number of missed participation due to live pricing being unavailable. Live pricing will not be triggered for certain default itineraries or UIs. In this scenario, partners will need a cached price to participate.
No price was cached for this itinerary. A live query did not time out, but your system returned an error.
No price exists in the cache for this itinerary. A live query was not done due to page constraints.
No price was cached for this itinerary, and live query was not configured for this account.
No price was cached for this itinerary, and there was no live query quota remaining.
No price was cached for this itinerary, and a live query sent to your system timed out.
The itinerary was outside of your basic parameters, so no price was pulled for the itinerary from either live query or cache fill.
Taxes and fees were missing from pricing.
Base price too low relative to total price.
The price given for this itinerary seemed oddly high compared to regional trends.
The hotel was suspended. This may be due to persistent problems in areas such as incorrect taxes and fees.
The price given for this itinerary seemed oddly low compared to regional trends.
Represents the accuracy of the location. The listing can be anywhere within the defined circular area.
The list ID on partner LEC feed, provided by partner.
Location of listing using latitude and longitude (degrees).
Reviews associated with this listing. Each review has a single language attached to it.
If not empty, it indicates that this listing belongs to a brand of the feed.
Images associated with this listing, localized.
The partner provided category (accommodation type) of the property.
Whether the listing can be served based on non image data alone.
The country code where the listing is located.
The title of the review, for example: Great three bedrooms.
Language of the review in ISO639 format, such as "en", "de", etc.
Unix timestamp (in seconds) of the review, in UTC+0.
Unix timestamp (in seconds) of when the stay was, in UTC+0.
Any ratings associated with this review. This is repeated because reviews can include ratings on different aspects of a listing, e.g. location, cleanliness, etc.
The percentage rate of participation where the number of successfully participated opportunities is divided by the total number of opportunities. For example, if a property was eligible to enter the Google Ads auction 90 times out of 100 opportunities, the participation rate is 90%.
The total number of opportunities for which you were eligible to enter in the Google Ads auction process.
The total number of opportunities **not** eligible for the Google Ads auction process. Comprised of the following: * Landing page missing * Price missing * Price problem * Price unavailable * Other
Partner's hotel display name. This field is only populated when the result is aggregated by `partnerHotelId`.
For a specific hotel, the total number of opportunities that were available. Opportunities are the total number of instances when a hotel ad could have been displayed to a user.
The reasons that contributed to the missed participation count (for example, no availability) and a total count for each reason.
Resource name in the format `accounts/{account_id}/priceViews/{partner_hotel_id}`.
ISO 3116 region code of the country/region of the property. Only present if `propertyRegionCode` is specified in `aggregateBy` in the request
The total number of ad impressions that were recorded for this result.
Equal to `ads_click_count` divided by `ads_impression_count`.
The total number of clicks on the "Website" button on Google for vacation rentals.
Requested number of people staying at the property. Only present if `partnerPropertyId` is specified in `aggregateBy` in the request.
Difference in days between query date and check-in date in property's local timezone. Only present if `advanceBookingWindow` is specified in `aggregateBy` in the request.
Partner-specified brand for the property. Only present if `brand` is specified in `aggregateBy` in the request.
Partner's property name. Only present if `partnerPropertyDisplayName` is specified in `aggregateBy` in the request.
The total number of ad clicks that were recorded for this result.
The total number of free booking link clicks that were recorded for this result.
Whether the user’s query indicated a strong interest in booking. Only present if `highIntentUsers` is specified in `aggregateBy` in the request.
The total number of free booking link impressions that were recorded for this result. This value is rounded to preserve user privacy.
Number of nights between check-in and check-out dates specified by user. Only present if `lengthOfStay` is specified in `aggregateBy` in the request.
Partner's property ID. Only present if `partnerPropertyId` is specified in `aggregateBy` in the request.
Equal to `click_count` divided by `impression_count`.
The list of results that match the query.
Pagination token used to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
The list of results that matches the query.
Required. Identifies the properties to update with the liveOnGoogle setting.
Optional. Whether the property will show on Google, with more granular controls than the original `live_on_google` boolean field. Only one of `live_on_google` or `live_on_google_status` should be set; if both are set, `live_on_google_status` will be used. **Note:** This field should be enclosed in quotes. For example, `"LIVE_ON_GOOGLE_STATUS_INACTIVE"`.
Optional. DEPRECATED. Whether the property will show on Google. When true, Google will show the properties if their integration is complete and the property is available. When false, Google will never show the properties. Superseded by `live_on_google_status`. Only one of `live_on_google` or `live_on_google_status` should be set; if both are set, `live_on_google_status` will be used.
Identifies properties that Google could not update.
Timestamp of the last hotel manifest update.
Timestamp of the last hotel feed submission.
The number of unmatched properties that have data-related errors.
The number of hotels that are considered overclustered.
The number of overclustered properties that have data-related errors.
The number of properties that are considered unmatched.
The number of properties that match Google's manifest.
The number of properties that are Live on Google. This includes properties that are conditionally active, e.g. LIVE_ON_GOOGLE_STATUS_ACTIVE_OUTSIDE_DSA_REGION.
The predicted Book on Google price accuracy score.
The current Book on Google price accuracy score.
The current price accuracy score combining both website and Book on Google scores.
The predicted price accuracy score combining both website and Book on Google scores.
The update timestamp for the current score.
The current website price accuracy score.
The predicted website price accuracy score.
The current price accuracy score. Contains the same value as `current_website_score`. For clarity, use either `current_website_score` or 'current_overall_score` depending upon which is needed.
The predicted price accuracy score. Contains the same value as `predicted_website_score`. For clarity, use either `predicted_website_score` or 'predicted_overall_score` depending upon which is needed.
The number of commission records that were successfully validated.
A listing that follows the XML format specified in https://developers.google.com/hotels/hotel-prices/xml-reference/hotel-list-feed.