Method: accounts.freeBookingLinksReportViews.query

OBSOLETO: En su lugar, use PropertyPerformanceReportService.QueryPropertyPerformanceReport, que también tiene informes de impresiones. Permite consultar (obtener, filtrar y segmentar) un informe gratuito de vínculos para reservar de 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 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

Son las condiciones (campos y expresiones) que se utilizan para filtrar las métricas gratuitas del vínculo de reserva de la cuenta que se 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 09-03-2021. Los valores de fecha anteriores se convertirán en 09-03-2021.

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

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

El valor de string es una lista de campos separados por comas. Los campos válidos son: date, userRegionCode, deviceType, partnerHotelId y partnerHotelDisplayName. Solo los campos especificados aquí se incluyen en FreeBookingLinksResult.
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 correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

OBSOLETO: Usa QueryPropertyPerformanceReportResponse con PropertyPerformanceReportService. Mensaje de respuesta para FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

object (FreeBookingLinksResult)

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 los vínculos gratuitos para reservar

OBSOLETO: Usa PropertyPerformanceResult con PropertyPerformanceReportService. Representa el resultado de consultar las estadísticas de los 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

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
deviceType

enum (Device)

Indica 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)

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