Method: accounts.freeBookingLinksReportViews.query

OBSOLETO: En su lugar, usa PropertyPerformanceReportService.QueryPropertyPerformanceReport, que también tiene informes de impresiones. Proporciona la capacidad de consultar (obtener, filtrar y segmentar) un informe de vínculos de reserva gratuitos para una cuenta específica.

Solicitud HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews: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 los vínculos gratuitos para reservar de la cuenta sobre la que se realiza la 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.

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 partnerHotelDisplayName se comparan sin distinguir mayúsculas de minúsculas.

A continuación, se muestran ejemplos de condiciones 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 cómo segmentar las métricas que muestra la consulta. Por ejemplo, si se especifica userRegionCode, freeBookingLinksResult 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 date, userRegionCode, deviceType, partnerHotelId y partnerHotelDisplayName. Solo se incluyen los campos especificados aquí en FreeBookingLinksResult.
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

OBSOLETO: En su lugar, usa QueryPropertyPerformanceReportResponse con PropertyPerformanceReportService. Es el mensaje de respuesta para FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

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

object (FreeBookingLinksResult)

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.

FreeBookingLinksResult

OBSOLETO: En su lugar, usa PropertyPerformanceResult con PropertyPerformanceReportService. Representa el resultado de una consulta de estadísticas de vínculos gratuitos para reservar de una cuenta.

Representación JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": 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.
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.
deviceType

enum (Device)

Es el tipo de dispositivo del usuario.

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

string

ID de hotel del socio.

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

string

Nombre del hotel del socio.

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

string (int64 format)

Es la cantidad total de clics que se registraron para este resultado.