- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- PropertyPerformanceResult
- AdvanceBookingWindow
- Duração da estadia
- Ocupação
permite consultar (receber, filtrar e segmentar) um relatório de links de desempenho de propriedade de uma conta específica.
Solicitação HTTP
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
O nome do recurso da conta que está sendo consultada. Formato: accounts/{account_id} |
Parâmetros de consulta
Parâmetros | |
---|---|
filter |
As condições (campos e expressões) usadas para filtrar as métricas de desempenho da propriedade da conta que está sendo consultada. A sintaxe requer espaços ao redor do operador O campo Os valores do campo Os valores de Veja abaixo exemplos de condições válidas:
|
aggregateBy |
Especifica como segmentar as métricas retornadas pela consulta. Por exemplo, se O valor da string é uma lista de campos separada por vírgulas. Os campos válidos são: |
pageSize |
O número máximo de resultados de participação a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, serão retornados no máximo 10.000 resultados. O valor máximo é 10.000. Valores maiores serão convertidos para 10.000. |
pageToken |
Um token de página, recebido de uma solicitação requestReportViews.query anterior. Forneça isso para receber a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para participantesReportReports.query precisam corresponder à chamada que forneceu o token da página. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Mensagem de resposta para PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
Representação JSON |
---|
{
"results": [
{
object ( |
Campos | |
---|---|
results[] |
A lista de resultados que correspondem à consulta. |
nextPageToken |
Token de paginação usado para recuperar a próxima página de resultados. Se esse campo for omitido, não haverá páginas subsequentes. |
Escopos da autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/travelpartner
Para mais informações, consulte a Visão geral do OAuth 2.0.
Desempenho da propriedade
Representa um resultado da consulta do relatório de desempenho da propriedade de uma conta.
Representação JSON |
---|
{ "date": { object ( |
Campos | |
---|---|
date |
Uma data no período solicitado. Presente apenas se |
advanceBookingWindow |
Diferença entre os dias da consulta e do check-in no fuso horário local da propriedade. Presente apenas se |
brand |
Marca especificada pelo parceiro para a propriedade. Presente apenas se |
deviceType |
O tipo de dispositivo do usuário. Presente apenas se |
highIntentUsers |
Se a consulta do usuário indicou um forte interesse em fazer uma reserva. Presente apenas se |
lengthOfStay |
Número de noites entre as datas de check-in e check-out especificadas pelo usuário. Presente apenas se |
propertyRegionCode |
Código regional ISO 3116 do país/região da propriedade. Presente apenas se |
occupancy |
Número de pessoas solicitadas na propriedade. Presente apenas se |
partnerPropertyId |
ID da propriedade do parceiro. Presente apenas se |
partnerPropertyDisplayName |
Nome da propriedade do parceiro. Presente apenas se |
userRegionCode |
Código regional ISO 3116 do país/região do usuário. Presente apenas se |
clickCount |
O número total de cliques que foram registrados para esse resultado. |
impressionCount |
É o número total de impressões que foram registradas para esse resultado. Esse valor é arredondado para preservar a privacidade do usuário. |
clickthroughRate |
Igual a |
Janela de reserva futura
Enumera as janelas de reserva antecipada (ABW, na sigla em inglês) compatíveis. Todas as comparações de data estão no fuso horário da propriedade.
Enums | |
---|---|
ADVANCE_BOOKING_WINDOW_UNSPECIFIED |
Não especificado. |
ADVANCE_BOOKING_WINDOW_SAME_DAY |
A data do check-in foi igual à da consulta. |
ADVANCE_BOOKING_WINDOW_NEXT_DAY |
A data do check-in foi no dia seguinte à data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 |
A data do check-in foi de 2 a 7 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
A data do check-in foi de 8 a 14 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
A data do check-in foi de 15 a 30 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
A data do check-in foi de 31 a 60 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
A data do check-in foi de 61 a 90 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 |
A data do check-in foi de 91 a 120 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
A data do check-in foi de 121 a 150 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
A data do check-in foi de 151 a 180 dias após a data da consulta. |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
A data do check-in foi superior a 180 dias após a data da consulta. |
Tempo de estadia
Enumera a duração da estadia (LOS, na sigla em inglês) compatível.
Enums | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED |
Não especificado. |
LENGTH_OF_STAY_NIGHTS_1 |
Estadia única. |
LENGTH_OF_STAY_NIGHTS_2 |
Estadia de duas noites. |
LENGTH_OF_STAY_NIGHTS_3 |
Estadia de três noites. |
LENGTH_OF_STAY_NIGHTS_4_TO_7 |
Estadia de 4 a 7 noites. |
LENGTH_OF_STAY_NIGHTS_8_TO_14 |
Estadia de 8 a 14 noites. |
LENGTH_OF_STAY_NIGHTS_15_TO_21 |
Estadia de 15 a 21 noites. |
LENGTH_OF_STAY_NIGHTS_22_TO_30 |
Estadia de 22 a 30 noites. |
LENGTH_OF_STAY_NIGHTS_OVER_30 |
Estadia de mais de 30 noites. |
Presença
Enumera a ocupação total da sala suportada.
Enums | |
---|---|
OCCUPANCY_UNSPECIFIED |
Não especificado. |
OCCUPANCY_1 |
Uma pessoa. |
OCCUPANCY_2 |
Duas pessoas. |
OCCUPANCY_3 |
Três pessoas. |
OCCUPANCY_4 |
Quatro pessoas. |
OCCUPANCY_OVER_4 |
Mais de quatro pessoas. |