Method: accounts.propertyPerformanceReportViews.query

string

The resource name of the account being queried. Format: accounts/{account_id}

string

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=<condition>=<value>%20AND%20<condition>=<value>..."

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')

string

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.

integer

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.

string

A page token, received from a previous participationReportViews.query request. Provide this to receive the subsequent page.

When paginating, all other parameters provided to participationReportViews.query must match the call that provided the page token.

{
  "date": {
    object (Date)
  },
  "advanceBookingWindow": enum (AdvanceBookingWindow),
  "brand": string,
  "deviceType": enum (Device),
  "highIntentUsers": boolean,
  "lengthOfStay": enum (LengthOfStay),
  "propertyRegionCode": string,
  "occupancy": enum (Occupancy),
  "partnerPropertyId": string,
  "partnerPropertyDisplayName": string,
  "userRegionCode": string,
  "clickCount": string,
  "impressionCount": string,
  "clickthroughRate": number,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}

object (Date)

A date within the requested date range.

Only present if date is specified in aggregateBy in the request.

enum (AdvanceBookingWindow)

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.

string

Partner-specified brand for the property.

Only present if brand is specified in aggregateBy in the request.

enum (Device)

The user’s device type.

Only present if deviceType is specified in aggregateBy in the request.

boolean

Whether the user’s query indicated a strong interest in booking.

Only present if highIntentUsers is specified in aggregateBy in the request.

enum (LengthOfStay)

Number of nights between check-in and check-out dates specified by user.

Only present if lengthOfStay is specified in aggregateBy in the request.

string

ISO 3116 region code of the country/region of the property.

Only present if propertyRegionCode is specified in aggregateBy in the request

enum (Occupancy)

Requested number of people staying at the property.

Only present if partnerPropertyId is specified in aggregateBy in the request.

string

Partner's property ID.

Only present if partnerPropertyId is specified in aggregateBy in the request.

string

Partner's property name.

Only present if partnerPropertyDisplayName is specified in aggregateBy in the request.

string

ISO 3116 region code of the country/region of the user.

Only present if userRegionCode is specified in aggregateBy in the request

string (int64 format)

The total number of free booking link clicks that were recorded for this result.

string (int64 format)

The total number of free booking link impressions that were recorded for this result. This value is rounded to preserve user privacy.

number

Equal to clickCount divided by impressionCount.

string (int64 format)

The total number of ad clicks that were recorded for this result.

string (int64 format)

The total number of ad impressions that were recorded for this result.

number

Equal to adsClickCount divided by adsImpressionCount.

string (int64 format)

The total number of clicks on the "Website" button on Google for vacation rentals.