Referencia de la API de hotel
Nota:
Esta versión beta de Hotel Price Ads solo está disponible para seleccionar participantes. Para obtener información sobre cómo participar en el programa de versión beta, póngase en contacto con el administrador de cuentas o inscríbase aquí.
La API y la documentación están sujetas a cambios.
La API de hotel te permite administrar tus campañas de anuncios de hotel y pujas.
Puntos de conexión
El siguiente es el URI base que se usa para construir el punto de conexión.
- Producción—
https://partner.api.bingads.microsoft.com/Travel/v1/
El punto de conexión debe incluir los recursos de cliente y cuenta.
https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/
Establezca {customerId} en customerId del cliente y {accountId} en customerAccountId del cliente.
A continuación, anexe una plantilla de la tabla siguiente para agregar, obtener y actualizar recursos de hotel. Por ejemplo, para obtener o agregar un grupo de hoteles, use el siguiente punto de conexión:
https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/SubAccounts('{subAccountId}')/HotelGroups
Nota:
Los identificadores de SubAccounts, HotelGroups, Hotels y ReportJobs son cadenas y deben incluirse entre comillas simples. Por ejemplo, SubAccounts('12345')/HotelGroups. Esto solo se aplica a SubAccounts, HotelGroups, Hotels y ReportJobs; no use comillas simples para clientes y cuentas.
Plantilla subcuentas
Verbo | Description |
---|---|
OBTENER | Obtiene la lista de campañas de hospedaje (anteriormente campañas de hotel) definidas para la cuenta especificada. NOTA: De forma predeterminada, la lista contiene un máximo de 1000 campañas. Para determinar el número total de campañas en la subcuenta, use el parámetro de consulta $count . Para especificar el número de campañas que se van a devolver, use el parámetro de consulta $top . Para paginar todas las campañas de una subcuenta, use los parámetros de consulta $top y $skip . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos SubAccount . |
EXPONER | Agrega la subcuenta a la cuenta especificada. Puede considerar las subcuentas como campañas de hospedaje. Usa subcuentas para organizar lógicamente las campañas publicitarias de tu hotel. Puede tener un máximo de 50 campañas de hospedaje activas por cuenta. Cuerpo de la solicitud: contiene la subcuenta que se va a agregar. Cuerpo de la respuesta: si se ejecuta correctamente, contiene un objeto AddResponse . El value campo contiene el identificador de la campaña de hospedaje agregada. |
Plantilla SubAccounts('{subAccountId}')
Verbo | Description |
---|---|
OBTENER | Obtiene la subcuenta especificada. Cuerpo de la respuesta: contiene un objeto SubAccount . Parámetros de plantilla:
|
PATCH | Novedades la subcuenta. Cuerpo de la solicitud: contiene un objeto SubAccount que especifica solo los campos que se van a actualizar. Cuerpo de la respuesta: Ninguno. Si se ejecuta correctamente, devuelve el código de estado HTTP 204. Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/HotelGroups
Verbo | Description |
---|---|
OBTENER | Obtiene la lista de grupos de hoteles de la subcuenta especificada. NOTA: De forma predeterminada, la lista contiene un máximo de 1000 grupos de hoteles. Para determinar el número total de grupos de la subcuenta, use el parámetro de consulta $count . Para especificar el número de grupos que se van a devolver, use el parámetro de consulta $top . Para paginar todos los grupos de una subcuenta, use los parámetros de consulta $top y $skip . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos HotelGroup .Parámetros de plantilla:
|
EXPONER | Agrega el grupo de hoteles a la subcuenta especificada. Use grupos de hoteles para crear agrupaciones lógicas de anuncios de precios de hoteles. Puede crear hasta 1000 grupos de hoteles activos por subcuenta. Cuerpo de la solicitud: contiene el HotelGroup que se va a agregar a la subcuenta. Cuerpo de la respuesta: si se ejecuta correctamente, contiene un objeto AddResponse . El value campo contiene el identificador del grupo de hoteles agregado.Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')
Verbo | Description |
---|---|
OBTENER | Obtiene el grupo de hoteles especificado. Cuerpo de la respuesta: contiene un objeto HotelGroup . Parámetros de plantilla:
|
PATCH | Novedades el grupo hotelero. Cuerpo de la solicitud: contiene un objeto HotelGroup que especifica solo los campos que se van a actualizar. Cuerpo de la respuesta: Ninguno. Si se ejecuta correctamente, devuelve el código de estado HTTP 204. Parámetros de plantilla:
|
ELIMINAR | Elimina el grupo de hoteles. Cuerpo de la solicitud: Ninguno. Cuerpo de la respuesta: Ninguno. Si se ejecuta correctamente, devuelve el código de estado HTTP 204. Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/Hotels
Verbo | Description |
---|---|
OBTENER | Obtiene la lista de anuncios de precios de hotel en la subcuenta especificada. La lista contiene todos los hoteles de todos los grupos de hoteles de la subcuenta. NOTA: De forma predeterminada, la lista contiene un máximo de 1000 hoteles. Para determinar el número total de hoteles en la subcuenta, use el parámetro de consulta $count . Para especificar el número de hoteles que se van a devolver, use el parámetro de consulta $top . Para recorrer todos los hoteles de una subcuenta, use los parámetros de consulta $top y $skip . NOTA: Use esta llamada a la página a través de hoteles solo en una experiencia de interfaz de usuario. No utilice esta llamada para descargar todos los hoteles. Para descargar todos los hoteles, use en su lugar la característica Informes . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos Hotel .Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels
Verbo | Description |
---|---|
OBTENER | Obtiene la lista de anuncios de precios de hotel en el grupo de hoteles especificado. NOTA: De forma predeterminada, la lista contiene un máximo de 1000 hoteles. Para determinar el número total de hoteles del grupo de hoteles, use el parámetro de consulta $count . Para especificar el número de hoteles que se van a devolver, use el parámetro de consulta $top . Para recorrer todos los hoteles de un grupo, use los parámetros de consulta $top y $skip . NOTA: Use esta llamada a la página a través de hoteles solo en una experiencia de interfaz de usuario. No utilice esta llamada para descargar todos los hoteles. Para descargar todos los hoteles, use en su lugar la característica Informes . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos Hotel .Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels('{hotelId}')
Verbo | Description |
---|---|
OBTENER | Obtiene el anuncio de hotel especificado. Cuerpo de la respuesta: contiene un objeto Hotel . Parámetros de plantilla:
|
PATCH | Novedades el anuncio del hotel. Cuerpo de la solicitud: contiene un objeto Hotel que especifica solo los campos que se van a actualizar. Cuerpo de la respuesta: Ninguno. Si se ejecuta correctamente, devuelve el código de estado HTTP 204. Parámetros de plantilla:
|
SubAccounts('{subAccountId}')/Plantilla desagrupada
Verbo | Description |
---|---|
OBTENER | Obtiene la lista de hoteles del grupo de hoteles no agrupados. Al crear una subcuenta, el servicio crea el grupo de hoteles no agrupados. Todos los hoteles de la fuente de su hotel que no están asociados de otro modo con otros grupos se colocan en este grupo. Para asociar un hotel de este grupo a otro grupo de hoteles, consulte la plantilla Asociar . NOTA: De forma predeterminada, la lista contiene un máximo de 1000 hoteles. Para determinar el número total de hoteles del grupo de hoteles no agrupados, use el parámetro de consulta $count . Para especificar el número de hoteles que se van a devolver, use el parámetro de consulta $top . Para paginar todos los hoteles del grupo, use los parámetros de consulta $top y $skip . NOTA: Use esta llamada a la página a través de hoteles solo en una experiencia de interfaz de usuario. No utilice esta llamada para descargar todos los hoteles. Para descargar todos los hoteles, use en su lugar la característica Informes . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos Hotel .Parámetros de plantilla:
|
Plantilla SubAccounts('{subAccountId}')/Associations
Verbo | Description |
---|---|
OBTENER | Obtiene una lista de asociaciones de hoteles y grupos de hoteles. NOTA: De forma predeterminada, la lista contiene un máximo de 1000 asociaciones. Para determinar el número total de asociaciones de la subcuenta, use el parámetro de consulta $count . Para especificar el número de asociaciones que se van a devolver, use el parámetro de consulta $top . Para recorrer todas las asociaciones de una subcuenta, use los parámetros de consulta $top y $skip . Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene la lista de objetos HotelAssociation .Parámetros de plantilla:
|
SubAccounts('{subAccountId}')/Plantilla de asociado
Verbo | Description |
---|---|
EXPONER | Agrega una lista de asociaciones de hoteles y grupos de hoteles a la subcuenta. Cuerpo de la solicitud: contiene un objeto AssociationCollection . El HotelAssociation campo contiene una lista con un máximo de 500 objetos HotelAssociation . Cada objeto asocia un hotel a un grupo de hoteles. Solo puede asociar un hotel a un grupo de hoteles. De forma predeterminada, los hoteles están asociados al grupo de hoteles no agrupados . Para asociar un hotel a un nuevo grupo de hoteles, use esta plantilla. Al asociar un hotel a un nuevo grupo de hoteles, el servicio elimina la asociación anterior. Cuerpo de la respuesta: contiene un objeto CollectionResponse . El value campo contiene una lista de objetos HotelAssociation . La lista contiene solo aquellas asociaciones que no pudieron validarse. La lista está vacía si no hay errores. El campo de la Errors asociación contiene la lista de motivos por los que se produjo un error en la asociación.Parámetros de plantilla:
|
Plantilla ReportJobs
Verbo | Description |
---|---|
EXPONER | Agrega una solicitud de informe a la cola de informes. Cuerpo de la solicitud: contiene el objeto ReportJob que define la solicitud de informe que va a agregar a la cola. Cuerpo de la respuesta: si la solicitud de informe se agrega correctamente a la cola, el cuerpo es un objeto AddResponse que contiene el identificador del trabajo del informe. Use el identificador en solicitudes GET posteriores para obtener el estado del trabajo de informe (consulte la plantilla ReportJobs('{jobId}'). |
ReportJobs('{jobId}')
Verbo | Description |
---|---|
OBTENER | Obtiene el estado del trabajo de informe especificado. Cuerpo de la respuesta: contiene un objeto ReportJob . Use el Status campo para determinar cuándo finaliza el trabajo. Una vez completado el trabajo, use la dirección URL del Url campo para descargar el informe.Parámetros de plantilla:
|
plantilla de $batch
Verbo | Description |
---|---|
EXPONER | Envía una solicitud por lotes que puede contener un máximo de 500 solicitudes. Más información Cuerpo de la solicitud: contiene una cadena de las solicitudes individuales. Cuerpo de la respuesta: contiene una cadena de las respuestas correspondientes. |
Parámetros de consulta
Los siguientes son los parámetros de consulta que puede especificar la solicitud.
Parámetro | Description |
---|---|
$count | Parámetro de OData que determina si la respuesta incluye un @odata.count campo. Normalmente, se incluye este parámetro cuando se solicita una lista de entidades, como una lista de grupos de hoteles. El @odata.count campo contiene el número total de entidades de recursos disponibles, no las devueltas en la solicitud. Por ejemplo, si establece $top en 40, pero existen 1000 entidades, @odata.count se establece en 1000, no en 40. Para incluir el recuento, establezca $count en true. |
$filter | Parámetro de OData que especifica una lista de expresiones usadas para filtrar los datos. NOTA: Solo puede usar el parámetro $filter con el recurso /Associations . Para obtener más información, consulte Filtrado de asociaciones de hoteles. |
$select | Parámetro OData que especifica una lista delimitada por comas de los campos que se van a incluir en la respuesta. Los nombres de campo distinguen mayúsculas de minúsculas. Por ejemplo, para incluir el nombre del hotel, el identificador de asociado y los campos de puja en la respuesta, especifique el parámetro siguiente:$select=Name,PartnerHotelId,Bid |
$skip | Parámetro de OData que especifica el número de entidades de recursos que se omitirán antes de devolver las entidades. El valor $skip debe ser un múltiplo de $top. Si especifica un valor que está fuera del intervalo, la respuesta contiene un conjunto vacío. Use $top y $skip para paginar una lista de entidades de recursos. |
$top | Parámetro de OData que especifica el número de entidades de recursos que se van a devolver. El valor predeterminado es 1000 y el valor máximo que puede especificar es 5000. Use $top y $skip para paginar una lista de entidades de recursos. |
Encabezados
A continuación se muestran los encabezados de solicitud y respuesta.
Encabezado | Descripción |
---|---|
Autorización | Encabezado de solicitud. Establezca este encabezado en un token de acceso de OAuth portador. Por ejemplo, "Authorization: Bearer QTkxRUFBRjEzOTUyNEIx...". Para obtener información sobre cómo obtener un token, consulte Introducción. |
Content-Type | Encabezado de solicitud y respuesta. Tipo de contenido en el cuerpo de la solicitud o respuesta. Para POST y PATCH, establezca este encabezado en application/json . |
X-MS-RequestId | Encabezado de respuesta. Identificador de la entrada de registro que contiene los detalles de la solicitud. Siempre debe capturar este identificador si se produce un error. Si no puede determinar y resolver el problema, incluya este identificador junto con la otra información que proporcione al equipo de soporte técnico. |
Nota:
Esta API admite el uso de tokens de acceso de OAuth solo para la autenticación (consulte el encabezado De autorización). No puede usar los encabezados UserName y Password para especificar las credenciales heredadas.
Esta API no requiere un token de desarrollador. Si incluye el encabezado DeveloperToken, la API lo omite.
Objetos de recurso
A continuación se muestran los objetos de recurso que usa la API.
Objeto | Description |
---|---|
AddResponse | Define un objeto de respuesta para las solicitudes que agregan un recurso. |
AdsApiError | Define un error que se produjo. |
AdvanceBookingWindowMultiplier | Define el importe por el que ajustar la oferta base si el usuario reserva el número especificado de días de antelación. |
AssociationCollection | Define una colección de asociaciones hotelera. |
Presupuesto | Define el presupuesto diario de los anuncios de precios de hoteles en una subcuenta. |
CollectionResponse | Define un objeto de respuesta para las solicitudes que obtienen una lista de recursos. |
CheckinDayOfWeekMultiplier | Define el importe para ajustar la oferta base por si el usuario comprueba en uno de los días laborables especificados. |
DateTypeMultiplier | Define el importe para ajustar la oferta base por si el usuario ha buscado hoteles con fechas específicas. |
DeviceMultiplier | Define la cantidad para ajustar la puja base por si el usuario usa uno de los dispositivos especificados para buscar hoteles. |
FixedBid | Define un importe de puja fijo. |
Hotel | Define un anuncio de hotel. |
HotelAssociation | Define la asociación entre un hotel y un grupo hotelero. |
HotelGroup | Define una agrupación lógica de anuncios de precios de hoteles. |
LengthOfStayMultiplier | Define el importe para ajustar la oferta base por si el usuario permanece el número especificado de noches o más. |
PercentageBid | Define una oferta en función del porcentaje de la tarifa total de habitación por noche. |
ReportJob | Define un trabajo de informe. |
SiteMultiplier | Define la cantidad para ajustar la oferta base por si el usuario está buscando hoteles en uno de los sitios de Bing especificados. |
Subcuenta | Define la agrupación de anuncios de precios de hoteles de nivel superior. Esto se puede considerar lógicamente como una campaña de hospedaje. |
UserCountryMultiplier | Define la cantidad por la que ajustar la puja base si el usuario accede a uno de los dominios de Bing. |
Nota:
Los objetos de respuesta incluyen un campo de contexto. Dado que este campo puede suprimirse en el futuro o el modelo puede cambiar, no debe depender de él. Tomar una dependencia de este campo puede interrumpir el código en el futuro.
AddResponse
Define un objeto de respuesta para las solicitudes que agregan un recurso.
Nombre | Valor | Tipo |
---|---|---|
valor | Identificador del recurso que agregó. | object |
AdsApiError
Define un error que se produjo.
Nombre | Valor | Tipo |
---|---|---|
Código | Código simbólico que identifica el error. Para obtener una lista de códigos, consulte Códigos de error. | Cadena |
Mensaje | Una descripción del error. | Cadena |
Parámetro | Nombre del objeto, campo o parámetro que produjo el error. | Cadena |
AdvanceBookingWindowMultiplier
Define el importe por el que ajustar la oferta base si el usuario reserva el número especificado de días de antelación.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 11,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
MinimumNumberOfDays | Número mínimo de días antes de la reserva. Aplique el multiplicador si la reserva tiene lugar con antelación el número especificado de días o más. | Entero | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.AdvanceBookingWindowMultiplier". | Cadena | Obligatorio | Obligatorio |
AssociationCollection
Define una colección de asociaciones hotelera.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
HotelAssociations | Lista de asociaciones hotelera y hotelera. La lista puede contener un máximo de 500 asociaciones. | HotelAssociation[] | Obligatorio | N/D |
Oferta
Define la clase base para una oferta.
No especifique esta clase, sino que especifique la clase FixedBid o PercentageBid .
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Amount | Importe de la oferta en dólares. Para obtener más información sobre el intervalo de pujas válido para el mercado, consulte la tabla Valor de moneda del tema Monedas . La cuenta del cliente especifica la moneda utilizada. | Doble | Obligatorio | Opcional |
Presupuesto
Define el presupuesto diario de los anuncios de precios de hoteles en una subcuenta.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Amount | Importe del presupuesto diario. Para obtener más información sobre los presupuestos válidos para el mercado, consulte la tabla Valor de moneda en el tema Monedas . La cuenta del cliente especifica la moneda utilizada para el presupuesto. | Doble | Obligatorio | Opcional |
CheckinDayOfWeekMultiplier
Define el importe para ajustar la oferta base por si el usuario comprueba en uno de los días laborables especificados.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
DaysOfWeek | Una lista de días laborables. Aplique el multiplicador si el usuario está comprobando uno de los días especificados. A continuación se muestran los posibles valores que distinguen mayúsculas de minúsculas.
|
Cadena[] | Obligatorio | Opcional |
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.CheckinDayOfWeekMultiplier". | Cadena | Obligatorio | Obligatorio |
CollectionResponse
Define un objeto de respuesta para las solicitudes que obtienen una lista de recursos.
Nombre | Valor | Tipo |
---|---|---|
valor | Lista de recursos solicitados. En función de la solicitud, la lista contiene uno de los siguientes tipos de objetos:Por ejemplo, si solicita una lista de grupos de hoteles, value contiene una lista de HotelGroup objetos. |
object[] |
@odata.count | Número total de entidades de recursos disponibles, no el número de entidades de Value . La respuesta incluye este campo solo si incluye el parámetro de consulta $count en la solicitud. |
DateTypeMultiplier
Define el importe para ajustar la oferta base por si el usuario ha buscado hoteles con fechas específicas.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
DateType | Tipo de fecha utilizado en la búsqueda. A continuación se muestran los posibles valores que distinguen mayúsculas de minúsculas.
|
Cadena[] | Obligatorio | Opcional |
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.DateTypeMultiplier". | Cadena | Obligatorio | Obligatorio |
DeviceMultiplier
Define la cantidad para ajustar la puja base por si el usuario usa uno de los dispositivos especificados para buscar hoteles.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
DeviceTypes | Una lista de tipos de dispositivo. Aplique el multiplicador si el usuario usa el tipo de dispositivo para buscar hoteles. A continuación se muestran los posibles valores que distinguen mayúsculas de minúsculas.
|
Cadena[] | Obligatorio | Opcional |
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.DeviceMultiplier". | Cadena | Obligatorio | Obligatorio |
FixedBid
Define un importe de puja fijo.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Amount | El importe de la oferta en dólares fijos. Para obtener más información sobre el intervalo de pujas válido para el mercado, consulte la tabla Valor de moneda del tema Monedas . La cuenta del cliente especifica la moneda utilizada. El importe de la oferta es la puja por noche. Por ejemplo, si la oferta es de 3,50 USD y el itinerario es para una estancia de 3 noches, la puja final es de 10,50 USD. |
Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.FixedBid". | Cadena | Obligatorio | Obligatorio |
Hotel
Define un anuncio de hotel.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Oferta | La oferta base. Microsoft usa esta oferta en la subasta a menos que especifique uno o varios multiplicadores (consulte BidMultipliers ). Si no especifica una oferta, el hotel hereda la oferta del grupo o subcuenta del hotel, en ese orden. Al obtener un hotel, si el hotel no especifica una oferta, este campo contiene la oferta heredada.A continuación se muestran los tipos de ofertas que puede especificar.Para pausar el hotel, especifique un porcentaje de puja y establezca su importe de puja en cero (0). Para quitar la oferta del hotel, establezca en Bid null. |
object | N/D | Opcional |
BidMultipliers | Lista de multiplicadores que se aplicarán a la oferta base. Microsoft aplica los multiplicadores a la oferta base y usa la oferta ajustada en la subasta. Si el hotel no especifica una oferta, los multiplicadores ajustan la puja heredada. Si no especifica multiplicadores, el hotel los hereda del grupo o subcuenta del hotel, en ese orden. Al obtener un hotel, si el hotel no especifica multiplicadores, este campo contiene los multiplicadores heredados. Si el hotel especifica multiplicadores y desea quitarlos, establezca en BidMultipliers una matriz vacía.Los siguientes son los tipos de multiplicadores que puede especificar. |
object[] | N/D | Opcional |
BidMultiplierSource | Origen de los multiplicadores de puja. A continuación se muestran los valores posibles.
|
Cadena | N/D | Solo lectura |
BidSource | Origen de la oferta. A continuación se muestran los valores posibles.
|
Cadena | N/D | Solo lectura |
CountryCode | El código de condado ISO 3116 de dos letras del país donde se encuentra el hotel. El país es el mismo país que especificó para el hotel en el archivo de fuente del hotel. | Cadena | Solo lectura | Solo lectura |
Id | Identificador generado por el sistema que identifica de forma única el hotel. | Cadena | N/D | Obligatorio |
Nombre | El nombre del hotel. El nombre es el mismo que especificó en el archivo de fuente del hotel. | Cadena | N/D | Solo lectura |
PartnerHotelId | El identificador que usó para identificar el hotel en el archivo de fuentes del hotel. | Cadena | N/D | Solo lectura |
Estado | Estado de la entidad hotelera. A continuación se muestran los valores posibles.
|
Cadena | N/D | Solo lectura |
HotelAssociation
Define la asociación entre un hotel y un grupo hotelero.
La columna Actualizar contiene valores N/A porque no hay ninguna operación de actualización HTTP. Para actualizar la asociación de un hotel, use una operación Agregar (POST). Consulte la plantilla Asociar .
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Errores | Lista de los motivos por los que la asociación no pudo validarse. La respuesta incluye este campo solo si la asociación no pudo validarse cuando intentó agregarlo. |
AdsApiError | Solo lectura | N/D |
HotelGroupId | El identificador del grupo de hoteles con el que se va a asociar el hotel. | Cadena | Obligatorio | N/D |
HotelGroupName | Nombre del grupo de hoteles. | Cadena | Solo lectura | N/D |
HotelId | Identificador del hotel que se va a asociar al grupo de hoteles especificado (consulte HotelGroupId ). Puede asociar el hotel a un solo grupo de hoteles.De forma predeterminada, todos los hoteles están asociados a un grupo de hoteles, ya sea un grupo definido por el usuario o el grupo de hoteles desagrupado predeterminado. Para mover un hotel de un grupo a otro, publique una nueva asociación que especifique el id. de hotel y el nuevo id. de grupo de hotel; el servicio quita la asociación anterior. |
Cadena | Obligatorio | N/D |
HotelName | El nombre del hotel. | Cadena | Solo lectura | N/D |
PartnerHotelId | Identificador que usó para especificar el hotel en el archivo de fuentes del hotel. | Cadena | Solo lectura | N/D |
HotelGroup
Define una agrupación lógica de hoteles.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Oferta | La oferta base que los hoteles del grupo heredan si no especifican una oferta. Para obtener información sobre el uso, consulte Bid en el objeto Hotel .Si no especifica una oferta, el grupo hereda la puja de la subcuenta. Al obtener un grupo de hoteles, si el grupo no especifica una oferta, este campo contiene la oferta heredada. A continuación se muestran los tipos de ofertas que puede especificar.Para pausar todos los hoteles del grupo, especifique un porcentaje de puja y establezca su importe de puja en cero (0). Para quitar la puja del grupo, establezca en Bid null. |
object | Opcional | Opcional |
BidMultipliers | Lista de multiplicadores que los hoteles del grupo heredan si no especifican multiplicadores. Para obtener información sobre el uso, consulte BidMultipliers en el objeto Hotel .Si no especifica multiplicadores, el grupo los hereda de la subcuenta. Si el grupo de hoteles especifica multiplicadores y desea quitarlos, establezca en BidMultipliers una matriz vacía.Los siguientes son los tipos de multiplicadores que puede especificar. |
object[] | Opcional | Opcional |
BidMultiplierSource | Origen de los multiplicadores de puja. A continuación se muestran los valores posibles.
|
Cadena | Solo lectura | Solo lectura |
BidSource | Origen de la oferta. A continuación se muestran los valores posibles.
|
Cadena | Solo lectura | Solo lectura |
HotelAssociationCount | Número de hoteles asociados al grupo hotelero. | Unsigned Integer | Solo lectura | Solo lectura |
Id | Identificador generado por el sistema que identifica de forma única el grupo. | Cadena | Solo lectura | Obligatorio |
Nombre | Nombre del grupo. El nombre puede contener un máximo de 256 caracteres. | Cadena | Obligatorio | Solo lectura |
Estado | Estado de la entidad del grupo de hoteles. A continuación se muestran los valores posibles.
|
Cadena | Solo lectura | Solo lectura |
LengthOfStayMultiplier
Define el importe para ajustar la oferta base por si el usuario permanece el número especificado de noches o más.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
MinimumNumberOfNights | Número mínimo de noches necesarias para aplicar el multiplicador. Aplique el multiplicador si el usuario permanece el número especificado de noches o más. Los valores válidos son de 1 a 14. | Entero | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.LengthOfStayMultiplier". | Cadena | Obligatorio | Obligatorio |
Multiplicador
Define la clase base para un multiplicador.
No especifique esta clase, sino que especifique una de las clases de multiplicador, como UserCountryMultiplier.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
PercentageBid
Define una oferta en función del porcentaje de la tarifa total de habitación por noche, incluidos los impuestos y otras tarifas.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Amount | El porcentaje de puja. El intervalo válido es de 0 a 1000. Por ejemplo, para pujar el 5 por ciento de la tasa total de la sala, establezca en Amount 5,0.El importe de la oferta es la puja por noche. Por ejemplo, si la oferta es del 3 %, la tarifa total de la habitación es de 99 USD y el itinerario es para una estancia de 3 noches, la oferta final es de 8,91 USD. |
Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.PercentageBid". | Cadena | Obligatorio | Obligatorio |
ReportJob
Define un trabajo de informe.
Nombre | Valor | Tipo | Agregar |
---|---|---|---|
Columnas | Lista de columnas que se van a incluir en el informe. El orden en que el informe los incluye no está determinado. El servicio de informes también puede intercalar otras columnas pertinentes no solicitadas explícitamente. Los nombres de columna distinguen mayúsculas de minúsculas. Para obtener una lista de nombres de columna, vea Columnas de informe para el tipo de informe que está solicitando (por ejemplo, para PerformanceReport, vea Columnas de informe de rendimiento). Las columnas deben incluir en concesión una columna de tipo dimensión y una columna de tipo métrica. | Cadena[] | Obligatorio |
Compresión | Tipo de compresión que se va a aplicar al informe. A continuación se muestran los posibles valores que no distinguen mayúsculas de minúsculas.
|
Cadena | Opcional |
EndDate | Fecha de finalización UTC del informe con el formato AAAA-MM-dd. El mes y el día deben contener dos dígitos. Por ejemplo, en lugar de 2018-1-4, use 2018-01-04. El informe contiene datos que se encuentran dentro de las fechas de inicio y finalización, inclusive. La fecha de finalización debe estar en o posterior a la fecha de inicio. NOTA: Al sondear para obtener el estado del trabajo, el servicio devuelve la fecha con el formato AAAA-MM-ddTHH:mm:ssZ (por ejemplo, 2017-10-30T00:00:00Z). |
Cadena | Obligatorio |
Filtro | Cadena de filtro de OData que se va a aplicar. La longitud máxima de la cadena de filtro es de 1000 caracteres. Para obtener información sobre el uso de filtros, vea Filtrado de datos de informe. NOTA: Los nombres de columna de informe y los valores de enumeración que especifique distinguen mayúsculas de minúsculas. Por ejemplo, debe especificar DeviceType en lugar de devicetype y Desktop en lugar de desktop. |
Cadena | Opcional |
Formato | Formato del contenido del informe. A continuación se muestran los posibles valores que no distinguen mayúsculas de minúsculas.
|
Cadena | Opcional |
HotelGroupId | Id. del hotel al que se va a limitar el informe. Para establecer este campo, también debe establecer SubaccountId . |
Cadena | Opcional |
Id | Identificador que identifica de forma única el trabajo del informe. | Cadena | Solo lectura |
IncludeNonPerformingHotels | Valor booleano que determina si el informe incluye hoteles que no han recibido impresiones durante el período de informe. Para incluir hoteles que no tienen rendimiento, establezca este campo en true; De lo contrario, false. El valor predeterminado es false. Para conocer las limitaciones sobre las columnas que puede especificar al solicitar hoteles que no funcionan, consulte Inclusión de hoteles con un rendimiento incorrecto en el informe. |
Booleano | Opcional |
ReportType | Tipo de entidad o informe que se va a descargar. A continuación se muestran los posibles valores que distinguen mayúsculas de minúsculas. | Cadena | Obligatorio |
StartDate | Fecha de inicio UTC del informe con el formato AAAA-MM-dd. El mes y el día deben contener dos dígitos. Por ejemplo, 2018-1-4 debe ser 2018-01-04. La fecha más temprana que puede especificar es de tres años a partir de hoy. NOTA: Al sondear para obtener el estado del trabajo, el servicio devuelve la fecha con el formato AAAA-MM-ddTHH:mm:ssZ (por ejemplo, 2017-10-30T00:00:00Z). |
Cadena | Obligatorio |
Estado | Estado del trabajo de informe. A continuación se muestran los valores posibles.
|
Cadena | Solo lectura |
SubaccountId | Identificador de la subcuenta a la que se va a limitar el informe. | Cadena | Opcional |
Url | Dirección URL del informe que se va a descargar. El servicio proporciona la dirección URL cuando Status se completa. La dirección URL es válida durante cinco (5) minutos desde el momento en que se obtiene un trabajo de informe con Status establecido en Completado. Si la dirección URL expira, envíe una solicitud GET para obtener de nuevo el estado del trabajo y una nueva dirección URL. |
SiteMultiplier
Define la cantidad para ajustar la oferta base por si el usuario está buscando hoteles en uno de los sitios de Bing especificados.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
Sitios | Una lista de sitios. Aplique el multiplicador si el usuario usa el sitio especificado para buscar hoteles. A continuación se muestran los posibles valores que distinguen mayúsculas de minúsculas.
|
Cadena[] | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.SiteMultiplier". | Cadena | Obligatorio | Obligatorio |
Subcuenta
Define la agrupación de anuncios de precios de hoteles de nivel superior. Esto se puede considerar lógicamente como una campaña de hospedaje.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Oferta | La oferta base que heredan los hoteles si ellos, o el grupo al que pertenecen, no especifican una oferta. Para obtener información sobre el uso, consulte Bid en el objeto Hotel .A continuación se muestran los tipos de ofertas que puede especificar.Para pausar todos los hoteles de la subcuenta, especifique un porcentaje de puja y establezca su importe de puja en cero (0). |
object | Obligatorio | Opcional |
BidMultipliers | Una lista de multiplicadores que los hoteles heredan si ellos, o el grupo al que pertenecen, no especifican multiplicadores. El valor predeterminado es 0. Para obtener información sobre el uso, consulte BidMultipliers en el objeto Hotel .Si la subcuenta especifica multiplicadores y desea quitarlos, establezca en BidMultipliers una matriz vacía.Los siguientes son los tipos de multiplicadores que puede especificar. |
object[] | Opcional | Opcional |
DailyBudget | El presupuesto diario que se va a distribuir a lo largo del día. Establecer el presupuesto en 0 impide que los hoteles de la subcuenta presten servicio. |
Presupuesto | Obligatorio | Opcional |
HotelAssociationCount | Número de hoteles asociados a grupos de hoteles en la subcuenta. | Unsigned Integer | Solo lectura | Solo lectura |
Id | Identificador generado por el sistema que identifica de forma única la subcuenta. | Cadena | Solo lectura | Obligatorio |
MaximumBid | El importe de la oferta que no se va a superar. | FixedBid | Opcional | Opcional |
Nombre | Nombre de la subcuenta. El nombre puede contener un máximo de 128 caracteres. | Cadena | Obligatorio | Solo lectura |
Estado | Estado de la entidad de subcuenta. A continuación se muestran los valores posibles.
|
Cadena | Solo lectura | Solo lectura |
UserCountryMultiplier
Define la cantidad por la que ajustar la puja base si el usuario accede a uno de los dominios de Bing.
Nombre | Valor | Tipo | Agregar | Actualizar |
---|---|---|---|---|
Países | Lista de códigos de país o región ISO 3116 de dos letras. Para obtener una lista de los posibles códigos de país o región, consulte Códigos de país o región permitidos. Aplique el multiplicador si el usuario accede al dominio de Bing con el código de país especificado. Por ejemplo, si la lista incluye US y DE, Microsoft usa el multiplicador si el usuario usa Bing.com con el código us o de country (por ejemplo, bing.com?cc=de). |
Cadena[] | Obligatorio | Opcional |
Factor | Cantidad porcentual por la que ajustar la oferta base. El intervalo válido es de 0,00 a 10,00. Por ejemplo, si la puja fija es de 5 USD y el multiplicador es 5, la puja final es de 25 USD. Con el mismo multiplicador, si el porcentaje de puja es del 5 % y la tarifa total de la habitación es de 100 USD, la puja final es de 25 USD. | Doble | Obligatorio | Opcional |
@odata.type | Tipo del objeto. Este campo se establece en "#Model.UserCountryMultiplier". | Cadena | Obligatorio | Obligatorio |
Códigos de estado HTTP
Las solicitudes pueden devolver los siguientes códigos de estado HTTP.
Código de estado | Descripción |
---|---|
200 | Se recuperó correctamente el recurso. |
201 | Se agregó correctamente el recurso. |
204 | Ha actualizado o eliminado correctamente el recurso. |
400 | Solicitud incorrecta. Un valor de parámetro de consulta no es válido o el contenido del cuerpo de la solicitud no es válido. |
401 | No autorizado. Las credenciales del usuario no son válidas. |
403 | Prohibido. La dirección URL de descarga del informe ha expirado. Tiene siete días a partir del momento en que obtiene la dirección URL para descargar el informe. Si la dirección URL expira, debe enviar una nueva solicitud de trabajo. |
404 | No encontrado. |
429 | Demasiadas solicitudes. La API limita el número de solicitudes que puede realizar por minuto. El límite no está documentado y está sujeto a cambios. La API devuelve este código de estado si supera el límite. Debe esperar 60 después de recibir este error antes de volver a enviar la solicitud. |
500 | Error del servidor. |
Códigos de error
Informes de códigos de error
Código de error | Descripción |
---|---|
CompressionTypeNotSupported | El Compression campo se establece en un valor que no se admite. Para obtener una lista de los algoritmos de compresión admitidos, consulte Compresión. |
DuplicateValues | El campo Columnas contiene el mismo nombre de columna más de una vez. |
FilterTooLong | La cadena de filtro OData establecida Filter en es demasiado larga. Para obtener la longitud máxima permitida, consulte Filtro. |
FormatVersionNotSupported | El Format campo se establece en un valor que no se admite. Para obtener una lista de los formatos admitidos, consulte Formato. |
InvalidDateRange | El período de informes especificado no es válido. Para obtener información sobre cómo especificar un intervalo de fechas válido, vea los campos StarteDate y EndDate . |
InvalidReportName | El ReportType campo se establece en un nombre de informe que no es válido. Para obtener una lista de nombres de informe válidos, vea ReportType. |
InvalidSelect | Una o varias de las columnas especificadas no son válidas. Compare los nombres de columna que usó con los documentados para el informe que solicitó. Recuerde que los nombres distinguen mayúsculas de minúsculas. |
Códigos de país o región
Puede usar los siguientes códigos de país o región para establecer el Countries
campo UserCountryMultiplier.
Nombre de país o región | Código de país o región |
---|---|
Afganistán | AF |
Albania | AL |
Argelia | DZ |
Andorra | ANUNCIO |
Angola | AO |
Anguila | AI |
Antártida | AQ |
Antigua y Barbuda | AG |
Antillas (Países Bajos) | UN |
Samoa Americana | AS |
Argentina | AR |
Armenia | SOY |
Aruba | AW |
Australia | AU |
Austria | AT |
Azerbaiyán | AZ |
Bahamas | BS |
Baréin | BH |
Bangladesh | BD |
Barbados | BB |
Belarús | POR |
Bélgica | SER |
Belice | BZ |
Bermudas | BM |
Benín | BJ |
Bután | BT |
Bolivia | BO |
Bosnia y Herzegovina | BA |
Botsuana | BW |
Brasil | BR |
Brunéi | BN |
Bulgaria | BG |
Burkina Faso | BF |
Burundi | BI |
Cabo Verde | VC |
Camboya | KH |
Camerún | CM |
Canada | CA |
Islas Caimán | KY |
República Centroafricana | CF |
Chad | TD |
Chile | CL |
China | CN |
Isla de Navidad | CX |
Islas Cocos | CC |
Colombia | CO |
Comoras | KM |
Congo | CG |
Congo (República Democrática del Congo) | CD |
Islas Cook | CK |
Costa Rica | CR |
Côte d'Ivoire | CI |
Croacia | HR |
Chipre | CY |
Chequia | CZ |
Dinamarca | DK |
Yibuti | DJ |
Dominica | DM |
República Dominicana | HACER |
Ecuador | CE |
Egipto | EG |
El Salvador | SV |
Guinea Ecuatorial | GQ |
Eritrea | EMERGENCIA |
Estonia | EE |
Eswatini | SZ |
Etiopía | ET |
Islas Malvinas | FK |
Islas Feroe | FO |
Fiyi | FJ |
Finlandia | FI |
Francia | FR |
Guayana Francesa | GF |
Polinesia Francesa | PF |
Gabón | GA |
Gambia | GM |
Georgia | GE |
Alemania | DE |
Ghana | GH |
Gibraltar | GI |
Grecia | GR |
Groenlandia | GL |
Granada | GD |
Guadalupe | GP |
Guam | GU |
Guatemala | Gt |
Guinea | GN |
Guinea-Bisáu | GW |
Guyana | GY |
Haití | HT |
Santa Sede | VA |
Honduras | HN |
RAE de Hong Kong | HK |
Hungría | HU |
Islandia | ES |
India | EN |
Indonesia | Id. |
Irak | IQ |
Irlanda | IE |
Israel | IL |
Italia | TI |
Jamaica | JM |
Japón | JP |
Jordania | JO |
Kazajistán | KZ |
Kenia | KE |
Kiribati | KI |
Corea | KR |
Kuwait | KW |
Kirguistán | KG |
República Democrática de Lao Personas | LA |
Letonia | LV |
Líbano | LB |
Lesoto | LS |
Liberia | LR |
Libia | LY |
Liechtenstein | LI |
Lituania | LT |
Luxemburgo | LU |
Macao SAR | MO |
Madagascar | MG |
Malaui | MW |
Malasia | MI |
Maldivas | MV |
Mali | ML |
Malta | MT |
Islas Marshall | MH |
Martinica | MQ |
Mauritania | SR |
Mauricio | MU |
Mayotte | YT |
México | MX |
Micronesia | FM |
Moldova | MD |
Mónaco | MC |
Mongolia | MN |
Montenegro | YO |
Montserrat | SRA |
Marruecos | MA |
Mozambique | MZ |
Myanmar | MM |
Namibia | ND |
Nauru | NR |
Nepal | NP |
Países Bajos | NL |
Nueva Caledonia | NC |
Nueva Zelanda | NZ |
Nicaragua | NI |
Níger | NE |
Nigeria | NG |
Niue | NU |
Isla Norfolk | NF |
Noruega | NO |
Macedonia del Norte | MK |
Islas Marianas del Norte | MP |
Omán | OM |
Pakistán | PK |
Palaos | PW |
Autoridad Nacional Palestina | PS |
Panamá | PA |
Papúa-Nueva Guinea | PG |
Paraguay | PY |
Perú | PE |
Filipinas | PH |
Islas Pitcairn | PN |
Polonia | PL |
Portugal | PT |
Puerto Rico | PR |
Qatar | QA |
Reunión | RE |
Rumanía | RO |
Federación Rusa | RU |
Ruanda | RW |
Santa Helena, Ascensión y Tristán da Cunha | SH |
San Cristóbal y Nieves | KN |
Santa Lucía | LC |
San Pedro y Miquelón | PM |
San Vicente y las Granadinas | VC |
San Marino | SM |
São Tomé y Príncipe | ST |
Arabia Saudí | SA |
Senegal | SN |
Serbia | RS |
Seychelles | SC |
Sierra Leona | SL |
Singapur | SG |
Eslovaquia | SK |
Eslovenia | SI |
España | ES |
Islas Salomón | SB |
Samoa | WS |
Somalia | Así que |
Sudáfrica | ZA |
Sri Lanka | LK |
Surinam | SR |
Suecia | SE |
Suiza | CH |
Taiwán | TW |
Tayikistán | TJ |
Tanzania | TZ |
Tailandia | TH |
Timor-Leste | TL |
Togo | TG |
Tokelau | TK |
Tonga | PARA |
Trinidad y Tobago | TT |
Túnez | TN |
Türkiye | TR |
Turkmenistán | TM |
Islas Turcas y Caicos | TC |
Tuvalu | TV |
Uganda | UG |
Ucrania | UA |
Emiratos Árabes Unidos | AE |
Reino Unido | GB |
Estados Unidos | EE. UU. |
Uruguay | UY |
Uzbekistán | UZ |
Vanuatu | VU |
Venezuela | VE |
Vietnam | VN |
Islas Vírgenes (Británicas) | VG |
Islas Vírgenes (Ee. UU.) | VI |
Wallis y Futuna | WF |
Yemen | VOSOTROS |
Zambia | ZM |
Zimbabue | ZW |