Referência da API de Hotel
Nota
Esta versão beta do Hotel Price Ads está disponível apenas para participantes selecionados. Para obter informações sobre como participar no programa de versão beta, contacte o seu gestor de conta ou inscreva-se aqui.
A API e a documentação estão sujeitas a alterações.
A API de Hotel permite-lhe gerir as suas campanhas publicitárias e licitações do hotel.
Pontos finais
Segue-se o URI base que utiliza para construir o ponto final.
- Produção —
https://partner.api.bingads.microsoft.com/Travel/v1/
O ponto final tem de incluir os recursos do cliente e da conta.
https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/
Defina {customerId} como CustomerId do cliente e {accountId} como CustomerAccountId do cliente.
Em seguida, acrescente um modelo da seguinte tabela para adicionar, obter e atualizar recursos hoteleiros. Por exemplo, para obter ou adicionar um grupo hoteleiro, utilize o seguinte ponto final:
https://partner.api.sandbox.bingads.microsoft.com/Travel/V1/Customers({customerId})/Accounts({accountId})/SubAccounts('{subAccountId}')/HotelGroups
Nota
Os IDs para SubAccounts, HotelGroups, Hotels e ReportJobs são cadeias e têm de estar entre plicas. Por exemplo, SubContas('12345')/HotelGroups. Isto aplica-se apenas a SubAccounts, HotelGroups, Hotels e ReportJobs; não utilize plicas para Clientes e Contas.
Modelo de Subcontas
Verbo | Descrição |
---|---|
GET | Obtém a lista de campanhas de alojamento (anteriormente campanhas hoteleiras) definidas para a conta especificada. NOTA: por predefinição, a lista contém um máximo de 1000 campanhas. Para determinar o número total de campanhas na subconta, utilize o parâmetro de consulta $count . Para especificar o número de campanhas a devolver, utilize o parâmetro de consulta $top . Para analisar todas as campanhas numa subconta, utilize os parâmetros de consulta $top e $skip . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos SubAccount . |
POST | Adiciona a subconta à conta especificada. Pode considerar as subcontas como campanhas de alojamento. Utilize subcontas para organizar logicamente as suas campanhas publicitárias de hotel. Pode ter um máximo de 50 campanhas de alojamento ativas por conta. Corpo do pedido: contém a SubConta a adicionar. Corpo da resposta: se for bem-sucedido, contém um objeto AddResponse . O value campo contém o ID da campanha de alojamento adicionada. |
Modelo SubAccounts('{subAccountId}')
Verbo | Descrição |
---|---|
GET | Obtém a subconta especificada. Corpo da resposta: contém um objeto SubAccount . Parâmetros do modelo:
|
PATCH | Atualizações a subconta. Corpo do pedido: contém um objeto SubAccount que especifica apenas esses campos a atualizar. Corpo da resposta: Nenhum. Se for bem-sucedido, devolve o código de estado HTTP 204. Parâmetros do modelo:
|
Modelo SubAccounts('{subAccountId}')/HotelGroups
Verbo | Descrição |
---|---|
GET | Obtém a lista de grupos de hotéis na subconta especificada. NOTA: por predefinição, a lista contém um máximo de 1000 grupos hoteleiros. Para determinar o número total de grupos na subconta, utilize o parâmetro de consulta $count . Para especificar o número de grupos a devolver, utilize o parâmetro de consulta $top . Para percorrer todos os grupos numa subconta, utilize os parâmetros de consulta $top e $skip . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos HotelGroup .Parâmetros do modelo:
|
POST | Adiciona o grupo hoteleiro à subconta especificada. Utilize grupos hoteleiros para criar agrupamentos lógicos de anúncios de preços de hotéis. Pode criar até 1000 grupos de hotéis ativos por subconta. Corpo do pedido: contém o HotelGroup para adicionar à subconta. Corpo da resposta: se for bem-sucedido, contém um objeto AddResponse . O value campo contém o ID do grupo hoteleiro adicionado.Parâmetros do modelo:
|
Modelo SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')
Verbo | Descrição |
---|---|
GET | Obtém o grupo hoteleiro especificado. Corpo da resposta: contém um objeto HotelGroup . Parâmetros do modelo:
|
PATCH | Atualizações o grupo hoteleiro. Corpo do pedido: contém um objeto HotelGroup que especifica apenas esses campos a atualizar. Corpo da resposta: Nenhum. Se for bem-sucedido, devolve o código de estado HTTP 204. Parâmetros do modelo:
|
ELIMINAR | Elimina o grupo hoteleiro. Corpo do pedido: Nenhum. Corpo da resposta: Nenhum. Se for bem-sucedido, devolve o código de estado HTTP 204. Parâmetros do modelo:
|
Modelo SubAccounts('{subAccountId}')/Hotels
Verbo | Descrição |
---|---|
GET | Obtém a lista de anúncios de preços de hotel na subconta especificada. A lista contém todos os hotéis em todos os grupos de hotéis na subconta. NOTA: por predefinição, a lista contém um máximo de 1000 hotéis. Para determinar o número total de hotéis na subconta, utilize o parâmetro de consulta $count . Para especificar o número de hotéis a devolver, utilize o parâmetro de consulta $top . Para percorrer todos os hotéis numa subconta, utilize os parâmetros de consulta $top e $skip . NOTA: utilize esta chamada para página através de hotéis apenas numa experiência de IU. Não utilize esta chamada para transferir todos os hotéis. Para transferir todos os hotéis, utilize a funcionalidade Relatórios . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos Hotel.Parâmetros do modelo:
|
SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Modelo hotéis
Verbo | Descrição |
---|---|
GET | Obtém a lista de anúncios de preços de hotel no grupo hoteleiro especificado. NOTA: por predefinição, a lista contém um máximo de 1000 hotéis. Para determinar o número total de hotéis no grupo hoteleiro, utilize o parâmetro de consulta $count . Para especificar o número de hotéis a devolver, utilize o parâmetro de consulta $top . Para percorrer todos os hotéis num grupo, utilize os parâmetros de consulta $top e $skip . NOTA: utilize esta chamada para página através de hotéis apenas numa experiência de IU. Não utilize esta chamada para transferir todos os hotéis. Para transferir todos os hotéis, utilize a funcionalidade Relatórios . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos Hotel.Parâmetros do modelo:
|
Modelo SubAccounts('{subAccountId}')/HotelGroups('{hotelGroupId}')/Hotels('{hotelId}')
Verbo | Descrição |
---|---|
GET | Obtém o anúncio do hotel especificado. Corpo da resposta: contém um objeto Hotel . Parâmetros do modelo:
|
PATCH | Atualizações anúncio do hotel. Corpo do pedido: contém um objeto Hotel que especifica apenas esses campos a atualizar. Corpo da resposta: Nenhum. Se for bem-sucedido, devolve o código de estado HTTP 204. Parâmetros do modelo:
|
SubContas('{subAccountId}')/Modelo sem grupo
Verbo | Descrição |
---|---|
GET | Obtém a lista de hotéis no grupo hoteleiro Sem Grupo. Quando cria uma subconta, o serviço cria o grupo hoteleiro Desagrupar. Todos os hotéis do seu feed de hotel que não estão associados a outros grupos são colocados neste grupo. Para associar um hotel neste grupo a um grupo de hotel diferente, consulte o modelo Associar . NOTA: por predefinição, a lista contém um máximo de 1000 hotéis. Para determinar o número total de hotéis no grupo hoteleiro Sem Grupo, utilize o parâmetro de consulta $count . Para especificar o número de hotéis a devolver, utilize o parâmetro de consulta $top . Para percorrer todos os hotéis no grupo, utilize os parâmetros de consulta $top e $skip . NOTA: utilize esta chamada para página através de hotéis apenas numa experiência de IU. Não utilize esta chamada para transferir todos os hotéis. Para transferir todos os hotéis, utilize a funcionalidade Relatórios . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos Hotel.Parâmetros do modelo:
|
Modelo SubAccounts('{subAccountId}')/Associations
Verbo | Descrição |
---|---|
GET | Obtém uma lista de associações de hotéis e grupos hoteleiros. NOTA: por predefinição, a lista contém um máximo de 1000 associações. Para determinar o número total de associações na subconta, utilize o parâmetro de consulta $count . Para especificar o número de associações a devolver, utilize o parâmetro de consulta $top . Para percorrer todas as associações numa subconta, utilize os parâmetros de consulta $top e $skip . Corpo da resposta: contém um objeto CollectionResponse . O value campo contém a lista de objetos HotelAssociation .Parâmetros do modelo:
|
SubContas('{subAccountId}')/Associar modelo
Verbo | Descrição |
---|---|
POST | Adiciona uma lista de associações de hotéis e grupos hoteleiros à subconta. Corpo do pedido: contém um objeto AssociationCollection . O HotelAssociation campo contém uma lista com um máximo de 500 objetos HotelAssociation . Cada objeto associa um hotel a um grupo hoteleiro. Pode associar um hotel apenas a um grupo hoteleiro. Por predefinição, os hotéis estão associados ao grupo hoteleiro Sem Grupo . Para associar um hotel a um novo grupo hoteleiro, utilize este modelo. Quando associa um hotel a um novo grupo hoteleiro, o serviço remove a associação anterior. Corpo da resposta: contém um objeto CollectionResponse . O value campo contém uma lista de objetos HotelAssociation . A lista contém apenas as associações que falharam na validação. A lista está vazia se não existirem erros. O campo da Errors associação contém a lista de motivos pelos quais a associação falhou.Parâmetros do modelo:
|
Modelo de ReportJobs
Verbo | Descrição |
---|---|
POST | Adiciona um pedido de relatório à fila do relatório. Corpo do pedido: contém o objeto ReportJob que define o pedido de relatório que está a adicionar à fila. Corpo da resposta: se o pedido de relatório for adicionado com êxito à fila, o corpo é um objeto AddResponse que contém o ID da tarefa do relatório. Utilize o ID nos pedidos GET subsequentes para obter o estado da tarefa de relatório (veja o modelo ReportJobs('{jobId}' ). |
ReportJobs("{jobId}")
Verbo | Descrição |
---|---|
GET | Obtém o estado da tarefa de relatório especificada. Corpo da resposta: contém um objeto ReportJob . Utilize o Status campo para determinar quando a tarefa é concluída. Quando a tarefa estiver concluída, utilize o URL no Url campo para transferir o relatório.Parâmetros do modelo:
|
$batch modelo
Verbo | Descrição |
---|---|
POST | Envia um pedido em lote que pode conter um máximo de 500 pedidos. Ler mais Corpo do pedido: contém uma cadeia de pedidos individuais. Corpo da resposta: contém uma cadeia das respostas correspondentes. |
Parâmetros de Consulta
Seguem-se os parâmetros de consulta que o pedido pode especificar.
Parâmetro | Descrição |
---|---|
$count | Um parâmetro OData que determina se a resposta inclui um @odata.count campo. Normalmente, inclui este parâmetro quando pede uma lista de entidades, como uma lista de grupos de hotéis. O @odata.count campo contém o número total de entidades de recursos disponíveis e não as devolvidas no pedido. Por exemplo, se definir $top como 40, mas existirem 1000 entidades, @odata.count está definido como 1000 e não 40. Para incluir a contagem, defina $count como verdadeiro. |
$filter | Um parâmetro OData que especifica uma lista de expressões utilizadas para filtrar os dados. NOTA: Pode utilizar o parâmetro $filter apenas com o recurso /Associations . Para obter mais informações, veja Filtrar associações hoteleiras. |
$select | Um parâmetro OData que especifica uma lista delimitada por vírgulas dos campos a incluir na resposta. Os nomes dos campos são sensíveis às maiúsculas e minúsculas. Por exemplo, para incluir o nome do hotel, o ID de parceiro e os campos de licitação na resposta, especifique o seguinte parâmetro:$select=Name,PartnerHotelId,Bid |
$skip | Um parâmetro OData que especifica o número de entidades de recursos a ignorar antes de devolver entidades. O valor $skip tem de ser um múltiplo de $top. Se especificar um valor fora do intervalo, a resposta contém um conjunto vazio. Utilize $top e $skip para percorrer uma lista de entidades de recursos. |
$top | Um parâmetro OData que especifica o número de entidades de recursos a devolver. O valor predefinido é 1000 e o valor máximo que pode especificar é 5000. Utilize $top e $skip para percorrer uma lista de entidades de recursos. |
Cabeçalhos
Seguem-se os cabeçalhos de pedido e resposta.
Cabeçalho | Descrição |
---|---|
Autorização | Cabeçalho do pedido. Defina este cabeçalho para um token de acesso OAuth de portador. Por exemplo, "Authorization: Bearer QTkxRUFBRjEzOTUyNEIx...". Para obter informações sobre como obter um token, consulte Introdução. |
Tipo de Conteúdo | Cabeçalho de pedido e resposta. O tipo de conteúdo no corpo do pedido ou resposta. Para POST e PATCH, defina este cabeçalho como application/json . |
X-MS-RequestId | Cabeçalho de resposta. O ID da entrada de registo que contém os detalhes do pedido. Deve sempre capturar este ID se ocorrer um erro. Se não conseguir determinar e resolver o problema, inclua este ID juntamente com as outras informações que fornecer à equipa de Suporte. |
Nota
Esta API suporta a utilização de tokens de acesso OAuth apenas para autenticação (veja o cabeçalho Autorização). Não pode utilizar os cabeçalhos Nome de Utilizador e Palavra-passe para especificar credenciais legadas.
Esta API não requer um token de programador. Se incluir o cabeçalho DeveloperToken, a API ignora-o.
Objetos de Recurso
Seguem-se os objetos de recursos utilizados pela API.
Objeto | Descrição |
---|---|
AddResponse | Define um objeto de resposta para pedidos que adicionam um recurso. |
AdsApiError | Define um erro que ocorreu. |
AdvanceBookingWindowMultiplier | Define o montante para ajustar a oferta base se o utilizador tiver o número especificado de dias de antecedência. |
AssociationCollection | Define uma coleção de associações hoteleiras. |
Orçamento | Define o orçamento diário para anúncios de preços de hotel numa subconta. |
CollectionResponse | Define um objeto de resposta para pedidos que obtêm uma lista de recursos. |
CheckinDayOfWeekMultiplier | Define o montante para ajustar a oferta base se o utilizador fizer o check-in num dos dias úteis especificados. |
DateTypeMultiplier | Define o montante para ajustar a oferta base se o utilizador procurar hotéis utilizando datas específicas. |
DeviceMultiplier | Define a quantidade para ajustar a oferta base se o utilizador estiver a utilizar um dos dispositivos especificados para procurar hotéis. |
FixedBid | Define um valor de licitação fixo. |
Hotel | Define um anúncio de hotel. |
HotelAssociation | Define a associação entre um hotel e um grupo hoteleiro. |
HotelGroup | Define um agrupamento lógico de anúncios de preços de hotel. |
LengthOfStayMultiplier | Define o montante para ajustar a oferta base se o utilizador permanecer o número especificado de noites ou mais. |
PercentageBid | Define uma oferta com base na percentagem da taxa total de salas por noite. |
ReportJob | Define uma tarefa de relatório. |
SiteMultiplier | Define o montante para ajustar a oferta base se o utilizador estiver à procura de hotéis num dos sites do Bing especificados. |
Subconta | Define o agrupamento de anúncios de preços de hotel de nível superior. Pode pensar nisto logicamente como uma campanha de alojamento. |
UserCountryMultiplier | Define a quantidade para ajustar a oferta base se o utilizador aceder a um dos domínios do Bing. |
Nota
Os objetos de resposta incluem um campo de contexto. Uma vez que este campo pode ser suprimido no futuro ou o modelo pode ser alterado, não deve assumir uma dependência do mesmo. Assumir uma dependência neste campo pode interromper o código no futuro.
AddResponse
Define um objeto de resposta para pedidos que adicionam um recurso.
Name | Valor | Tipo |
---|---|---|
valor | O ID do recurso que adicionou. | objeto |
AdsApiError
Define um erro que ocorreu.
Name | Valor | Tipo |
---|---|---|
Código | Um código simbólico que identifica o erro. Para obter uma lista de códigos, veja Códigos de erro. | Cadeia |
Mensagem | Uma descrição do erro. | Cadeia |
Parâmetro | O nome do objeto, campo ou parâmetro que causou o erro. | Cadeia |
AdvanceBookingWindowMultiplier
Define o montante para ajustar a oferta base se o utilizador tiver o número especificado de dias de antecedência.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 11,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
MinimumNumberOfDays | O número mínimo de dias antes da reserva. Aplique o multiplicador se a reserva ocorrer antecipadamente o número especificado de dias ou mais. | Número inteiro | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.AdvanceBookingWindowMultiplier". | Cadeia | Obrigatório | Obrigatório |
AssociationCollection
Define uma coleção de associações hoteleiras.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
HotelAssociations | A lista de associações hoteleiras e hoteleiras. A lista pode conter um máximo de 500 associações. | HotelAssociation[] | Obrigatório | N/D |
Licitação
Define a classe base para uma oferta.
Não especifique esta classe, em vez disso, especifique a classe FixedBid ou PercentageBid .
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Montante | O valor da oferta em dólares. Para obter detalhes sobre o intervalo de ofertas válido para o seu mercado, consulte a tabela Valor da Moeda no tópico Moedas . A conta do cliente especifica a moeda utilizada. | Duplo | Obrigatório | Opcional |
Orçamento
Define o orçamento diário para anúncios de preços de hotel numa subconta.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Montante | O montante do orçamento diário. Para obter detalhes sobre orçamentos válidos para o seu mercado, consulte a tabela Valor da Moeda no tópico Moedas . A conta do cliente especifica a moeda utilizada para o orçamento. | Duplo | Obrigatório | Opcional |
CheckinDayOfWeekMultiplier
Define o montante para ajustar a oferta base se o utilizador fizer o check-in num dos dias úteis especificados.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
DaysOfWeek | Uma lista de dias úteis. Aplique o multiplicador se o utilizador estiver a verificar um dos dias especificados. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
|
Cadeia[] | Obrigatório | Opcional |
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.CheckinDayOfWeekMultiplier". | Cadeia | Obrigatório | Obrigatório |
CollectionResponse
Define um objeto de resposta para pedidos que obtêm uma lista de recursos.
Name | Valor | Tipo |
---|---|---|
valor | A lista de recursos pedidos. Consoante o pedido, a lista contém um dos seguintes tipos de objetos:Por exemplo, se pedir uma lista de grupos de hotéis, value contém uma lista de HotelGroup objetos. |
objeto[] |
@odata.count | O número total de entidades de recursos disponíveis, não o número de entidades em Value . A resposta inclui este campo apenas se incluir o parâmetro de consulta $count no pedido. |
DateTypeMultiplier
Define o montante para ajustar a oferta base se o utilizador procurar hotéis utilizando datas específicas.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
DateType | O tipo de data utilizado na pesquisa. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
|
Cadeia[] | Obrigatório | Opcional |
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.DateTypeMultiplier". | Cadeia | Obrigatório | Obrigatório |
DeviceMultiplier
Define a quantidade para ajustar a oferta base se o utilizador estiver a utilizar um dos dispositivos especificados para procurar hotéis.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
DeviceTypes | Uma lista de tipos de dispositivo. Aplique o multiplicador se o utilizador estiver a utilizar o tipo de dispositivo para procurar hotéis. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
|
Cadeia[] | Obrigatório | Opcional |
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.DeviceMultiplier". | Cadeia | Obrigatório | Obrigatório |
FixedBid
Define um valor de licitação fixo.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Montante | O valor fixo da oferta em dólares. Para obter detalhes sobre o intervalo de ofertas válido para o seu mercado, consulte a tabela Valor da Moeda no tópico Moedas . A conta do cliente especifica a moeda utilizada. O valor da oferta é a oferta por noite. Por exemplo, se a oferta for $3,50 e o itinerário for para uma estadia de 3 noites, a oferta final é de $10,50. |
Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.FixedBid". | Cadeia | Obrigatório | Obrigatório |
Hotel
Define um anúncio de hotel.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Licitação | A oferta base. A Microsoft utiliza esta oferta no leilão, a menos que especifique um ou mais multiplicadores (consulte BidMultipliers ). Se não especificar uma oferta, o hotel herda a oferta do grupo hoteleiro ou subconta, por essa ordem. Ao obter um hotel, se o hotel não especificar uma oferta, este campo contém a oferta herdada.Seguem-se os tipos de ofertas que pode especificar.Para colocar o hotel em pausa, especifique uma oferta de percentagem e defina o valor da oferta como zero (0). Para remover a oferta do hotel, definida Bid como nula. |
objeto | N/D | Opcional |
BidMultipliers | Uma lista de multiplicadores a aplicar à oferta base. A Microsoft aplica os multiplicadores à oferta base e utiliza a oferta ajustada no leilão. Se o hotel não especificar uma oferta, os multiplicadores ajustam a oferta herdada. Se não especificar multiplicadores, o hotel herda-os do grupo hoteleiro ou subconta, por essa ordem. Ao obter um hotel, se o hotel não especificar multiplicadores, este campo contém os multiplicadores herdados. Se o hotel especificar multiplicadores e pretender removê-los, defina BidMultipliers como uma matriz vazia.Seguem-se os tipos de multiplicadores que pode especificar. |
objeto[] | N/D | Opcional |
BidMultiplierSource | A origem dos multiplicadores de ofertas. Seguem-se os valores possíveis.
|
Cadeia | N/D | Só de leitura |
BidSource | A fonte da oferta. Seguem-se os valores possíveis.
|
Cadeia | N/D | Só de leitura |
CountryCode | O código iso 3116 de duas letras do país onde está localizado o hotel. O país é o mesmo país que especificou para o hotel no seu ficheiro de feed de hotel. | Cadeia | Só de leitura | Só de leitura |
ID | Um ID gerado pelo sistema que identifica exclusivamente o hotel. | Cadeia | N/D | Obrigatório |
Name | O nome do hotel. O nome é o mesmo nome que especificou no ficheiro de feed do hotel. | Cadeia | N/D | Só de leitura |
PartnerHotelId | O ID que utilizou para identificar o hotel no ficheiro de feeds do hotel. | Cadeia | N/D | Só de leitura |
Estado | O estado da entidade hoteleira. Seguem-se os valores possíveis.
|
Cadeia | N/D | Só de leitura |
HotelAssociation
Define a associação entre um hotel e um grupo hoteleiro.
A coluna Atualização contém valores N/D porque não existe nenhuma operação de atualização http. Para atualizar a associação de um hotel, utilize uma operação Adicionar (POST). Veja o modelo Associar .
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Erros | A lista de motivos pelos quais a associação falhou a validação. A resposta inclui este campo apenas se a associação tiver falhado a validação quando tentou adicioná-la. |
AdsApiError | Só de leitura | N/D |
HotelGroupId | O ID do grupo hoteleiro ao qual associar o hotel. | Cadeia | Obrigatório | N/D |
HotelGroupName | O nome do grupo hoteleiro. | Cadeia | Só de leitura | N/D |
HotelId | O ID do hotel a associar ao grupo hoteleiro especificado (consulte HotelGroupId ). Pode associar o hotel apenas a um grupo hoteleiro.Por predefinição, todos os hotéis estão associados a um grupo hoteleiro, quer seja um grupo definido pelo utilizador ou o grupo hoteleiro não agrupado predefinido . Para mover um hotel de um grupo para outro, publique uma nova associação que especifique o ID do hotel e o novo ID do grupo hoteleiro; o serviço remove a associação anterior. |
Cadeia | Obrigatório | N/D |
HotelName | O nome do hotel. | Cadeia | Só de leitura | N/D |
PartnerHotelId | O ID que utilizou para especificar o hotel no ficheiro de feeds do hotel. | Cadeia | Só de leitura | N/D |
HotelGroup
Define um agrupamento lógico de hotéis.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Licitação | A oferta base que os hotéis do grupo herdam se não especificarem uma oferta. Para utilização, veja Bid no objeto Hotel .Se não especificar uma oferta, o grupo herda a oferta da subconta. Ao obter um grupo hoteleiro, se o grupo não especificar uma oferta, este campo contém a oferta herdada. Seguem-se os tipos de ofertas que pode especificar.Para colocar em pausa todos os hotéis no grupo, especifique uma oferta percentual e defina o valor da oferta para zero (0). Para remover a oferta do grupo, defina Bid como nula. |
objeto | Opcional | Opcional |
BidMultipliers | Uma lista de multiplicadores que os hotéis do grupo herdam se não especificarem multiplicadores. Para utilização, veja BidMultipliers no objeto Hotel .Se não especificar multiplicadores, o grupo herda-os da subconta. Se o grupo hoteleiro especificar multiplicadores e pretender removê-los, defina BidMultipliers como uma matriz vazia.Seguem-se os tipos de multiplicadores que pode especificar. |
objeto[] | Opcional | Opcional |
BidMultiplierSource | A origem dos multiplicadores de ofertas. Seguem-se os valores possíveis.
|
Cadeia | Só de leitura | Só de leitura |
BidSource | A fonte da oferta. Seguem-se os valores possíveis.
|
Cadeia | Só de leitura | Só de leitura |
HotelAssociationCount | O número de hotéis associados ao grupo hoteleiro. | Número Inteiro Não Assinado | Só de leitura | Só de leitura |
ID | Um ID gerado pelo sistema que identifica exclusivamente o grupo. | Cadeia | Só de leitura | Obrigatório |
Name | O nome do grupo. O nome pode conter um máximo de 256 carateres. | Cadeia | Obrigatório | Só de leitura |
Estado | O estado da entidade do grupo hoteleiro. Seguem-se os valores possíveis.
|
Cadeia | Só de leitura | Só de leitura |
LengthOfStayMultiplier
Define o montante para ajustar a oferta base se o utilizador permanecer o número especificado de noites ou mais.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
MinimumNumberOfNights | O número mínimo de noites necessárias para aplicar o multiplicador. Aplique o multiplicador se o utilizador permanecer no número especificado de noites ou mais. Os valores válidos são de 1 a 14. | Número inteiro | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.LengthOfStayMultiplier". | Cadeia | Obrigatório | Obrigatório |
Multiplicador
Define a classe base para um multiplicador.
Não especifique esta classe. Em vez disso, especifique uma das classes de multiplicador, como UserCountryMultiplier.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
PercentageBid
Define uma oferta com base na percentagem da taxa total de quarto por noite, incluindo impostos e outras taxas.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Montante | O valor da oferta percentual. O intervalo válido é de 0 a 1000. Por exemplo, para licitar 5% da taxa total da sala, definida Amount como 5,0.O valor da oferta é a oferta por noite. Por exemplo, se a oferta for de 3%, a taxa total da sala é de $99 e o itinerário é para uma estadia de 3 noites, então a oferta final é $8,91. |
Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.PercentageBid". | Cadeia | Obrigatório | Obrigatório |
ReportJob
Define uma tarefa de relatório.
Name | Valor | Tipo | Adicionar |
---|---|---|---|
Colunas | A lista de colunas a incluir no relatório. A ordem pela qual o relatório os inclui é indeterminada. O serviço de relatórios também pode intercalar outras colunas relevantes não explicitamente pedidas. Os nomes das colunas são sensíveis às maiúsculas e minúsculas. Para obter uma lista de nomes de colunas, consulte Colunas de Relatório para o tipo de relatório que está a pedir (por exemplo, para PerformanceReport, veja Colunas do relatório de desempenho). As colunas têm de incluir em concessão uma coluna de dimensão e uma coluna de tipo de métrica. | Cadeia[] | Obrigatório |
Compressão | O tipo de compressão a aplicar ao relatório. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas.
|
Cadeia | Opcional |
DataDadosEncom efeitos Finais | A data de fim UTC do relatório no formato AAAA-MM-dd. O mês e o dia têm de conter dois dígitos. Por exemplo, em vez de 2018-1-4, utilize 2018-01-04. O relatório contém dados que se inserem nas datas de início e de fim, inclusivamente. A data de fim tem de estar ativada ou posterior à data de início. NOTA: Quando consulta para obter o estado da tarefa, o serviço devolve a data no formato AAAA-MM-ddTHH:mm:ssZ (por exemplo, 2017-10-30T00:00:00Z). |
Cadeia | Obrigatório |
Filtro | A cadeia de filtro OData a aplicar. O comprimento máximo da cadeia de filtro é de 1000 carateres. Para obter informações sobre como utilizar filtros, veja Filtrar dados do relatório. NOTA: Os nomes das colunas do relatório e os valores de enumeração que especificar são sensíveis às maiúsculas e minúsculas. Por exemplo, tem de especificar DeviceType em vez de devicetype e Desktop em vez de ambiente de trabalho. |
Cadeia | Opcional |
Formatar | O formato dos conteúdos no relatório. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas.
|
Cadeia | Opcional |
HotelGroupId | O ID do hotel para limitar o relatório. Para definir este campo, também tem de definir SubaccountId . |
Cadeia | Opcional |
ID | Um ID que identifica exclusivamente a tarefa do relatório. | Cadeia | Só de leitura |
IncludeNonPerformingHotels | Um valor booleano que determina se o relatório inclui hotéis que não receberam impressões durante o período de relatórios. Para incluir hotéis sem desempenho, defina este campo como verdadeiro; caso contrário, falso. A predefinição é false. Para obter limitações sobre as colunas que pode especificar ao pedir hotéis sem desempenho, consulte Incluir hotéis sem desempenho no relatório. |
Booleano | Opcional |
Tipo de Relatório | O tipo de entidade ou relatório a transferir. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas. | Cadeia | Obrigatório |
Data De Início | A data de início UTC do relatório no formato AAAA-MM-dd. O mês e o dia têm de conter dois dígitos. Por exemplo, 2018-1-4 tem de ser 2018-01-04. A data mais antiga que pode especificar é daqui a três anos. NOTA: Quando consulta para obter o estado da tarefa, o serviço devolve a data no formato AAAA-MM-ddTHH:mm:ssZ (por exemplo, 2017-10-30T00:00:00Z). |
Cadeia | Obrigatório |
Estado | O estado da tarefa de relatório. Seguem-se os valores possíveis.
|
Cadeia | Só de leitura |
SubaccountId | O ID da subconta para limitar o relatório. | Cadeia | Opcional |
URL | O URL do relatório a transferir. O serviço fornece o URL quando Status está Concluído. O URL é válido durante cinco (5) minutos a partir do momento em que obtém uma tarefa de relatório definida como Status Concluída. Se o URL expirar, envie um pedido GET para obter novamente o estado da tarefa e um novo URL. |
SiteMultiplier
Define o montante para ajustar a oferta base se o utilizador estiver à procura de hotéis num dos sites do Bing especificados.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
Sites | Uma lista de sites. Aplique o multiplicador se o utilizador estiver a utilizar o site especificado para procurar hotéis. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
|
Cadeia[] | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.SiteMultiplier". | Cadeia | Obrigatório | Obrigatório |
Subconta
Define o agrupamento de anúncios de preços de hotel de nível superior. Pode pensar nisto logicamente como uma campanha de alojamento.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Licitação | A oferta base que os hotéis herdam se eles, ou o grupo a que pertencem, não especificarem uma oferta. Para utilização, veja Bid no objeto Hotel .Seguem-se os tipos de ofertas que pode especificar.Para colocar em pausa todos os hotéis na subconta, especifique uma oferta percentual e defina o valor da oferta como zero (0). |
objeto | Obrigatório | Opcional |
BidMultipliers | Uma lista de multiplicadores que os hotéis herdam se eles, ou o grupo a que pertencem, não especificarem multiplicadores. A predefinição é 0. Para utilização, veja BidMultipliers no objeto Hotel .Se a subconta especificar multiplicadores e pretender removê-los, defina BidMultipliers como uma matriz vazia.Seguem-se os tipos de multiplicadores que pode especificar. |
objeto[] | Opcional | Opcional |
DailyBudget | O orçamento diário para se espalhar ao longo do dia. Definir o orçamento como 0 impede que os hotéis na subconta sirvam. |
Orçamento | Obrigatório | Opcional |
HotelAssociationCount | O número de hotéis associados a grupos hoteleiros na subconta. | Número Inteiro Não Assinado | Só de leitura | Só de leitura |
ID | Um ID gerado pelo sistema que identifica exclusivamente a subconta. | Cadeia | Só de leitura | Obrigatório |
MaximumBid | O valor da oferta não exceder. | FixedBid | Opcional | Opcional |
Name | O nome da subconta. O nome pode conter um máximo de 128 carateres. | Cadeia | Obrigatório | Só de leitura |
Estado | O estado da entidade de subconta. Seguem-se os valores possíveis.
|
Cadeia | Só de leitura | Só de leitura |
UserCountryMultiplier
Define a quantidade para ajustar a oferta base se o utilizador aceder a um dos domínios do Bing.
Name | Valor | Tipo | Adicionar | Update |
---|---|---|---|---|
Países/Regiões | Uma lista de códigos de país/região ISO 3116 de duas letras. Para obter uma lista de possíveis códigos de país/região, veja Códigos de país/região permitidos. Aplique o multiplicador se o utilizador aceder ao domínio do Bing com o código de país especificado. Por exemplo, se a lista incluir OS E.U.A. e DE, a Microsoft utilizará o multiplicador se o utilizador utilizar Bing.com conosco ou de country code (por exemplo, bing.com?cc=de). |
Cadeia[] | Obrigatório | Opcional |
Fator | O valor percentual pelo qual ajustar a oferta base. O intervalo válido é de 0,00 a 10,00. Por exemplo, se a oferta fixa for $5 e o multiplicador for 5, a oferta final será $25. Utilizando o mesmo multiplicador, se a percentagem de licitação for de 5% e a taxa total da sala for de $100, a oferta final é de $25. | Duplo | Obrigatório | Opcional |
@odata.type | O tipo do objeto. Este campo está definido como "#Model.UserCountryMultiplier". | Cadeia | Obrigatório | Obrigatório |
Códigos de estado HTTP
Os pedidos podem devolver os seguintes códigos de estado HTTP.
Código de estado | Descrição |
---|---|
200 | O recurso foi obtido com êxito. |
201 | O recurso foi adicionado com êxito. |
204 | O recurso foi atualizado ou eliminado com êxito. |
400 | Pedido incorreto. Um valor de parâmetro de consulta não é válido ou o conteúdo no corpo do pedido não é válido. |
401 | Não autorizado. As credenciais do utilizador não são válidas. |
403 | Proibido. O URL de transferência do relatório expirou. Tem sete dias a partir do momento em que obtém o URL para transferir o relatório. Se o URL expirar, tem de submeter um novo pedido de tarefa. |
404 | Não encontrado. |
429 | Demasiados pedidos. A API limita o número de pedidos que pode fazer por minuto. O limite não está documentado e está sujeito a alterações. A API devolve este código de estado se exceder o limite. Tem de aguardar 60 depois de receber este erro antes de reenviar o pedido. |
500 | Erro do servidor. |
Códigos de erro
Comunicar códigos de erro
Código de erro | Descrição |
---|---|
CompressionTypeNotSupported | O Compression campo está definido como um valor que não é suportado. Para obter uma lista de algoritmos de compressão suportados, veja Compressão. |
DuplicateValues | O campo Colunas contém o mesmo nome de coluna mais do que uma vez. |
FilterTooLong | A cadeia de filtro OData que definiu Filter como é demasiado longa. Para obter o comprimento máximo permitido, veja Filtrar. |
FormatVersionNotSupported | O Format campo está definido como um valor que não é suportado. Para obter uma lista de formatos suportados, consulte Formatar. |
InvalidDateRange | O período de relatórios que especificou não é válido. Para obter informações sobre como especificar um intervalo de datas válido, veja os campos StarteDate e EndDate . |
InvalidReportName | O ReportType campo está definido como um nome de relatório que não é válido. Para obter uma lista de nomes de relatório válidos, veja ReportType. |
InvalidSelect | Uma ou mais das colunas que especificou não são válidas. Compare os nomes das colunas que utilizou com os documentados para o relatório que pediu. Lembre-se de que os nomes são sensíveis às maiúsculas e minúsculas. |
Códigos de país ou região
Pode utilizar os seguintes códigos de país/região para definir o Countries
campo userCountryMultiplier.
Nome do país/região | Código de país/região |
---|---|
Afeganistão | AF |
Albânia | AL |
Argélia | DZ |
Andorra | AD |
Angola | AO |
Anguila | IA |
Antárctica | AQ |
Antígua e Barbuda | AG |
Antilhas (Países Baixos) | AN |
Samoa Americana | AS |
Argentina | AR |
Arménia | AM |
Aruba | AW |
Austrália | AU |
Áustria | AT |
Azerbaijão | AZ |
Baamas | BS |
Barém | BH |
Bangladeche | BD |
Barbados | BB |
Bielorrússia | BY |
Bélgica | BE |
Belize | BZ |
Bermudas | BM |
Benim | BJ |
Butão | BT |
Bolívia | BO |
Bósnia e Herzegovina | BA |
Botsuana | BW |
Brasil | BR |
Brunei | BN |
Bulgária | BG |
Burquina Faso | BF |
Burundi | BI |
Cabo Verde | CV |
Camboja | KH |
Camarões | CM |
Canadá | AC |
Ilhas Caimão | KY |
República Centro-Africana | CF |
Chade | TD |
Chile | CL |
China | CN |
Ilha do Natal | CX |
Ilhas Cocos | CC |
Colômbia | CO |
Comores | KM |
Congo | CG |
Congo (República Democrática do ) | CD |
Ilhas Cook | CK |
Costa Rica | CR |
Côte d'Ivoire | CI |
Croácia | RH |
Chipre | CY |
República Checa | CZ |
Dinamarca | DK |
Jibuti | DJ |
Domínica | DM |
República Dominicana | DO |
Equador | EC |
Egito | Por exemplo, |
Salvador | SV |
Guiné Equatorial | GQ |
Eritreia | ER |
Estónia | EE |
Eswatini | SZ |
Etiópia | ET |
Ilhas Falkland (Malvinas) | FK |
Ilhas Faroé | FO |
Fiji | FJ |
Finlândia | FI |
França | FR |
Guiana Francesa | GF |
Polinésia Francesa | PF |
Gabão | Agente Convidado |
Gâmbia | GM |
Geórgia | GE |
Alemanha | DE |
Gana | GH |
Gibraltar | GI |
Grécia | GR |
Gronelândia | GL |
Granada | GD |
Guadalupe | GP |
Guame | GU |
Guatemala | GT |
Guiné | GN |
Guiné-Bissau | GW |
Guiana | GY |
Haiti | HT |
Santa Sé | VA |
Honduras | HN |
RAE de Hong Kong | HK |
Hungria | HU |
Islândia | IS |
Índia | IN |
Indonésia | ID |
Iraque | QI |
Irlanda | IE |
Israel | IL |
Itália | TI |
Jamaica | JM |
Japão | JP |
Jordânia | JO |
Cazaquistão | KZ |
Quénia | KE |
Quiribáti | KI |
Coreia | KR |
Kuwait | KW |
Quirguizistão | KG |
República Democrática de Lao Pessoas | LA |
Letónia | LV |
Líbano | LB |
Lesoto | LS |
Libéria | LR |
Líbia | LY |
Listenstaine | LI |
Lituânia | LT |
Luxemburgo | LU |
RAE de Macau | MO |
Madagáscar | MG |
Maláui | MW |
Malásia | O MEU |
Maldivas | MV |
Mali | ML |
Malta | MT |
Ilhas Marshall | MH |
Martinica | MQ |
Mauritânia | MR |
Maurícia | MU |
Maiote | YT |
México | MX |
Micronésia | FM |
Moldova | MD |
Mónaco | MC |
Mongólia | MN |
Montenegro | ME |
Monserrate | MS |
Marrocos | MA |
Moçambique | Rede de perímetro |
Mianmar | MM |
Namíbia | NA |
Nauru | NR |
Nepal | NP |
Países Baixos | NL |
Nova Caledónia | NC |
Nova Zelândia | NZ |
Nicarágua | NI |
Níger | NE |
Nigéria | NG |
Niuê | NU |
Ilha Norfolk | NF |
Noruega | NÃO |
Macedónia do Norte | MK |
Ilhas Marianas do Norte | MP |
Omã | OM |
Paquistão | PK |
Palau | PW |
Autoridade Palestiniana | PS |
Panamá | PA |
Papua-Nova Guiné | PG |
Paraguai | PY |
Peru | PE |
Filipinas | PH |
Pitcairn | PN |
Polónia | PL |
Portugal | PT |
Porto Rico | PR |
Catar | QA |
Reunião | RE |
Roménia | RO |
Federação Russa | RU |
Ruanda | RW |
Santa Helena, Ascensão e Tristão da Cunha | SH |
São Cristóvão e Neves | KN |
Santa Lúcia | LC |
São Pedro e Miquelão | PM |
São Vicente e Granadinas | VC |
San Marino | SM |
São Tomé e Príncipe | ST |
Arábia Saudita | SA |
Senegal | SN |
Sérvia | RS |
Seicheles | SC |
Serra Leoa | SL |
Singapura | SG |
Eslováquia | SK |
Eslovénia | SI |
Espanha | ES |
Ilhas Salomão | SB |
Samoa | WS |
Somália | SO |
África do Sul | ZA |
Sri Lanka | LK |
Suriname | SR |
Suécia | SE |
Suíça | CH |
Taiwan | TW |
Tajiquistão | TJ |
Tanzânia | TZ |
Tailândia | TH |
Timor-Leste | TL |
Togo | TG |
Toquelau | TK |
Tonga | PARA |
Trindade e Tobago | TT |
Tunísia | TN |
Türkiye | TR |
Turquemenistão | TM |
Ilhas Turcas e Caicos | TC |
Tuvalu | TV |
Uganda | UG |
Ucrânia | UA |
Emirados Árabes Unidos | AE |
Reino Unido | GB |
Estados Unidos | E.U.A |
Uruguai | UY |
Usbequistão | UZ |
Vanuatu | VU |
Venezuela | VE |
Viet Nam | VN |
Ilhas Virgens (Britânicas) | VG |
Ilhas Virgens (E.U.A.) | VI |
Wallis e Futuna | WF |
Iémen | VÓS |
Zâmbia | ZM |
Zimbabué | ZW |