Usage

Nesta página, você verá alguns exemplos de chamadas usando a API Travel Partner v3.

Os endpoints da API Travel Partner usam sintaxe REST para chamadas HTTPS por HTTPS. O base_url para todas as solicitações de API é:

https://travelpartner.googleapis.com/v3/accounts/account_id

Para ver a lista completa de campos de solicitação e resposta, confira o catálogo de recursos de API.

Relatório de desempenho de propriedades

O serviço de visualização de relatório de desempenho de propriedade permite consultar (receber, filtrar e segmentar) um relatório de desempenho de propriedade de uma determinada conta.

Como consultar um relatório de desempenho da propriedade

No exemplo a seguir, o relatório de desempenho de todas as propriedades na conta 12345678 é filtrado, filtrado até a data de 11 de maio de 2022 e agrupado pelo ID de hotel do parceiro.

GET https://travelpartner.googleapis.com/v3/accounts/12345678/propertyPerformanceReportViews:query?filter=date%20%3D%20%272022-05-11%27&aggregateBy=partnerPropertyId

Hotel

O Serviço de visualização de hotéis oferece uma lista de todos os hotéis ou um resumo deles para uma conta específica.

Como receber uma lista de hotéis

O exemplo a seguir recupera uma lista de todos os hotéis na conta 12345678:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/hotelviews

A solicitação aceita parâmetros de consulta para navegar pelos resultados de várias páginas:

GET base_url/hotelviews?pageSize=10&pageToken=11

Como acessar um resumo de propriedades

Este exemplo recebe um resumo das propriedades da conta 12345678:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/hotelviews:summarize

Relatório de participação

O serviço de visualização de relatórios de participação permite consultar (receber, filtrar e segmentar) um relatório de participação de uma conta específica.

Como consultar um relatório de participação

O exemplo a seguir recebe o relatório de participação para todas as propriedades na conta 12345678 e filtra o relatório usando uma data de 4/10/20.

GET https://travelpartner.googleapis.com/v3/accounts/12345678/participationReportViews:query?filter=date%20%3D%20%272020-10-04%27

Nível de exatidão do preço

Com o Serviço de visualizações do nível de precisão do preço, é possível recuperar relatórios e visões gerais de exatidão do preço de uma determinada conta.

Como gerar um relatório de nível de precisão do preço

O exemplo a seguir recupera o Relatório de precisão de preços em 26/08/2019 para a conta 12345678:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews/20190826

Além dos parâmetros de consulta comuns para paginação pela resposta, há mais alguns para incluir preços correspondentes ou sinais de pixel nos resultados.

Neste exemplo, o relatório de precisão de preços em 26/08/2019 inclui preços correspondentes e indicadores de pixel:

GET base_url/priceAccuracyViews/20190826?includeMatchedPrices=true&includePixels=true

Como listar os relatórios de nível de precisão do preço

Para ver uma lista dos relatórios disponíveis, envie esta solicitação:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews

É possível incluir os parâmetros de consulta comuns para paginação nos resultados.

Como receber uma pontuação por nível de precisão do preço

Para acessar a visão geral do nível de precisão do preço, use o método summarize:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews:summarize

Cobertura de preços

O serviço de visualizações de cobertura de preço fornece o relatório de cobertura de preço mais recente ou todo o histórico de cobertura de preço.

Confira as estatísticas de cobertura de preço mais recentes

O exemplo a seguir recupera as estatísticas de cobertura de preço mais recentes da conta 12345678:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceCoverageViews:latest

Como acessar o histórico de cobertura de preços

Essa solicitação recebe todo o histórico de cobertura de preço de uma conta:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceCoverageViews

Preço

Com o serviço de visualização de preços, é possível recuperar um relatório de preços de uma determinada propriedade.

Como receber dados de preços para uma propriedade

Para ver o relatório de preços de um hotel específico (ID = 101) pertencente à conta 12345678, emita esta solicitação:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceViews/101

Relatórios de reconciliação

O serviço de relatórios de reconciliação

Obter uma lista de relatórios de reconciliação

O exemplo a seguir mostra uma lista de relatórios para a conta 12345678:

GET https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports

Você pode incluir parâmetros opcionais de consulta de data de início e de término para limitar os resultados. Por exemplo, esta consulta limita a geração de relatórios somente aos que estão entre 15/06/2019 e 15/09/2019:

GET base_url/reconciliationReports?startDate=2019-06-15&endDate=2019-09-15

Download de um relatório de conciliação

Este exemplo recupera o relatório booking_report.csv (como uma resposta JSON) que foi carregado em 2019-08-26T12:00:00:

GET base_url/reconciliationReports/2019-08-26T12%3A00%3A00~bookings.csv

Validar um relatório de reconciliação

Você pode usar esse método para validar o relatório antes de fazer upload dele. A validação de um relatório não o envia.

O relatório de reconciliação está incluído no corpo da solicitação, como o valor do campo contents. O relatório de reconciliação precisa seguir a sintaxe descrita em Relatórios de reconciliação.

O exemplo a seguir valida um relatório para a conta 12345678:

POST https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports:validate

Enviando um relatório de conciliação

Depois de confirmar que um relatório de reconciliação é válido, você poderá fazer upload dele para o Google como neste exemplo:

POST https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports