Method: accounts.propertyPerformanceReportViews.query

Proporciona la capacidad de consultar (obtener, filtrar y segmentar) un informe de vínculos de reserva gratuitos para una cuenta específica. Esta nueva versión devuelve impresiones y clics, además de un superconjunto mucho más grande de filtros y agregaciones.

Solicitud HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Es el nombre del recurso de la cuenta sobre la que se realiza la consulta. Formato: accounts/{account_id}

Parámetros de consulta

Parámetros
filter

string

Son las condiciones (campos y expresiones) que se usan para filtrar las métricas de rendimiento de la propiedad de la cuenta que se consulta. La sintaxis requiere espacios alrededor del operador in. De lo contrario, se pueden omitir los espacios. Las condiciones se pueden unir con el operador AND.

Importante: La sintaxis correcta para agregar varias condiciones es la siguiente: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

El campo date es obligatorio. Todos los demás campos son opcionales.

Los valores del campo date son inclusivos y deben tener el formato AAAA-MM-DD. La fecha aceptable más antigua es el 9 de marzo de 2021; los valores de fecha anteriores se convertirán al 9 de marzo de 2021.

Los valores de partnerPropertyDisplayName y brand coinciden sin distinguir mayúsculas de minúsculas.

A continuación, se muestran ejemplos de condiciones válidas:

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

string

Especifica cómo segmentar las métricas que muestra la consulta. Por ejemplo, si se especifica userRegionCode, PropertyPerformanceResult proporcionará métricas agregadas por región del usuario.

El valor de cadena es una lista de campos separados por comas. Los campos válidos son: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName y userRegionCode. Solo los campos especificados aquí se incluyen en PropertyPerformanceResult.

Importante: Usar el parámetro aggregateBy con partnerHotelId o más de dos valores puede generar un error. Filtrar con partnerHotelId y date para reducir la cantidad de filas puede evitar que se produzcan errores.
pageSize

integer

Es la cantidad máxima de resultados de participación que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 10,000 resultados. El valor máximo es 10,000,y los valores superiores se convertirán a 10,000.
pageToken

string

Es un token de página que se recibió de una solicitud anterior de participationReportViews.query. Proporciona este valor para recibir la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados a participationReportViews.query deben coincidir con la llamada que proporcionó el token de página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para PropertyPerformanceReportService.QueryPropertyPerformanceReport.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (PropertyPerformanceResult)

Es la lista de resultados que coinciden con la búsqueda.
nextPageToken

string

Es el token de paginación que se usa para recuperar la siguiente página de resultados. Si se omite este campo, no habrá páginas siguientes.

Alcances de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

PropertyPerformanceResult

Representa el resultado de una consulta para obtener el informe de rendimiento de la propiedad de una cuenta.

Representación JSON 
{
  "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
}
Campos
date

object (Date)

Es una fecha dentro del período solicitado.

Solo está presente si se especifica date en aggregateBy en la solicitud.
advanceBookingWindow

enum (AdvanceBookingWindow)

Es la diferencia en días entre la fecha de la búsqueda y la fecha de entrada en la zona horaria local de la propiedad.

Solo está presente si se especifica advanceBookingWindow en aggregateBy en la solicitud.
brand

string

Es la marca especificada por el socio para la propiedad.

Solo está presente si se especifica brand en aggregateBy en la solicitud.
deviceType

enum (Device)

Es el tipo de dispositivo del usuario.

Solo está presente si se especifica deviceType en aggregateBy en la solicitud.
highIntentUsers

boolean

Indica si la búsqueda del usuario mostró un gran interés en realizar una reserva.

Solo está presente si se especifica highIntentUsers en aggregateBy en la solicitud.
lengthOfStay

enum (LengthOfStay)

Cantidad de noches entre las fechas de entrada y salida especificadas por el usuario.

Solo está presente si se especifica lengthOfStay en aggregateBy en la solicitud.
propertyRegionCode

string

Es el código de región ISO 3116 del país o la región de la propiedad.

