{ "discoveryVersion": "v1", "mtlsRootUrl": "https://travelpartner.mtls.googleapis.com/", "batchPath": "batch", "resources": { "accounts": { "resources": { "accountLinks": { "methods": { "list": { "id": "travelpartner.accounts.accountLinks.list", "path": "v3/{+parent}/accountLinks", "flatPath": "v3/accounts/{accountsId}/accountLinks", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAccountLinksResponse" }, "description": "Returns the account links for a Hotel Center account." }, "get": { "id": "travelpartner.accounts.accountLinks.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/accountLinks/{accountLinksId}", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of an account link. The format is `accounts/{account_id}/accountLinks/{account_link_id}`.", "pattern": "^accounts/[^/]+/accountLinks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "AccountLink" }, "description": "Returns the `AccountLink` instance associated with the account link resource name specified in the request URL. To get account link resource names, use the `list` method." }, "create": { "id": "travelpartner.accounts.accountLinks.create", "path": "v3/{+parent}/accountLinks", "flatPath": "v3/accounts/{accountsId}/accountLinks", "httpMethod": "POST", "parameters": { "parent": { "description": "The resource name of the Hotel Center account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "AccountLink" }, "response": { "$ref": "AccountLink" }, "description": "Creates a new account link between a Hotel Center account and a Google Ads account." }, "patch": { "id": "travelpartner.accounts.accountLinks.patch", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/accountLinks/{accountLinksId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "The resource name for the account link in the format `accounts/{account_id}/accountLinks/{account_link_id}`.", "pattern": "^accounts/[^/]+/accountLinks/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The field to update. Only the `accountLinkTarget` field can be updated. Use the syntax shown in the example URL below and provide the new value in the request body. Example request URL and request body: ``` PATCH https://travelpartner.googleapis.com/v3/accounts/123456789/ accountLinks/0123456789?update_mask=account_link.account_link_target ``` ``` { \"account_link_target\": { \"hotel_list\": { \"partner_hotel_ids\": [\"1234\", \"4321\"] } } } ``` The response body will only include the `name` field of an `AccountLink`. The information above is sufficient for forming the URL and request body. The sentence below is auto-generated, supplemental information about the `FieldMask` format in general.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "AccountLink" }, "response": { "$ref": "AccountLink" }, "description": "Updates the account link target of an account link." }, "delete": { "id": "travelpartner.accounts.accountLinks.delete", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/accountLinks/{accountLinksId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of the account link being deleted. The format is `accounts/{account_id}/accountLinks/{account_link_id}`.", "pattern": "^accounts/[^/]+/accountLinks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "Deletes an account link." } } }, "icons": { "methods": { "list": { "id": "travelpartner.accounts.icons.list", "path": "v3/{+parent}/icons", "flatPath": "v3/accounts/{accountsId}/icons", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the queried partner account. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListIconsResponse" }, "description": "Returns the `Icon`s for a partner account." }, "get": { "id": "travelpartner.accounts.icons.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/icons/{iconsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The icon's resource name. The format is `accounts/{account_id}/icons/{icon_id}`.", "pattern": "^accounts/[^/]+/icons/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Icon" }, "description": "Returns the `Icon` instance associated with an icon resource name specified in the request URI. To get icon resource names, use the `list` method." }, "create": { "id": "travelpartner.accounts.icons.create", "path": "v3/{+parent}/icons", "flatPath": "v3/accounts/{accountsId}/icons", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the partner account owning the icon. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Icon" }, "response": { "$ref": "Icon" }, "description": "Uploads a new icon and starts its review process. Generates an `icon_id` and includes it in the icon's resource name, which is the format `accounts/{account_id}/icons/{icon_id}` Returns HTTP status 400 and doesn't trigger the review process if the icon has any of these conditions: * Image is not in PNG format, or not convertible to PNG format. * Size less than 72 pixels * Size greater than 1200 pixels * Aspect ratio other than 1:1" } } }, "brands": { "methods": { "list": { "id": "travelpartner.accounts.brands.list", "path": "v3/{+parent}/brands", "flatPath": "v3/accounts/{accountsId}/brands", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of brands to return. The service may return fewer than this value. If unspecified, at most 10,000 brands will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Page token, received from a previous `ListBrands` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBrands` (except `page_size` and `page_token`) must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListBrandsResponse" }, "description": "Returns the brands for a partner account." }, "get": { "id": "travelpartner.accounts.brands.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/brands/{brandsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The brand's resource name. The format is `accounts/{account_id}/brands/{brand_id}`.", "pattern": "^accounts/[^/]+/brands/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Brand" }, "description": "Returns the `Brand` instance associated with the request URI's brand resource name." }, "create": { "id": "travelpartner.accounts.brands.create", "path": "v3/{+parent}/brands", "flatPath": "v3/accounts/{accountsId}/brands", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the Hotel Center account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "brandId": { "description": "Required. The partner-determined brand identifier.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Brand" }, "response": { "$ref": "Brand" }, "description": "Creates a new brand. Because Google detects brands from your existing properties, you only need this operation when you want to configure a brand before you send its properties to Google. Note that it might take a couple of days after your listing feed first provides a brand for the brand to appear." }, "patch": { "id": "travelpartner.accounts.brands.patch", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/brands/{brandsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "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.", "pattern": "^accounts/[^/]+/brands/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Required. The field to update. Only the `display_names` and `icon` fields can be updated. Use the syntax shown in the example URI below and provide the new value in the request body. Example request URI and request body: ``` PATCH https://travelpartner.googleapis.com/v3/accounts/123456789/ brands/my-brand?update_mask=brand.display_names ``` ``` { \"display_names\": [{ \"language\": \"en\" \"text\": \"Gilles' Gites\" }] } ``` The information above is sufficient for forming the URI and request body. The sentence below is auto-generated, supplemental information about the `FieldMask` format in general.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "description": "When true, and the Brand is not found, a new Brand will be created. In this situation, `update_mask` is ignored.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Brand" }, "response": { "$ref": "Brand" }, "description": "Updates a brand." } } }, "freeBookingLinksReportViews": { "methods": { "query": { "id": "travelpartner.accounts.freeBookingLinksReportViews.query", "path": "v3/{+name}/freeBookingLinksReportViews:query", "flatPath": "v3/accounts/{accountsId}/freeBookingLinksReportViews:query", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of the account being queried. Format: accounts/{account_id}", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The conditions (fields and expressions) used to filter the free booking link metrics for the account being queried. The syntax requires spaces surrounding the `in` operator. Otherwise, spaces can be omitted. Conditions can be joined using the `and` operator. The `date` field is required. All other fields are optional. The `date` field values are inclusive and must be in YYYY-MM-DD format. The earliest acceptable date is 2021-03-09; earlier date values will be coerced to 2021-03-09. Values for `partnerHotelDisplayName` are matched case-insensitively. Examples of valid conditions are as follows: * `date = '2021-12-03'` * `date between '2021-12-03' and '2021-12-08'` * `deviceType = 'TABLET'` * `deviceType in ('MOBILE', 'TABLET')` * `partnerHotelId = 'AAA'` * `partnerHotelId in ('AAA', 'BBB')` * `partnerHotelDisplayName = 'hotel A'` * `partnerHotelDisplayName in ('Hotel A', 'HOTEL b')` * `userRegionCode = 'US'` * `userRegionCode in ('US', 'CA')`", "location": "query", "type": "string" }, "aggregateBy": { "description": "Specifies how to segment the metrics returned by the query. For example, if `userRegionCode` is specified, the `freeBookingLinksResult` will provide metrics aggregated by user region. The string value is a comma-separated list of fields. Valid fields are: `date`, `userRegionCode`, `deviceType`, `partnerHotelId`, and `partnerHotelDisplayName`. Only fields specified here are included in the FreeBookingLinksResult.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of participation results to return. The service may return fewer than this value. If unspecified, at most 10,000 results will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous QueryParticipationReport request. Provide this to receive the subsequent page. When paginating, all other parameters provided to QueryParticipationReport must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QueryFreeBookingLinksReportResponse" }, "deprecated": true, "description": "**DEPRECATED:** Use PropertyPerformanceReportService.QueryPropertyPerformanceReport, which also has impression reporting, instead. Provides the ability to query (get, filter, and segment) a free booking links report for a specific account." } }, "deprecated": true }, "hotels": { "methods": { "setLiveOnGoogle": { "id": "travelpartner.accounts.hotels.setLiveOnGoogle", "path": "v3/{+account}/hotels:setLiveOnGoogle", "flatPath": "v3/accounts/{accountsId}/hotels:setLiveOnGoogle", "httpMethod": "POST", "parameters": { "account": { "description": "Required. The resource name of the account. The format is accounts/{account_id}.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "account" ], "request": { "$ref": "SetLiveOnGoogleRequest" }, "response": { "$ref": "SetLiveOnGoogleResponse" }, "description": "Collection-level custom method to update the Live on Google status for multiple properties. Each call can turn on or off multiple hotels. To turn some hotels on and turn some hotels off, you will have to make multiple calls." } } }, "hotelViews": { "methods": { "list": { "id": "travelpartner.accounts.hotelViews.list", "path": "v3/{+parent}/hotelViews", "flatPath": "v3/accounts/{accountsId}/hotelViews", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Number of elements to retrieve in a single page.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Token of the page to retrieve.", "location": "query", "type": "string" }, "filter": { "description": "Optional. The conditions (fields and expressions) used to filter HotelViews. The syntax requires spaces surrounding the `in` operator. Otherwise, spaces can be omitted. Conditions cannot be joined. The `hotelId` field can be used to select specific hotels. The `liveOnGoogle` field can select properties that Google shows, or properties that are omitted in google search results. A value of 'TRUE' includes properties that are conditionally active, e.g. LIVE_ON_GOOGLE_STATUS_ACTIVE_OUTSIDE_DSA_REGION. The `matchStatus` field can be used to filter the list of HotelViews returned for the account. Examples of valid conditions and their syntax are as follows: * `hotelId = 'hotel_ABC'` * `hotelId in ('hotel_ABC', 'hotel_XYZ')` * `liveOnGoogle = 'TRUE'` * `liveOnGoogle = 'FALSE'` * `matchStatus = 'NOT_MATCHED'` * `matchStatus in ('NOT_MATCHED', 'MATCHED', 'MAP_OVERLAP')`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListHotelViewsResponse" }, "description": "Returns the list of hotel views." }, "summarize": { "id": "travelpartner.accounts.hotelViews.summarize", "path": "v3/{+parent}/hotelViews:summarize", "flatPath": "v3/accounts/{accountsId}/hotelViews:summarize", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SummarizeHotelViewsResponse" }, "description": "Returns summarized information about hotels." } } }, "participationReportViews": { "methods": { "query": { "id": "travelpartner.accounts.participationReportViews.query", "path": "v3/{+name}/participationReportViews:query", "flatPath": "v3/accounts/{accountsId}/participationReportViews:query", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The conditions (fields and expressions) used to filter the participation metrics for the account being queried. The syntax requires spaces surrounding the `in` operator. Otherwise, spaces can be omitted. Conditions can be joined using the `AND` operator. **Important:** The correct syntax to add multiple conditions is: `\"?filter==%20AND%20=...\"` The `date` field is required. All other fields are optional. Examples of valid conditions are as follows: * `advanceBookingWindow = 2` * `advanceBookingWindow \u003e= 0` * `advanceBookingWindow \u003c= 5` * `checkinDate = '2020-10-01'` * `checkinDate \u003e= '2020-10-01'` * `checkinDate \u003c= '2020-10-01'` * `checkinDate between '2020-10-01' and '2020-10-05'` * `date = '2020-02-04'` * `date between '2020-02-04' and '2020-02-09'` * `deviceType = 'TABLET'` * `deviceType in ('MOBILE', 'TABLET')` * `hotelRegionCode = 'US'` * `hotelRegionCode in ('US', 'CA')` * `lengthOfStayDays = 2` * `lengthOfStayDays \u003e= 0` * `lengthOfStayDays \u003c= 5` * `occupancy = 2` * `occupancy \u003e= 0` * `occupancy \u003c= 5` * `occupancy between 1 and 5` * `partnerHotelId = 'AAA'` * `partnerHotelId in ('AAA', 'BBB')` * `userRegionCode = 'US'` * `userRegionCode in ('US', 'CA')`", "location": "query", "type": "string" }, "aggregateBy": { "description": "Specifies how to segment the metrics returned by the query. For example, if `userRegionCode` is specified as the `aggregate_by` value, the `participationResult` will provide metrics aggregated by user region. The string value is a comma-separated list of fields. Valid fields are: `date`, `userRegionCode`, `deviceType`, `partnerHotelId`, `hotelRegionCode`, `advanceBookingWindow`, `lengthOfStayDays`, `checkinDate`, and `occupancy`. Fields that are not specified are not included in the ParticipationResult. **Important**: Using the `aggregateBy` parameter with `partnerHotelId` or more than two values can result in an error. Filtering with `partnerHotelId` and `date` to reduce the number of rows can prevent the occurrence of errors.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of participation results to return. The service may return fewer than this value. If unspecified, at most 10,000 results will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous QueryParticipationReport request. Provide this to receive the subsequent page. When paginating, all other parameters provided to QueryParticipationReport must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QueryParticipationReportResponse" }, "description": "Provides the ability to query (get, filter, and segment) a participation report for a particular account." } } }, "priceAccuracyViews": { "methods": { "list": { "id": "travelpartner.accounts.priceAccuracyViews.list", "path": "v3/{+parent}/priceAccuracyViews", "flatPath": "v3/accounts/{accountsId}/priceAccuracyViews", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPriceAccuracyViewsResponse" }, "description": "Lists the available price accuracy views." }, "get": { "id": "travelpartner.accounts.priceAccuracyViews.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/priceAccuracyViews/{priceAccuracyViewsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of price accuracy view that is being queried.", "pattern": "^accounts/[^/]+/priceAccuracyViews/[^/]+$", "location": "path", "required": true, "type": "string" }, "includeMatchedPrices": { "description": "Set to true if matched prices are to be added into the report.", "location": "query", "type": "boolean" }, "includePixels": { "description": "Set to true if pixel signals are to be added into the report.", "location": "query", "type": "boolean" }, "includeNonScoring": { "description": "Set to true if non-scoring rows are to be added into the report.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "PriceAccuracyView" }, "description": "Returns the requested price accuracy view in full detail." }, "summarize": { "id": "travelpartner.accounts.priceAccuracyViews.summarize", "path": "v3/{+parent}/priceAccuracyViews:summarize", "flatPath": "v3/accounts/{accountsId}/priceAccuracyViews:summarize", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account that is being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "SummarizePriceAccuracyResponse" }, "description": "Returns the price accuracy summary." } } }, "priceCoverageViews": { "methods": { "getLatest": { "id": "travelpartner.accounts.priceCoverageViews.getLatest", "path": "v3/{+parent}/priceCoverageViews:latest", "flatPath": "v3/accounts/{accountsId}/priceCoverageViews:latest", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "PriceCoverageView" }, "description": "Returns the latest price coverage view in full detail." }, "list": { "id": "travelpartner.accounts.priceCoverageViews.list", "path": "v3/{+parent}/priceCoverageViews", "flatPath": "v3/accounts/{accountsId}/priceCoverageViews", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPriceCoverageViewsResponse" }, "description": "Returns the entire price coverage history." } } }, "priceViews": { "methods": { "get": { "id": "travelpartner.accounts.priceViews.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/priceViews/{priceViewsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of price view being queried. The format is `accounts/{account_id}/priceViews/{partner_hotel_id}`.", "pattern": "^accounts/[^/]+/priceViews/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "PriceView" }, "description": "Returns the requested price view in full detail." } } }, "propertyPerformanceReportViews": { "methods": { "query": { "id": "travelpartner.accounts.propertyPerformanceReportViews.query", "path": "v3/{+name}/propertyPerformanceReportViews:query", "flatPath": "v3/accounts/{accountsId}/propertyPerformanceReportViews:query", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of the account being queried. Format: accounts/{account_id}", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The conditions (fields and expressions) used to filter the property performance metrics for the account being queried. The syntax requires spaces surrounding the `in` operator. Otherwise, spaces can be omitted. Conditions can be joined using the `AND` operator. **Important:** The correct syntax to add multiple conditions is: `\"?filter==%20AND%20=...\"` The `date` field is required. All other fields are optional. The `date` field values are inclusive and must be in YYYY-MM-DD format. The earliest acceptable date is 2021-03-09; earlier date values will be coerced to 2021-03-09. Values for `partnerPropertyDisplayName` and `brand` are matched case-insensitively. Examples of valid conditions are as follows: * `advanceBookingWindow = 'ADVANCE_BOOKING_WINDOW_SAME_DAY'` * `advanceBookingWindow in ('ADVANCE_BOOKING_WINDOW_SAME_DAY', 'ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90')` * `brand = 'Brand A'` * `brand in ('Brand A', 'brand B')` * `date = '2021-12-03'` * `date between '2021-12-03' and '2021-12-08'` * `deviceType = 'TABLET'` * `deviceType in ('MOBILE', 'TABLET')` * `highIntentUsers = 'TRUE'` * `highIntentUsers = 'FALSE'` * `lengthOfStay = 'LENGTH_OF_STAY_NIGHTS_2'` * `lengthOfStay in ('LENGTH_OF_STAY_NIGHTS_2', 'LENGTH_OF_STAY_NIGHTS_4_TO_7')` * `propertyRegionCode = 'US'` * `propertyRegionCode in ('US', 'CA')` * `occupancy = 'OCCUPANCY_2'` * `occupancy in ('OCCUPANCY_2', 'OCCUPANCY_OVER_4')` * `partnerPropertyId = 'AAA'` * `partnerPropertyId in ('AAA', 'BBB')` * `partnerPropertyDisplayName = 'hotel A'` * `partnerPropertyDisplayName in ('Hotel A', 'HOTEL b')` * `userRegionCode = 'US'` * `userRegionCode in ('US', 'CA')`", "location": "query", "type": "string" }, "aggregateBy": { "description": "Specifies how to segment the metrics returned by the query. For example, if `userRegionCode` is specified, the `PropertyPerformanceResult` will provide metrics aggregated by user region. The string value is a comma-separated list of fields. Valid fields are: `advanceBookingWindow`, `brand`, `date`, `deviceType`, `highIntentUsers`, `lengthOfStay`, `propertyRegionCode`, `occupancy`, `partnerPropertyId`, `partnerPropertyDisplayName`, and `userRegionCode`. Only fields specified here are included in the PropertyPerformanceResult. **Important**: Using the `aggregateBy` parameter with `partnerHotelId` or more than two values can result in an error. Filtering with `partnerHotelId` and `date` to reduce the number of rows can prevent the occurrence of errors.", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of participation results to return. The service may return fewer than this value. If unspecified, at most 10,000 results will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous QueryParticipationReport request. Provide this to receive the subsequent page. When paginating, all other parameters provided to QueryParticipationReport must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "QueryPropertyPerformanceReportResponse" }, "description": "Provides the ability to query (get, filter, and segment) a free booking links report for a specific account. This new version returns impressions and clicks, as well as a much larger superset of filters/aggregations." } } }, "reconciliationReports": { "methods": { "list": { "id": "travelpartner.accounts.reconciliationReports.list", "path": "v3/{+parent}/reconciliationReports", "flatPath": "v3/accounts/{accountsId}/reconciliationReports", "httpMethod": "GET", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" }, "startDate": { "description": "Beginning of date range to fetch files for. Format is yyyy-MM-dd[THH[:mm[:SS]]]. If empty, reports from the beginning of time onwards are fetched.", "location": "query", "type": "string" }, "endDate": { "description": "End of date range to fetch files for. Format is yyyy-mm-dd[THH[:MM[:SS]]]. If empty, reports until the end of time are fetched.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListReconciliationReportsResponse" }, "description": "Returns a list of the names of created reconciliation reports." }, "get": { "id": "travelpartner.accounts.reconciliationReports.get", "path": "v3/{+name}", "flatPath": "v3/accounts/{accountsId}/reconciliationReports/{reconciliationReportsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The resource name of the reconciliation report to fetch. The format is `accounts/{account_id}/reconciliationReports/{datetime}~{filename}`.", "pattern": "^accounts/[^/]+/reconciliationReports/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ReconciliationReport" }, "description": "Returns a reconciliation report." }, "validate": { "id": "travelpartner.accounts.reconciliationReports.validate", "path": "v3/{+parent}/reconciliationReports:validate", "flatPath": "v3/accounts/{accountsId}/reconciliationReports:validate", "httpMethod": "POST", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ReconciliationReport" }, "response": { "$ref": "ValidateReconciliationReportResponse" }, "description": "Validates a reconciliation report." }, "create": { "id": "travelpartner.accounts.reconciliationReports.create", "path": "v3/{+parent}/reconciliationReports", "flatPath": "v3/accounts/{accountsId}/reconciliationReports", "httpMethod": "POST", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ReconciliationReport" }, "response": { "$ref": "CreateReconciliationReportResponse" }, "description": "Creates a reconciliation report and uploads it to Google." } } }, "listings": { "methods": { "verify": { "id": "travelpartner.accounts.listings.verify", "path": "v3/{+parent}/listings:verify", "flatPath": "v3/accounts/{accountsId}/listings:verify", "httpMethod": "POST", "parameters": { "parent": { "description": "The resource name of the account being queried. The format is `accounts/{account_id}`.", "pattern": "^accounts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "VerifyListingsRequest" }, "response": { "$ref": "VerifyListingsResponse" }, "description": "Returns verified listings with data issues and serving eligibilities for VR partners only." } } } } } }, "canonicalName": "TravelPartner", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "baseUrl": "https://travelpartner.googleapis.com/", "schemas": { "ListAccountLinksResponse": { "id": "ListAccountLinksResponse", "description": "Response message for AccountLinkService.ListAccountLinks.", "type": "object", "properties": { "accountLinks": { "description": "A list of all account links associated with the Hotel Center account being queried.", "type": "array", "items": { "$ref": "AccountLink" } } } }, "AccountLink": { "id": "AccountLink", "description": "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.", "type": "object", "properties": { "name": { "description": "The resource name for the account link in the format `accounts/{account_id}/accountLinks/{account_link_id}`.", "type": "string" }, "googleAdsCustomerName": { "description": "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.", "type": "string" }, "status": { "description": "The current status of the account link.", "type": "string", "enumDescriptions": [ "Default value.", "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.", "The account link has been approved." ], "enum": [ "ACCOUNT_LINK_STATUS_UNSPECIFIED", "ACCOUNT_LINK_STATUS_UNKNOWN", "REQUESTED_FROM_HOTEL_CENTER", "REQUESTED_FROM_GOOGLE_ADS", "APPROVED" ] }, "accountLinkTarget": { "description": "Required for CREATE requests. The properties in the Hotel Center account that can be managed using the linked Google Ads account.", "$ref": "AccountLinkTarget" } } }, "AccountLinkTarget": { "id": "AccountLinkTarget", "description": "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.", "type": "object", "properties": { "allHotels": { "description": "True if all properties under the Hotel Center account are made available to the account link. The default is `false`.", "type": "boolean" }, "hotelList": { "description": "List of properties that is made available to the account link.", "$ref": "HotelList" } } }, "HotelList": { "id": "HotelList", "description": "The properties in the Hotel Center account that can be managed with the Google Ads account.", "type": "object", "properties": { "partnerHotelIds": { "description": "Hotel IDs.", "type": "array", "items": { "type": "string" } } } }, "Empty": { "id": "Empty", "description": "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); }", "type": "object", "properties": {} }, "ListIconsResponse": { "id": "ListIconsResponse", "description": "Response message for IconService.ListIcons.", "type": "object", "properties": { "icons": { "description": "A list of all icons associated with the queried partner account.", "type": "array", "items": { "$ref": "Icon" } } } }, "Icon": { "id": "Icon", "description": "Information about a partner's icon.", "type": "object", "properties": { "name": { "description": "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.", "readOnly": true, "type": "string" }, "imageData": { "description": "Required. Input only. The icon contents, which must be in PNG format, or convertible to PNG.", "type": "string", "format": "byte" }, "state": { "description": "Output only. The icon's current state.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value.", "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." ], "enum": [ "STATE_UNSPECIFIED", "NEW", "APPROVED", "REJECTED" ] }, "iconUri": { "description": "Output only. The approved icon's Google-hosted URI. Only applies to icons with `APPROVED` state.", "readOnly": true, "type": "string" }, "reference": { "description": "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.", "type": "string" }, "disapprovalReasons": { "description": "Output only. The icon's disapproval reason(s). Only applies to icons with `REJECTED` state.", "readOnly": true, "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not specified.", "Icon image does not match the favicon or artwork on the advertiser’s final URL.", "Icon image contains offensive content.", "Icon image is low quality.", "Icon image is animated.", "Icon image does not have a transparent or non-white background.", "Icon image contains text that is too small." ], "enum": [ "IMAGE_DISAPPROVAL_REASON_UNSPECIFIED", "NOT_LIKE_SITE", "OFFENSIVE", "LOW_QUALITY", "ANIMATED", "BAD_BACKGROUND", "TEXT_TOO_SMALL" ] } } } }, "ListBrandsResponse": { "id": "ListBrandsResponse", "description": "Response message for BrandService.ListBrands.", "type": "object", "properties": { "brands": { "description": "A list of brands for the current page associated with the Hotel Center account being queried.", "type": "array", "items": { "$ref": "Brand" } }, "nextPageToken": { "description": "Token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "Brand": { "id": "Brand", "description": "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.", "type": "object", "properties": { "name": { "description": "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.", "readOnly": true, "type": "string" }, "displayNames": { "description": "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.", "type": "array", "items": { "$ref": "LocalizedText" } }, "submittedDisplayNames": { "description": "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.", "readOnly": true, "type": "array", "items": { "$ref": "LocalizedText" } }, "activeDisplayNames": { "description": "Output only. The brand's active display names in all provided languages, only present if the display name is approved for all provided languages.", "readOnly": true, "type": "array", "items": { "$ref": "LocalizedText" } }, "displayNameState": { "description": "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.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value.", "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." ], "enum": [ "REVIEW_STATE_UNSPECIFIED", "REVIEW_STATE_NEW", "APPROVED", "REJECTED" ] }, "displayNameDisapprovalReason": { "description": "Output only. Display name's disapproval reason. Only applies to display names with the review state 'REJECTED'.", "readOnly": true, "type": "array", "items": { "$ref": "DisplayNameDisapprovalReason" } }, "icon": { "description": "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}`.", "type": "string" }, "submittedIcon": { "description": "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.", "readOnly": true, "type": "string" }, "activeIcon": { "description": "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.", "readOnly": true, "type": "string" }, "activeIconUri": { "description": "Output only. URL of the active icon, only present when the icon has been approved.", "readOnly": true, "type": "string" }, "iconState": { "description": "Output only. The brand's icon's review state. If there are both submitted and active icons, this refers to the submitted icon.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default value.", "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." ], "enum": [ "REVIEW_STATE_UNSPECIFIED", "REVIEW_STATE_NEW", "APPROVED", "REJECTED" ] }, "iconDisapprovalReasons": { "description": "Output only. The icon's disapproval reason(s). Only applies to submitted icons with `REJECTED` state.", "readOnly": true, "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not specified.", "Icon image does not match the favicon or artwork on the advertiser’s final URL.", "Icon image contains offensive content.", "Icon image is low quality.", "Icon image is animated.", "Icon image does not have a transparent or non-white background.", "Icon image contains text that is too small." ], "enum": [ "IMAGE_DISAPPROVAL_REASON_UNSPECIFIED", "NOT_LIKE_SITE", "OFFENSIVE", "LOW_QUALITY", "ANIMATED", "BAD_BACKGROUND", "TEXT_TOO_SMALL" ] } }, "propertyCount": { "description": "Output only. The number of properties with the corresponding brand ID.", "readOnly": true, "type": "string", "format": "int64" } } }, "LocalizedText": { "id": "LocalizedText", "description": "Localized variant of a text in a particular language.", "type": "object", "properties": { "text": { "description": "Localized string in the language corresponding to language_code below.", "type": "string" }, "languageCode": { "description": "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.", "type": "string" } } }, "DisplayNameDisapprovalReason": { "id": "DisplayNameDisapprovalReason", "description": "Disapproval reason of the display name in a specific language.", "type": "object", "properties": { "languageCode": { "description": "Language of the disapproved display name.", "type": "string" }, "disapprovalReason": { "description": "Disapproval reason.", "type": "string", "enumDescriptions": [ "Not specified.", "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." ], "enum": [ "DISAPPROVAL_REASON_UNSPECIFIED", "PUNCTUATION", "MARKETING_LANGUAGE", "LANDING_PAGE_NOT_MATCHED", "NOT_BRAND_NAME" ] } } }, "QueryFreeBookingLinksReportResponse": { "id": "QueryFreeBookingLinksReportResponse", "deprecated": true, "description": "**DEPRECATED:** Use `QueryPropertyPerformanceReportResponse` with `PropertyPerformanceReportService` instead. Response message for FreeBookingLinksReportService.QueryFreeBookingLinksReport.", "type": "object", "properties": { "results": { "description": "The list of results that match the query.", "type": "array", "items": { "$ref": "FreeBookingLinksResult" } }, "nextPageToken": { "description": "Pagination token used to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "FreeBookingLinksResult": { "id": "FreeBookingLinksResult", "deprecated": true, "description": "**DEPRECATED:** Use `PropertyPerformanceResult` with `PropertyPerformanceReportService` instead. Represents a result from querying for free booking link stats for an account.", "type": "object", "properties": { "date": { "description": "A date within the requested date range. Only present if `date` is specified in `aggregateBy` in the request.", "$ref": "Date" }, "userRegionCode": { "description": "ISO 3116 region code of the country/region of the user. Only present if `userRegionCode` is specified in `aggregateBy` in the request", "type": "string" }, "deviceType": { "description": "The user’s device type. Only present if `deviceType` is specified in `aggregateBy` in the request.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "Computers.", "Mobile devices with full browsers.", "Tablets with full browsers." ], "enum": [ "DEVICE_UNSPECIFIED", "DEVICE_UNKNOWN", "DESKTOP", "MOBILE", "TABLET" ] }, "partnerHotelId": { "description": "Partner's hotel ID. Only present if `partnerHotelId` is specified in `aggregateBy` in the request.", "type": "string" }, "partnerHotelDisplayName": { "description": "Partner's hotel name. Only present if `partnerHotelDisplayName` is specified in `aggregateBy` in the request.", "type": "string" }, "clickCount": { "description": "The total number of clicks that were recorded for this result.", "type": "string", "format": "int64" } } }, "Date": { "id": "Date", "description": "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", "type": "object", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "description": "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.", "type": "integer", "format": "int32" } } }, "SetLiveOnGoogleRequest": { "id": "SetLiveOnGoogleRequest", "description": "Request message for HotelService.SetLiveOnGoogle.", "type": "object", "properties": { "liveOnGoogle": { "description": "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.", "deprecated": true, "type": "boolean" }, "liveOnGoogleStatus": { "description": "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\"`.", "type": "string", "enumDescriptions": [ "Not specified.", "The property will show on Google unconditionally.", "The property will not show on Google.", "The property will show on Google for users outside of DSA regions. Current regions include: EU." ], "enum": [ "LIVE_ON_GOOGLE_STATUS_UNSPECIFIED", "LIVE_ON_GOOGLE_STATUS_ACTIVE", "LIVE_ON_GOOGLE_STATUS_INACTIVE", "LIVE_ON_GOOGLE_STATUS_ACTIVE_OUTSIDE_DSA_REGION" ] }, "partnerHotelIds": { "description": "Required. Identifies the properties to update with the liveOnGoogle setting.", "type": "array", "items": { "type": "string" } } } }, "SetLiveOnGoogleResponse": { "id": "SetLiveOnGoogleResponse", "description": "Response message for HotelService.SetLiveOnGoogle.", "type": "object", "properties": { "updatedHotelIds": { "description": "Identifies the updated properties.", "type": "array", "items": { "type": "string" } }, "failedHotelIds": { "description": "Identifies properties that Google could not update.", "type": "array", "items": { "type": "string" } } } }, "ListHotelViewsResponse": { "id": "ListHotelViewsResponse", "description": "Response message for HotelViewService.ListHotelViews.", "type": "object", "properties": { "hotelViews": { "description": "The list of rows that match the query.", "type": "array", "items": { "$ref": "HotelView" } }, "nextPageToken": { "description": "Pagination token used to retrieve the next page of results.", "type": "string" } } }, "HotelView": { "id": "HotelView", "description": "A hotel view.", "type": "object", "properties": { "partnerHotelId": { "description": "The unique ID of the hotel that the partner provides in their Hotel List Feed.", "type": "string" }, "googleHotelId": { "description": "Google's canonical ID for the hotel.", "type": "string", "format": "uint64" }, "googleClusterId": { "description": "The Google Maps identifier for the hotel.", "type": "string", "format": "uint64" }, "partnerHotelDisplayName": { "description": "Partner's hotel name.", "type": "string" }, "googleHotelDisplayName": { "description": "Google's hotel name.", "type": "string" }, "overclusteredPartnerHotelIds": { "description": "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.", "type": "array", "items": { "type": "string" } }, "primaryOverclusteredPartnerHotelId": { "description": "The primary hotel in the overclustered set.", "type": "string" }, "matchStatus": { "description": "Current matching status of the hotel.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "MATCH_STATUS_UNSPECIFIED", "MATCH_STATUS_UNKNOWN", "NOT_MATCHED", "MATCHED", "MAP_OVERLAP" ] }, "liveOnGoogle": { "description": "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.", "deprecated": true, "type": "boolean" }, "liveOnGoogleStatus": { "description": "Optional. Whether the hotel appears in Google's hotel booking links. Declaration & behavior to get detection of presence/absence in JSON conversion.", "type": "string", "enumDescriptions": [ "Not specified.", "The property will show on Google unconditionally.", "The property will not show on Google.", "The property will show on Google for users outside of DSA regions. Current regions include: EU." ], "enum": [ "LIVE_ON_GOOGLE_STATUS_UNSPECIFIED", "LIVE_ON_GOOGLE_STATUS_ACTIVE", "LIVE_ON_GOOGLE_STATUS_INACTIVE", "LIVE_ON_GOOGLE_STATUS_ACTIVE_OUTSIDE_DSA_REGION" ] }, "propertyDetails": { "description": "Optional. A URL to the property on Google. Only available for properties that are listed.", "type": "string" }, "dataIssueDetail": { "description": "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.", "type": "array", "items": { "$ref": "DataIssueDetail" } }, "matchFailureReasons": { "description": "The reasons why a hotel failed to match to a property on Maps.", "type": "array", "items": { "type": "string" } }, "dataIssues": { "description": "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.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "No data issues found.", "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.", "No hotel name is provided.", "An empty or whitespace only name is provided, but no valid name.", "An invalid name is provided, but no valid name.", "The hotel name exceeds 200 characters.", "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 phone number format is not valid.", "The phone number is not valid.", "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.", "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." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, true, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "FEED_DATA_ISSUE_UNSPECIFIED", "FEED_DATA_ISSUE_UNKNOWN", "NO_DATA_ISSUE", "DUPLICATE_ADDRESS", "MISSING_PHYSICAL_STREET_ADDRESS", "MISSING_STREET_NAME", "MISSING_STREET_NUMBER", "MISSING_ADDRESS", "MISSING_COUNTRY", "INVALID_POSTAL_CODE", "INVALID_POSTAL_CODE_SUFFIX", "UNEXPECTED_POSTAL_CODE_SUFFIX", "UNEXPECTED_POSTAL_CODE", "INVALID_AMENITIES", "INVALID_EMAIL_ADDRESS", "DUPLICATE_LATLONG", "LATLONG_INCONSISTENT_WITH_ADDRESS", "MISSING_LATLONG", "COULD_NOT_GEOCODE", "MISSING_HOTEL_NAME", "HOTEL_NAME_EMPTY", "INVALID_HOTEL_NAME", "HOTEL_NAME_TOO_LONG", "PARSE_ERROR_IN_XML", "UNEXPECTED_ATTRIBUTE_IN_XML", "DUPLICATE_PHONE_NUMBER", "MISSING_PHONE_NUMBER", "MISSING_VOICE_PHONE_NUMBER", "INVALID_PHONE_NUMBER_FORMAT", "INVALID_PHONE_NUMBER", "INVALID_PHONE_NUMBER_COUNTRY_CODE", "PHONE_NUMBER_TOO_LONG", "PHONE_NUMBER_TOO_SHORT", "INVALID_WEBSITE_URL", "ADWORDS_ATTRIBUTE_TOO_LONG", "FLAGGED_DUE_TO_SUSPICIOUS_METADATA", "NOT_ENOUGH_IMAGES_PROVIDED", "IMAGE_PROCESSING_IN_PROGRESS", "CANNOT_FETCH_IMAGES", "INCOMPATIBLE_IMAGE_SIZE_OR_LOW_QUALITY", "MISSING_LANG_IN_RAW_LISTING", "IS_HOTEL", "MISSING_REQ_ATTR", "MISSING_NAME", "MISSING_LANG_IN_NAME", "VR_NAME_TOO_LONG", "NAME_AND_DESCRIPTION_ABUSE_VERIFIED", "TEST_PROPERTY", "NON_VR_ACCOMMODATION_TYPE_BASED_ON_LISTING_NAME", "NON_VR_ACCOMMODATION_TYPE", "BRAND_NAME_TOO_LONG", "MISSING_BRAND_NAME", "REVIEW_MISSING_VISIT_TIMESTAMP", "VR_ADDRESS_MISSING", "VR_ADDRESS_INVALID", "VR_ADDRESS_INCOMPLETE", "VR_ADDRESS_INCOMPLETE_NO_STREET_NAME", "VR_ADDRESS_INCOMPLETE_NO_STREET_NUMBER", "VR_ADDRESS_INCOMPLETE_NO_UNIT_NUMBER", "VR_ADDRESS_LATLONG_MISMATCH", "INVALID_REVIEW_RATING", "INVALID_CHECKIN_FORMAT", "INVALID_CHECKOUT_FORMAT", "INTERNAL_BLOCKLIST", "VR_LIVE_ON_GOOGLE_INACTIVE_ERROR", "VR_XML_FAILED_PARSING", "VR_ZIP_FILE_CORRUPT", "VR_PENDING_INITIAL_PROCESSING", "VR_WEBSITE_LINK_ROBOTED", "VR_PENDING_WEBSITE_CRAWLING", "VR_WEBSITE_LINK_WITH_CRAWLING_ERROR", "VR_BRAND_MISSING_LANDING_PAGE", "VR_INVALID_ROOM_TYPE" ] } } } }, "DataIssueDetail": { "id": "DataIssueDetail", "description": "Details on a data issue in the listing.", "type": "object", "properties": { "dataIssueType": { "description": "The type of the data issue.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "No data issues found.", "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.", "No hotel name is provided.", "An empty or whitespace only name is provided, but no valid name.", "An invalid name is provided, but no valid name.", "The hotel name exceeds 200 characters.", "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 phone number format is not valid.", "The phone number is not valid.", "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.", "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." ], "enumDeprecated": [ false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, true, false, false, true, false, false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "FEED_DATA_ISSUE_UNSPECIFIED", "FEED_DATA_ISSUE_UNKNOWN", "NO_DATA_ISSUE", "DUPLICATE_ADDRESS", "MISSING_PHYSICAL_STREET_ADDRESS", "MISSING_STREET_NAME", "MISSING_STREET_NUMBER", "MISSING_ADDRESS", "MISSING_COUNTRY", "INVALID_POSTAL_CODE", "INVALID_POSTAL_CODE_SUFFIX", "UNEXPECTED_POSTAL_CODE_SUFFIX", "UNEXPECTED_POSTAL_CODE", "INVALID_AMENITIES", "INVALID_EMAIL_ADDRESS", "DUPLICATE_LATLONG", "LATLONG_INCONSISTENT_WITH_ADDRESS", "MISSING_LATLONG", "COULD_NOT_GEOCODE", "MISSING_HOTEL_NAME", "HOTEL_NAME_EMPTY", "INVALID_HOTEL_NAME", "HOTEL_NAME_TOO_LONG", "PARSE_ERROR_IN_XML", "UNEXPECTED_ATTRIBUTE_IN_XML", "DUPLICATE_PHONE_NUMBER", "MISSING_PHONE_NUMBER", "MISSING_VOICE_PHONE_NUMBER", "INVALID_PHONE_NUMBER_FORMAT", "INVALID_PHONE_NUMBER", "INVALID_PHONE_NUMBER_COUNTRY_CODE", "PHONE_NUMBER_TOO_LONG", "PHONE_NUMBER_TOO_SHORT", "INVALID_WEBSITE_URL", "ADWORDS_ATTRIBUTE_TOO_LONG", "FLAGGED_DUE_TO_SUSPICIOUS_METADATA", "NOT_ENOUGH_IMAGES_PROVIDED", "IMAGE_PROCESSING_IN_PROGRESS", "CANNOT_FETCH_IMAGES", "INCOMPATIBLE_IMAGE_SIZE_OR_LOW_QUALITY", "MISSING_LANG_IN_RAW_LISTING", "IS_HOTEL", "MISSING_REQ_ATTR", "MISSING_NAME", "MISSING_LANG_IN_NAME", "VR_NAME_TOO_LONG", "NAME_AND_DESCRIPTION_ABUSE_VERIFIED", "TEST_PROPERTY", "NON_VR_ACCOMMODATION_TYPE_BASED_ON_LISTING_NAME", "NON_VR_ACCOMMODATION_TYPE", "BRAND_NAME_TOO_LONG", "MISSING_BRAND_NAME", "REVIEW_MISSING_VISIT_TIMESTAMP", "VR_ADDRESS_MISSING", "VR_ADDRESS_INVALID", "VR_ADDRESS_INCOMPLETE", "VR_ADDRESS_INCOMPLETE_NO_STREET_NAME", "VR_ADDRESS_INCOMPLETE_NO_STREET_NUMBER", "VR_ADDRESS_INCOMPLETE_NO_UNIT_NUMBER", "VR_ADDRESS_LATLONG_MISMATCH", "INVALID_REVIEW_RATING", "INVALID_CHECKIN_FORMAT", "INVALID_CHECKOUT_FORMAT", "INTERNAL_BLOCKLIST", "VR_LIVE_ON_GOOGLE_INACTIVE_ERROR", "VR_XML_FAILED_PARSING", "VR_ZIP_FILE_CORRUPT", "VR_PENDING_INITIAL_PROCESSING", "VR_WEBSITE_LINK_ROBOTED", "VR_PENDING_WEBSITE_CRAWLING", "VR_WEBSITE_LINK_WITH_CRAWLING_ERROR", "VR_BRAND_MISSING_LANDING_PAGE", "VR_INVALID_ROOM_TYPE" ] }, "dataIssueSeverity": { "description": "The severity of the data issue.", "type": "string", "enumDescriptions": [ "The severity of the issue is unknown.", "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." ], "enum": [ "DATA_ISSUE_SEVERITY_UNSPECIFIED", "ERROR", "WARNING", "INFO" ] }, "isSelfResolving": { "description": "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.", "type": "boolean" } } }, "SummarizeHotelViewsResponse": { "id": "SummarizeHotelViewsResponse", "description": "Response message for HotelViewService.SummarizeHotelViews.", "type": "object", "properties": { "matchedPropertyCount": { "description": "The number of properties that match Google's manifest.", "type": "string", "format": "int64" }, "unmatchedPropertyCount": { "description": "The number of properties that are considered unmatched.", "type": "string", "format": "int64" }, "unmatchedPropertyWithErrorsCount": { "description": "The number of unmatched properties that have data-related errors.", "type": "string", "format": "int64" }, "overclusteredPropertyCount": { "description": "The number of hotels that are considered overclustered.", "type": "string", "format": "int64" }, "overclusteredPropertyWithErrorsCount": { "description": "The number of overclustered properties that have data-related errors.", "type": "string", "format": "int64" }, "liveOnGooglePropertyCount": { "description": "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.", "type": "string", "format": "int64" }, "lastManifestUpdateTime": { "description": "Timestamp of the last hotel manifest update.", "type": "string", "format": "google-datetime" }, "lastFeedSubmissionTime": { "description": "Timestamp of the last hotel feed submission.", "type": "string", "format": "google-datetime" } } }, "QueryParticipationReportResponse": { "id": "QueryParticipationReportResponse", "description": "Response message for ParticipationReportService.QueryParticipationReport.", "type": "object", "properties": { "results": { "description": "The list of results that matches the query.", "type": "array", "items": { "$ref": "ParticipationResult" } }, "nextPageToken": { "description": "Pagination token used to retrieve the next page of results.", "type": "string" } } }, "ParticipationResult": { "id": "ParticipationResult", "description": "Represents a result from querying for participation stats for an account.", "type": "object", "properties": { "key": { "description": "Key of the result.", "$ref": "Key" }, "opportunityCount": { "description": "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.", "type": "string", "format": "int64" }, "participationCount": { "description": "The total number of opportunities for which you were eligible to enter in the Google Ads auction process.", "type": "string", "format": "int64" }, "participationPercent": { "description": "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%.", "type": "number", "format": "double" }, "missedParticipationCount": { "description": "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", "type": "string", "format": "int64" }, "missedParticipationCountDetails": { "description": "The reasons that contributed to the missed participation count (for example, no availability) and a total count for each reason.", "$ref": "MissedParticipationCountDetails" }, "partnerHotelDisplayName": { "description": "Partner's hotel display name. This field is only populated when the result is aggregated by `partnerHotelId`.", "type": "string" } } }, "Key": { "id": "Key", "description": "Key of a result.", "type": "object", "properties": { "date": { "description": "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`.", "$ref": "Date" }, "userRegionCode": { "description": "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`.", "type": "string" }, "deviceType": { "description": "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`.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "Computers.", "Mobile devices with full browsers.", "Tablets with full browsers." ], "enum": [ "DEVICE_UNSPECIFIED", "DEVICE_UNKNOWN", "DESKTOP", "MOBILE", "TABLET" ] }, "partnerHotelId": { "description": "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`.", "type": "string" }, "hotelRegionCode": { "description": "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`.", "type": "string" }, "advanceBookingWindow": { "description": "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`.", "type": "integer", "format": "int32" }, "lengthOfStayDays": { "description": "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`.", "type": "integer", "format": "int32" }, "checkinDate": { "description": "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`.", "$ref": "Date" }, "occupancy": { "description": "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`.", "type": "integer", "format": "int32" } } }, "MissedParticipationCountDetails": { "id": "MissedParticipationCountDetails", "description": "Missed participation count broken down by reason.", "type": "object", "properties": { "noAvailabilityCount": { "description": "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.", "deprecated": true, "type": "string", "format": "int64" }, "hotelSuspendedCount": { "description": "The total number of missed participations due to one or more of your hotels being suspended due to price accuracy violations.", "deprecated": true, "type": "string", "format": "int64" }, "noTaxBreakdownCount": { "description": "The total number of missed participation due to one or more of your hotels not specifying taxes and fees separately.", "deprecated": true, "type": "string", "format": "int64" }, "noLandingPageCount": { "description": "No landing page matched the user.", "type": "string", "format": "int64" }, "noPriceCount": { "description": "The total number of missed participations due to a price not being offered for the requested itinerary.", "deprecated": true, "type": "string", "format": "int64" }, "noPriceCountDetails": { "description": "The reasons that contributed to the no price count (for example, live pricing not available) and the total count for each reason.", "deprecated": true, "$ref": "NoPriceCountDetails" }, "otherReasonCount": { "description": "Hotel did not participate for an unknown reason.", "type": "string", "format": "int64" }, "priceMissingCount": { "description": "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", "type": "string", "format": "int64" }, "priceMissingCountDetails": { "description": "The reasons that contributed to the price missing count.", "$ref": "PriceMissingCountDetails" }, "priceProblemCount": { "description": "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", "type": "string", "format": "int64" }, "priceProblemCountDetails": { "description": "The reasons that contributed to the price problem count.", "$ref": "PriceProblemCountDetails" }, "priceUnavailableCount": { "description": "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", "type": "string", "format": "int64" }, "priceUnavailableCountDetails": { "description": "The reasons that contributed to the price unavailable count.", "$ref": "PriceUnavailableCountDetails" } } }, "NoPriceCountDetails": { "id": "NoPriceCountDetails", "description": "The reasons that contributed to the no price count and the total count for each reason.", "type": "object", "properties": { "livePricingTechnicalIssueCount": { "description": "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.", "type": "string", "format": "int64" }, "livePricingNotTriggeredCount": { "description": "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.", "type": "string", "format": "int64" }, "livePricingConfigIssueCount": { "description": "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.", "type": "string", "format": "int64" }, "livePricingNotAvailableCount": { "description": "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.", "type": "string", "format": "int64" }, "livePricingOtherReasonCount": { "description": "The number of missed participations due to other issues with live pricing.", "type": "string", "format": "int64" } } }, "PriceMissingCountDetails": { "id": "PriceMissingCountDetails", "description": "The reasons that contributed to the price missing count and the total count for each reason.", "type": "object", "properties": { "cacheRateMissingCount": { "description": "No price exists in the cache for this itinerary. A live query was not done due to page constraints.", "type": "string", "format": "int64" }, "itineraryBlockedCount": { "description": "The itinerary was outside of your basic parameters, so no price was pulled for the itinerary from either live query or cache fill.", "type": "string", "format": "int64" }, "livePricingNotSetupCount": { "description": "No price was cached for this itinerary, and live query was not configured for this account.", "type": "string", "format": "int64" }, "bandwidthDepletedCount": { "description": "No price was cached for this itinerary, and there was no live query quota remaining.", "type": "string", "format": "int64" }, "livePricingTimeoutCount": { "description": "No price was cached for this itinerary, and a live query sent to your system timed out.", "type": "string", "format": "int64" }, "livePricingErrorCount": { "description": "No price was cached for this itinerary. A live query did not time out, but your system returned an error.", "type": "string", "format": "int64" } } }, "PriceProblemCountDetails": { "id": "PriceProblemCountDetails", "description": "The reasons that contributed to the price problem count and the total count for each reason.", "type": "object", "properties": { "hotelSuspendedCount": { "description": "The hotel was suspended. This may be due to persistent problems in areas such as incorrect taxes and fees.", "type": "string", "format": "int64" }, "priceUnusuallyHighCount": { "description": "The price given for this itinerary seemed oddly high compared to regional trends.", "type": "string", "format": "int64" }, "priceUnusuallyLowCount": { "description": "The price given for this itinerary seemed oddly low compared to regional trends.", "type": "string", "format": "int64" }, "taxesAndFeesMissingCount": { "description": "Taxes and fees were missing from pricing.", "type": "string", "format": "int64" }, "basePriceViolationsCount": { "description": "Base price too low relative to total price.", "type": "string", "format": "int64" }, "priceAccuracyIssueCount": { "description": "Price accuracy issue.", "type": "string", "format": "int64" } } }, "PriceUnavailableCountDetails": { "id": "PriceUnavailableCountDetails", "description": "The reasons that contributed to the price unavailable count and the total count for each reason.", "type": "object", "properties": { "priceUnavailableCount": { "description": "Hotel did not participate because it wasn't available for the itinerary dates.", "type": "string", "format": "int64" }, "participationNotLikelyCount": { "description": "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.", "type": "string", "format": "int64" } } }, "ListPriceAccuracyViewsResponse": { "id": "ListPriceAccuracyViewsResponse", "description": "Response message for PriceAccuracyViewService.ListPriceAccuracyViews.", "type": "object", "properties": { "priceAccuracyViews": { "description": "The list of rows that match the query.", "type": "array", "items": { "$ref": "PriceAccuracyView" } } } }, "PriceAccuracyView": { "id": "PriceAccuracyView", "description": "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).", "type": "object", "properties": { "name": { "description": "Resource name should be in the format `accounts/{account_id}/priceAccuracyViews/{report_date}`.", "type": "string" }, "results": { "description": "The list of rows that match the query.", "type": "array", "items": { "$ref": "PriceAccuracyRow" } } } }, "PriceAccuracyRow": { "id": "PriceAccuracyRow", "description": "A price accuracy row.", "type": "object", "properties": { "hotel": { "description": "Partner-defined hotel ID.", "type": "string" }, "checkinDate": { "description": "Check-in date.", "$ref": "Date" }, "lengthOfStayDays": { "description": "Length of stay.", "type": "integer", "format": "int32" }, "fetchedPriceRecord": { "description": "Price as read from the partner website.", "$ref": "PriceRecord" }, "cachedPriceRecord": { "description": "Price as advertised.", "$ref": "PriceRecord" }, "correctionTime": { "description": "Time at which an incorrect price is updated to a correct price.", "type": "string", "format": "google-datetime" }, "url": { "description": "Initial URL visited on the partner website.", "type": "string" }, "rateRuleId": { "description": "The rate rule of the advertised price for non-public rates.", "type": "string" }, "hotelCountryCode": { "description": "The country of the hotel (based on address).", "type": "string" }, "deviceType": { "description": "The user's device type.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "Computers.", "Mobile devices with full browsers.", "Tablets with full browsers." ], "enum": [ "DEVICE_UNSPECIFIED", "DEVICE_UNKNOWN", "DESKTOP", "MOBILE", "TABLET" ] }, "finalDomain": { "description": "The domain of the final page from which prices are read.", "type": "string" }, "mismatchReason": { "description": "The reason why the fetched price didn't match the cached price.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "Tax mismatch.", "Room unavailable.", "Site error.", "Price feed delayed.", "Discount missing.", "Incorrect discount value.", "Wrong itinerary." ], "enum": [ "MISMATCH_REASON_UNSPECIFIED", "MISMATCH_REASON_UNKNOWN", "TAX_MISMATCH", "ROOM_UNAVAILABLE", "SITE_ERROR", "PRICE_FEED_DELAYED", "DISCOUNT_MISSING", "INCORRECT_DISCOUNT_VALUE", "WRONG_ITINERARY" ] }, "affectsScore": { "description": "True if this row affects the overall price accuracy score.", "type": "boolean" }, "signalSource": { "description": "Source of the price accuracy signal.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "The price is read directly from the partner's website.", "The price is provided by the partner via a price accuracy pixel." ], "enum": [ "SIGNAL_SOURCE_UNSPECIFIED", "SIGNAL_SOURCE_UNKNOWN", "FETCHED", "PIXEL" ] }, "userRegionCode": { "description": "The user's region.", "type": "string" }, "adultOccupancy": { "description": "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.", "type": "integer", "format": "int32" }, "childOccupancy": { "description": "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.", "type": "integer", "format": "int32" } } }, "PriceRecord": { "id": "PriceRecord", "description": "A price record.", "type": "object", "properties": { "basePrice": { "description": "Base price.", "type": "number", "format": "float" }, "taxesAndFees": { "description": "Taxes and fees.", "type": "number", "format": "float" }, "currencyCode": { "description": "ISO 4217 currency code.", "type": "string" }, "time": { "description": "Timestamp of this price record.", "type": "string", "format": "google-datetime" } } }, "SummarizePriceAccuracyResponse": { "id": "SummarizePriceAccuracyResponse", "description": "Response message for PriceAccuracyViewService.SummarizePriceAccuracy.", "type": "object", "properties": { "currentScore": { "description": "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.", "deprecated": true, "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "currentWebsiteScore": { "description": "The current website price accuracy score.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "currentBookOnGoogleScore": { "description": "The current Book on Google price accuracy score.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "currentOverallScore": { "description": "The current price accuracy score combining both website and Book on Google scores.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "updateTime": { "description": "The update timestamp for the current score.", "type": "string", "format": "google-datetime" }, "predictedScore": { "description": "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.", "deprecated": true, "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "predictedWebsiteScore": { "description": "The predicted website price accuracy score.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "predictedBookOnGoogleScore": { "description": "The predicted Book on Google price accuracy score.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] }, "predictedOverallScore": { "description": "The predicted price accuracy score combining both website and Book on Google scores.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "PRICE_ACCURACY_STATE_UNSPECIFIED", "PRICE_ACCURACY_STATE_UNKNOWN", "EXCELLENT", "GOOD", "POOR", "AT_RISK", "FAILED" ] } } }, "PriceCoverageView": { "id": "PriceCoverageView", "description": "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.", "type": "object", "properties": { "calculationDate": { "description": "The date on which the calculations were made.", "$ref": "Date" }, "matchedPropertyCount": { "description": "The total number of properties that have prices for the given itineraries.", "type": "integer", "format": "int32" }, "priceCoverageBinaryPercent": { "description": "The ratio between the number of hotels which have at least one price for the calculation period and `matched_property_count`.", "type": "number", "format": "double" }, "priceCoveragePercent": { "description": "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).", "type": "number", "format": "double" }, "priceCoverageBuckets": { "description": "Price coverage stats for combinations of advance booking window and length of stay ranges.", "type": "array", "items": { "$ref": "PriceCoverageBucket" } } } }, "PriceCoverageBucket": { "id": "PriceCoverageBucket", "description": "Coverage stats for one combination of advance booking window and length of stay.", "type": "object", "properties": { "advanceBookingWindowRange": { "description": "Advance booking window range.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "ADVANCE_BOOKING_WINDOW_RANGE_UNSPECIFIED", "ADVANCE_BOOKING_WINDOW_RANGE_UNKNOWN", "DAYS_0_TO_30", "DAYS_31_TO_60", "DAYS_61_TO_90", "DAYS_91_TO_120", "DAYS_121_TO_150", "DAYS_151_TO_180", "DAYS_181_TO_210", "DAYS_211_TO_240", "DAYS_241_TO_270", "DAYS_271_TO_300", "DAYS_301_TO_330" ] }, "lengthOfStayRange": { "description": "Length of stay range.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "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." ], "enum": [ "LENGTH_OF_STAY_RANGE_UNSPECIFIED", "LENGTH_OF_STAY_RANGE_UNKNOWN", "LENGTH_OF_STAY_1_TO_7", "LENGTH_OF_STAY_8_TO_14", "LENGTH_OF_STAY_15_TO_30" ] }, "availablePriceCount": { "description": "Number of prices for this advance booking window bucket and length of stay bucket.", "type": "string", "format": "int64" }, "priceCoveragePercent": { "description": "The percent of itineraries for which you have coverage for this advance booking window bucket and length of stay bucket.", "type": "number", "format": "double" } } }, "ListPriceCoverageViewsResponse": { "id": "ListPriceCoverageViewsResponse", "description": "Response message for PriceCoverageViewService.ListPriceCoverageViews.", "type": "object", "properties": { "priceCoverageViews": { "description": "Hotel price coverage stats.", "type": "array", "items": { "$ref": "PriceCoverageView" } } } }, "PriceView": { "id": "PriceView", "description": "A price view. Covers the Prices functionality in pre-v3.0 API versions.", "type": "object", "properties": { "name": { "description": "Resource name in the format `accounts/{account_id}/priceViews/{partner_hotel_id}`.", "type": "string" }, "perItineraryPrices": { "description": "Price for each itinerary.", "type": "array", "items": { "$ref": "HotelPricePerItinerary" } } } }, "HotelPricePerItinerary": { "id": "HotelPricePerItinerary", "description": "Hotel price for a given itinerary.", "type": "object", "properties": { "checkinDate": { "description": "Check-in date.", "$ref": "Date" }, "lengthOfStayDays": { "description": "Number of nights for the itinerary.", "type": "integer", "format": "int32" }, "price": { "description": "Hotel price for this itinerary.", "type": "number", "format": "float" }, "taxes": { "description": "Taxes for this itinerary.", "type": "number", "format": "float" }, "fees": { "description": "Fees for this itinerary.", "type": "number", "format": "float" }, "currencyCode": { "description": "Currency for `price`, `taxes`, and `fees`.", "type": "string" }, "updateTime": { "description": "Update timestamp for this hotel price.", "type": "string", "format": "google-datetime" } } }, "QueryPropertyPerformanceReportResponse": { "id": "QueryPropertyPerformanceReportResponse", "description": "Response message for PropertyPerformanceReportService.QueryPropertyPerformanceReport.", "type": "object", "properties": { "results": { "description": "The list of results that match the query.", "type": "array", "items": { "$ref": "PropertyPerformanceResult" } }, "nextPageToken": { "description": "Pagination token used to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "PropertyPerformanceResult": { "id": "PropertyPerformanceResult", "description": "Represents a result from querying for the property performance report for an account.", "type": "object", "properties": { "date": { "description": "A date within the requested date range. Only present if `date` is specified in `aggregateBy` in the request.", "$ref": "Date" }, "advanceBookingWindow": { "description": "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.", "type": "string", "enumDescriptions": [ "Not specified.", "Check-in date was same as query date.", "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." ], "enum": [ "ADVANCE_BOOKING_WINDOW_UNSPECIFIED", "ADVANCE_BOOKING_WINDOW_SAME_DAY", "ADVANCE_BOOKING_WINDOW_NEXT_DAY", "ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7", "ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14", "ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30", "ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60", "ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90", "ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120", "ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150", "ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180", "ADVANCE_BOOKING_WINDOW_DAYS_OVER_180" ] }, "brand": { "description": "Partner-specified brand for the property. Only present if `brand` is specified in `aggregateBy` in the request.", "type": "string" }, "deviceType": { "description": "The user’s device type. Only present if `deviceType` is specified in `aggregateBy` in the request.", "type": "string", "enumDescriptions": [ "Not specified.", "The value is unknown in this version.", "Computers.", "Mobile devices with full browsers.", "Tablets with full browsers." ], "enum": [ "DEVICE_UNSPECIFIED", "DEVICE_UNKNOWN", "DESKTOP", "MOBILE", "TABLET" ] }, "highIntentUsers": { "description": "Whether the user’s query indicated a strong interest in booking. Only present if `highIntentUsers` is specified in `aggregateBy` in the request.", "type": "boolean" }, "lengthOfStay": { "description": "Number of nights between check-in and check-out dates specified by user. Only present if `lengthOfStay` is specified in `aggregateBy` in the request.", "type": "string", "enumDescriptions": [ "Not specified.", "Single night stay.", "Stay of 2 nights.", "Stay of 3 nights.", "Stay of 4-7 nights.", "Stay of 8-14 nights.", "Stay of 15-21 nights.", "Stay of 22-30 nights.", "Stay of over 30 nights." ], "enum": [ "LENGTH_OF_STAY_UNSPECIFIED", "LENGTH_OF_STAY_NIGHTS_1", "LENGTH_OF_STAY_NIGHTS_2", "LENGTH_OF_STAY_NIGHTS_3", "LENGTH_OF_STAY_NIGHTS_4_TO_7", "LENGTH_OF_STAY_NIGHTS_8_TO_14", "LENGTH_OF_STAY_NIGHTS_15_TO_21", "LENGTH_OF_STAY_NIGHTS_22_TO_30", "LENGTH_OF_STAY_NIGHTS_OVER_30" ] }, "propertyRegionCode": { "description": "ISO 3116 region code of the country/region of the property. Only present if `propertyRegionCode` is specified in `aggregateBy` in the request", "type": "string" }, "occupancy": { "description": "Requested number of people staying at the property. Only present if `partnerPropertyId` is specified in `aggregateBy` in the request.", "type": "string", "enumDescriptions": [ "Not specified.", "Single person.", "Two people.", "Three people.", "Four people.", "Over 4 people." ], "enum": [ "OCCUPANCY_UNSPECIFIED", "OCCUPANCY_1", "OCCUPANCY_2", "OCCUPANCY_3", "OCCUPANCY_4", "OCCUPANCY_OVER_4" ] }, "partnerPropertyId": { "description": "Partner's property ID. Only present if `partnerPropertyId` is specified in `aggregateBy` in the request.", "type": "string" }, "partnerPropertyDisplayName": { "description": "Partner's property name. Only present if `partnerPropertyDisplayName` is specified in `aggregateBy` in the request.", "type": "string" }, "userRegionCode": { "description": "ISO 3116 region code of the country/region of the user. Only present if `userRegionCode` is specified in `aggregateBy` in the request", "type": "string" }, "clickCount": { "description": "The total number of free booking link clicks that were recorded for this result.", "type": "string", "format": "int64" }, "impressionCount": { "description": "The total number of free booking link impressions that were recorded for this result. This value is rounded to preserve user privacy.", "type": "string", "format": "int64" }, "clickthroughRate": { "description": "Equal to `click_count` divided by `impression_count`.", "type": "number", "format": "double" }, "adsClickCount": { "description": "The total number of ad clicks that were recorded for this result.", "type": "string", "format": "int64" }, "adsImpressionCount": { "description": "The total number of ad impressions that were recorded for this result.", "type": "string", "format": "int64" }, "adsClickthroughRate": { "description": "Equal to `ads_click_count` divided by `ads_impression_count`.", "type": "number", "format": "double" }, "vrWebsiteButtonClicks": { "description": "The total number of clicks on the \"Website\" button on Google for vacation rentals.", "type": "string", "format": "int64" } } }, "ListReconciliationReportsResponse": { "id": "ListReconciliationReportsResponse", "description": "Response message for ReconciliationReportService.ListReconciliationReports.", "type": "object", "properties": { "reconciliationReports": { "description": "The list of names of reconciliation reports. Note that the `contents` and `fileName` fields of each `ReconciliationReport` object are not returned by this call.", "type": "array", "items": { "$ref": "ReconciliationReport" } } } }, "ReconciliationReport": { "id": "ReconciliationReport", "description": "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).", "type": "object", "properties": { "name": { "description": "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.", "type": "string" }, "contents": { "description": "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).", "type": "string" }, "fileName": { "description": "Required. Desired filename of the reconciliation report.", "type": "string" } } }, "ValidateReconciliationReportResponse": { "id": "ValidateReconciliationReportResponse", "description": "Response message for ReconciliationReportService.ValidateReconciliationReport.", "type": "object", "properties": { "successfulRecordCount": { "description": "The number of commission records that were successfully validated.", "type": "integer", "format": "int32" }, "issues": { "description": "Issues that were encountered when validating the file.", "type": "array", "items": { "$ref": "ReconciliationReportValidationIssue" } } } }, "ReconciliationReportValidationIssue": { "id": "ReconciliationReportValidationIssue", "description": "Represents an issue encountered when validating a reconciliation report.", "type": "object", "properties": { "lineNum": { "description": "The line number on which the issue was detected. If this field is 0, the issue applies to the whole file.", "type": "integer", "format": "int32" }, "fieldName": { "description": "Name of the invalid field. If no field name is given, this issue applies to the whole line (or file).", "type": "string" }, "description": { "description": "Text description of the issue, typically including what was seen and why it was invalid.", "type": "string" } } }, "CreateReconciliationReportResponse": { "id": "CreateReconciliationReportResponse", "description": "Response message for ReconciliationReportService.CreateReconciliationReport.", "type": "object", "properties": { "reconciliationReport": { "description": "Resource name of the new reconciliation report. The format is `accounts/{account_id}`.", "$ref": "ReconciliationReport" }, "successfulRecordCount": { "description": "The number of commission records that were successfully saved.", "type": "integer", "format": "int32" }, "issues": { "description": "Issues that were encountered when validating the file.", "type": "array", "items": { "$ref": "ReconciliationReportValidationIssue" } } } }, "VerifyListingsRequest": { "id": "VerifyListingsRequest", "description": "Request message for VRPartnerListingVerificationService.VerifyPartnerListings.", "type": "object", "properties": { "xmlListing": { "description": "A listing that follows the XML format specified in https://developers.google.com/hotels/hotel-prices/xml-reference/hotel-list-feed.", "type": "string" } } }, "VerifyListingsResponse": { "id": "VerifyListingsResponse", "description": "Response message for VRPartnerListingVerificationService.VerifyPartnerListings.", "type": "object", "properties": { "parsedListing": { "description": "The parsed listing output.", "$ref": "ParsedListing" } } }, "ParsedListing": { "id": "ParsedListing", "description": "A parsed listing", "type": "object", "properties": { "isServed": { "description": "Whether the listing can be served based on non image data alone.", "type": "boolean" }, "partnerListId": { "description": "The list ID on partner LEC feed, provided by partner.", "type": "string" }, "unitAttributes": { "description": "VR List attribute.", "type": "object", "additionalProperties": { "type": "string" } }, "brand": { "description": "If not empty, it indicates that this listing belongs to a brand of the feed.", "type": "string" }, "listingName": { "description": "List of localized names.", "type": "array", "items": { "$ref": "LocalizedText" } }, "regionCode": { "description": "The country code where the listing is located.", "type": "string" }, "location": { "description": "Location of listing using latitude and longitude (degrees).", "$ref": "LatLng" }, "imprecisionRadiusMeters": { "description": "Represents the accuracy of the location. The listing can be anywhere within the defined circular area.", "type": "integer", "format": "int32" }, "description": { "description": "Description of the property.", "type": "array", "items": { "$ref": "LocalizedText" } }, "category": { "description": "The partner provided category (accommodation type) of the property.", "type": "array", "items": { "$ref": "LocalizedText" } }, "review": { "description": "Reviews associated with this listing. Each review has a single language attached to it.", "type": "array", "items": { "$ref": "Review" } }, "dataIssueDetail": { "description": "Data issues about this listing", "type": "array", "items": { "$ref": "DataIssueDetail" } }, "image": { "description": "Images associated with this listing, localized.", "type": "array", "items": { "$ref": "Image" } } } }, "LatLng": { "id": "LatLng", "description": "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.", "type": "object", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number", "format": "double" }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number", "format": "double" } } }, "Review": { "id": "Review", "description": "A single review in a VR Listing. NEXT ID: 10", "type": "object", "properties": { "languageCode": { "description": "Language of the review in ISO639 format, such as \"en\", \"de\", etc.", "type": "string" }, "type": { "description": "The type of the review.", "type": "string", "enumDescriptions": [ "Review type is unknown.", "Review is of editorial type.", "Review is of user type." ], "enum": [ "UNKNOWN", "EDITORIAL", "USER" ] }, "link": { "description": "The url of the review.", "type": "string" }, "title": { "description": "The title of the review, for example: Great three bedrooms.", "type": "string" }, "rating": { "description": "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.", "type": "array", "items": { "$ref": "Rating" } }, "body": { "description": "The body of the review.", "type": "string" }, "author": { "description": "The author of the review.", "type": "string" }, "reviewTime": { "description": "Unix timestamp (in seconds) of the review, in UTC+0.", "type": "string", "format": "google-datetime" }, "visitTime": { "description": "Unix timestamp (in seconds) of when the stay was, in UTC+0.", "type": "string", "format": "google-datetime" } } }, "Rating": { "id": "Rating", "description": "A rating for a vacation rentals listing. NEXT ID: 4", "type": "object", "properties": { "type": { "description": "The type of the rating.", "type": "string", "enumDescriptions": [ "Rating type is unspecified.", "Rating is of overall type." ], "enum": [ "TYPE_UNSPECIFIED", "OVERALL" ] }, "score": { "description": "The rating score. (e.g. 8.5)", "type": "number", "format": "float" }, "ratingScale": { "description": "Maximum rating possible.", "type": "integer", "format": "int32" } } }, "Image": { "id": "Image", "description": "A single image in a VR Listing. Title and gallery URL are stored per locale. NEXT ID: 4", "type": "object", "properties": { "uri": { "description": "URL that points to the binary image content directly.", "type": "string" }, "galleryUri": { "description": "URL that is deeplink to the image in a gallery (or a webpage).", "type": "array", "items": { "$ref": "LocalizedText" } }, "title": { "description": "Title of the image.", "type": "array", "items": { "$ref": "LocalizedText" } } } } }, "servicePath": "", "revision": "20260521", "id": "travelpartner:v3", "basePath": "", "version_module": true, "rootUrl": "https://travelpartner.googleapis.com/", "kind": "discovery#restDescription", "name": "travelpartner", "ownerName": "Google", "version": "v3", "title": "Travel Partner API", "documentationLink": "https://developers.google.com/hotels/hotel-prices/api-reference", "fullyEncodeReservedExpansion": true, "description": "The Travel Partner API provides you with a RESTful interface to the Google Hotel Center platform. It enables an app to efficiently retrieve and change Hotel Center data, and is thus suitable for managing large or complex accounts.", "ownerDomain": "google.com", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } } }