Method: accounts.freeBookingLinksReportViews.query

DESCONTINUADO: use PropertyPerformanceReportService.QueryPropertyPerformanceReport, que também tem relatórios de impressões. permite consultar (receber, filtrar e segmentar) um relatório de links para reserva sem custo de uma conta específica.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

O nome do recurso da conta que está sendo consultada. Formato: accounts/{account_id}

Parâmetros de consulta

Parâmetros
filter

string

Condições (campos e expressões) usadas para filtrar as métricas do link para reserva sem custo financeiro da conta que está sendo consultada. A sintaxe requer espaços ao redor do operador in. Caso contrário, é possível omitir espaços. As condições podem ser mescladas usando o operador and.

O campo date é obrigatório. Todos os outros campos são opcionais.

Os valores do campo date são inclusivos e precisam estar no formato AAAA-MM-DD. A data aceitável mais antiga é 09/03/2021. Os valores de data anteriores serão convertidos para 09/03/2021.

Os valores de partnerHotelDisplayName são correspondidos sem distinção entre maiúsculas e minúsculas.

Veja abaixo exemplos de condições válidas:

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

string

Especifica como segmentar as métricas retornadas pela consulta. Por exemplo, se userRegionCode for especificado, o freeBookingLinksResult vai fornecer métricas agregadas por região do usuário.

O valor da string é uma lista de campos separada por vírgulas. Os campos válidos são: date, userRegionCode, deviceType, partnerHotelId e partnerHotelDisplayName. Somente os campos especificados aqui estão incluídos no FreeBookingLinksResult.
pageSize

integer

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

string

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:

DESCONTINUADO: use QueryPropertyPerformanceReportResponse com PropertyPerformanceReportService. A mensagem de resposta para FreeBookingLinksReportService.QueryFreeBookingLinksReport.

Representação JSON 
{
  "results": [
    {
      object (FreeBookingLinksResult)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (FreeBookingLinksResult)

A lista de resultados que correspondem à consulta.
nextPageToken

string

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.

Resultado de links sem custo financeiro

DESCONTINUADO: use PropertyPerformanceResult com PropertyPerformanceReportService. Representa um resultado da consulta de estatísticas de links para reserva sem custo de uma conta.

Representação JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Campos
date

object (Date)

Uma data no período solicitado.

Presente apenas se date for especificado em aggregateBy na solicitação.
userRegionCode

string

Código regional ISO 3116 do país/região do usuário.

Presente apenas se userRegionCode for especificado em aggregateBy na solicitação
deviceType

enum (Device)

O tipo de dispositivo do usuário.

Presente apenas se deviceType for especificado em aggregateBy na solicitação.
partnerHotelId

string

ID do hotel do parceiro.

Presente apenas se partnerHotelId for especificado em aggregateBy na solicitação.
partnerHotelDisplayName

string

Nome do hotel do parceiro.

Presente apenas se partnerHotelDisplayName for especificado em aggregateBy na solicitação.
clickCount

string (int64 format)

O número total de cliques que foram registrados para esse resultado.