Solo está presente si se especifica propertyRegionCode en aggregateBy en la solicitud.
occupancy

enum (Occupancy)

Cantidad de personas que se hospedarán en la propiedad.

Solo está presente si se especifica partnerPropertyId en aggregateBy en la solicitud.
partnerPropertyId

string

ID de la propiedad del socio.

Solo está presente si se especifica partnerPropertyId en aggregateBy en la solicitud.
partnerPropertyDisplayName

string

Es el nombre de la propiedad del socio.

Solo está presente si se especifica partnerPropertyDisplayName en aggregateBy en la solicitud.
userRegionCode

string

Es el código de región ISO 3116 del país o la región del usuario.

Solo está presente si se especifica userRegionCode en aggregateBy en la solicitud.
clickCount

string (int64 format)

Es la cantidad total de clics en vínculos gratuitos para reservar que se registraron para este resultado.
impressionCount

string (int64 format)

Es la cantidad total de impresiones de vínculos gratuitos para reservar que se registraron para este resultado. Este valor se redondea para preservar la privacidad del usuario.
clickthroughRate

number

Es igual a clickCount dividido por impressionCount.
adsClickCount

string (int64 format)

Es la cantidad total de clics en el anuncio que se registraron para este resultado.
adsImpressionCount

string (int64 format)

Es la cantidad total de impresiones de anuncios que se registraron para este resultado.
adsClickthroughRate

number

Es igual a adsClickCount dividido por adsImpressionCount.
vrWebsiteButtonClicks

string (int64 format)

Es la cantidad total de clics en el botón “Sitio web” de Google para los alquileres de vacaciones.

AdvanceBookingWindow

Enumera los períodos de reserva anticipada (ABW) admitidos. Todas las comparaciones de fechas se realizan en la zona horaria de la propiedad.

Enums
ADVANCE_BOOKING_WINDOW_UNSPECIFIED No se especifica.
ADVANCE_BOOKING_WINDOW_SAME_DAY La fecha de entrada coincidió con la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_NEXT_DAY La fecha de entrada fue el día siguiente a la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 La fecha de entrada fue entre 2 y 7 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 La fecha de entrada fue entre 8 y 14 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 La fecha de entrada fue entre 15 y 30 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 La fecha de entrada fue entre 31 y 60 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 La fecha de entrada fue entre 61 y 90 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 La fecha de entrada fue entre 91 y 120 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 La fecha de entrada fue entre 121 y 150 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 La fecha de entrada fue entre 151 y 180 días después de la fecha de la búsqueda.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 La fecha de entrada fue más de 180 días después de la fecha de la búsqueda.

LengthOfStay

Enumera las duraciones de la estadía (LOS) admitidas.

Enums
LENGTH_OF_STAY_UNSPECIFIED No se especifica.
LENGTH_OF_STAY_NIGHTS_1 Estadía de una sola noche
LENGTH_OF_STAY_NIGHTS_2 Estadía de 2 noches
LENGTH_OF_STAY_NIGHTS_3 Estadía de 3 noches
LENGTH_OF_STAY_NIGHTS_4_TO_7 Estadía de 4 a 7 noches
LENGTH_OF_STAY_NIGHTS_8_TO_14 Estadía de 8 a 14 noches
LENGTH_OF_STAY_NIGHTS_15_TO_21 Estadía de 15 a 21 noches
LENGTH_OF_STAY_NIGHTS_22_TO_30 Estadía de 22 a 30 noches
LENGTH_OF_STAY_NIGHTS_OVER_30 Estadía de más de 30 noches

Ocupación

Enumera la ocupación total de la habitación admitida.

Enums
OCCUPANCY_UNSPECIFIED No se especifica.
OCCUPANCY_1 Una sola persona.
OCCUPANCY_2 Dos personas.
OCCUPANCY_3 Tres personas.
OCCUPANCY_4 Cuatro personas.
OCCUPANCY_OVER_4 Más de 4 personas