Method: accounts.freeBookingLinksReportViews.query

OBSOLETO: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 financeiro 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

As condições (campos e expressões) usadas para filtrar as métricas de link sem custo financeiro para reserva da conta consultada. A sintaxe exige espaços ao redor do operador in. Caso contrário, os espaços podem ser omitidos. As condições podem ser combinadas 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 mais antiga aceita é 2021-03-09. Valores anteriores serão convertidos para 2021-03-09.

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

Confira alguns 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, 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 sã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 um valor inferior a este. Se não for especificado, no máximo 10.000 resultados serão retornados. O valor máximo é 10.000. Valores maiores serão revertidos para 10.000.
pageToken

string

Um token de página recebido de uma solicitação participationReportViews.query anterior. Forneça isso para receber a página seguinte.

Na paginação, todos os outros parâmetros fornecidos para "participationReportViews.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

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

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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 de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

FreeBookingLinksResult

DESCONTINUADO:use PropertyPerformanceResult com PropertyPerformanceReportService. Representa um resultado da consulta de estatísticas de links sem custo financeiro para reserva 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 dentro do período solicitado.

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

string

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

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

enum (Device)

O tipo de dispositivo do usuário.

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

string

ID do hotel do parceiro.

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

string

Nome do hotel do parceiro.

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

string (int64 format)

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