Method: accounts.propertyPerformanceReportViews.query

Proporciona la capacidad de consultar (obtener, filtrar y segmentar) un informe de vínculos de rendimiento de propiedades para una cuenta específica.

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 de acceso

Parámetros
name

string

El nombre de recurso de la cuenta que se consulta. Formato: accounts/{account_id}

Parámetros de consulta

Parámetros
filter

string

Las condiciones (campos y expresiones) que se usan para filtrar las métricas de rendimiento de las propiedades de la cuenta en cuestión 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.

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 09-03-2021. Los valores de fecha anteriores se convertirán en 09-03-2021.

Los valores de partnerPropertyDisplayName y brand no distinguen entre mayúsculas y minúsculas.

Estos son algunos 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 de usuario.

El valor de string 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.
pageSize

integer

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

string

Un token de página, recibido de una solicitud de participaciónReportViews.query anterior. Proporciona esto para recibir la página siguiente.

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

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

Mensaje de respuesta para PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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

object (PropertyPerformanceResult)

La lista de resultados que coinciden con la consulta.
nextPageToken

string

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 la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

Resultado de PerformancePerformance

Representa un resultado de la consulta del informe de rendimiento de propiedades 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
}
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)

Diferencia en los días entre la fecha de la consulta 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)

Indica 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 indicó un gran interés en la 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

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)

Se solicitó la cantidad de personas que se quedan en la propiedad.

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

string

ID de propiedad del socio.

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

string

Nombre de la propiedad del socio.

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

string

Código de región ISO 3116 del país o región del usuario.

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

string (int64 format)

La cantidad total de clics que se registraron para este resultado.
impressionCount

string (int64 format)

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

number

Igual a clickCount dividido por impressionCount

Período de reserva anticipada

Enumera los períodos de reserva anticipada (ABW) admitidos. Todas las comparaciones por fecha corresponden a la zona horaria de la propiedad.

Enumeradores
ADVANCE_BOOKING_WINDOW_UNSPECIFIED No se especifica.
ADVANCE_BOOKING_WINDOW_SAME_DAY La fecha de entrada fue la misma que la de la consulta.
ADVANCE_BOOKING_WINDOW_NEXT_DAY La fecha de entrada fue el día siguiente a la fecha de la consulta.
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 consulta.
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 consulta.
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 consulta.
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 consulta.
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 consulta.
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 consulta.
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 consulta.
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 consulta.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 La fecha de entrada fue posterior a 180 días después de la fecha de la consulta.

Duración de la estadía

Enumera la duración de la estadía (LOS) admitida.

Enumeradores
LENGTH_OF_STAY_UNSPECIFIED No se especifica.
LENGTH_OF_STAY_NIGHTS_1 Estadía de una 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 entre 15 y 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 sala admitida.

Enumeradores
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.