Usage

このページでは、Travel Partner API v3 を使用した呼び出しの例を紹介します。

Travel Partner API エンドポイントは、HTTPS 呼び出しで RESTful 構文を受け入れます。すべての API リクエストの base_url は次のとおりです。

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

リクエストとレスポンスのフィールドの完全なリストについては、API リソース カタログをご覧ください。

宿泊施設のパフォーマンス レポート

プロパティ パフォーマンス レポート ビュー サービスを使用すると、特定のアカウントのプロパティ パフォーマンス レポートをクエリ(取得、フィルタ、セグメント化)できます。

プロパティのパフォーマンス レポートをクエリする

次の例では、アカウント 12345678 のすべてのプロパティのプロパティ パフォーマンス レポートを取得し、2022 年 5 月 11 日のデータでフィルタして、パートナー ホテル ID でグループ化しています。

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

ホテル

ホテルビュー サービスは、特定のアカウントのすべてのホテルのリストまたは概要を提供します。

ホテルのリストを取得する

次の例では、アカウント 12345678 内のすべてのホテルのリストを取得します。

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

リクエストでは、複数ページの結果をナビゲートするためのクエリ パラメータを受け入れます。

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

プロパティの概要を取得する

この例では、アカウント 12345678 のプロパティの概要を取得します。

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

オークション レポート

参加レポート ビュー サービスを使用すると、特定のアカウントの参加レポートをクエリ(取得、フィルタ、セグメント化)できます。

オークション レポートのクエリ

次の例では、アカウント 12345678 のすべてのプロパティの参加レポートを取得し、2020 年 10 月 4 日の日付を使用してレポートをフィルタします。

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

料金の精度

料金精度ビュー サービスを使用すると、特定のアカウントの料金精度レポートとスコアカードを取得できます。

料金精度レポートを取得する

次の例では、アカウント 12345678 の 2019 年 8 月 26 日の料金の精度レポートを取得します。

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

レスポンスのページングに使用する通常のクエリ パラメータの他に、一致した価格やピクセル シグナルを結果に含めるためのパラメータがいくつかあります。

この例では、2019 年 8 月 26 日の料金の精度レポートに、一致した価格とピクセル シグナルが含まれています。

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

利用可能な料金精度レポートの一覧表示

利用可能なレポートのリストを取得するには、次のリクエストを送信します。

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

結果をページングするための通常のクエリ パラメータを含めることができます。

料金精度スコアを取得する

料金精度スコアカードを取得するには、summarize メソッドを使用します。

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

料金一致率

Price Coverage Views Service は、最新の料金一致率レポートまたは料金一致率の履歴全体を提供します。

最新の料金の一致率の統計情報を取得する

次の例では、アカウント 12345678 の最新の価格カバレッジ統計情報を取得します。

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

料金の一致率の履歴を取得する

このリクエストは、アカウントの価格保証履歴全体を取得します。

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

価格

Price Views Service を使用すると、特定のプロパティの価格レポートを取得できます。

物件の価格データを取得する

アカウント 12345678 に属する特定のホテル(ID=101)の料金レポートを取得するには、次のリクエストを発行します。

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

調整レポート

Reconciliation Reports Service を使用すると、レポートのリストを取得し、特定のレポートをダウンロードして検証してから、レポートを Google にアップロードできます。

照合レポートのリストを取得する

次の例では、アカウント 12345678 のレポートのリストを取得します。

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

必要に応じて、開始日と終了日のクエリ パラメータを指定して、結果を制限できます。たとえば、次のクエリでは、レポートを 2019 年 6 月 15 日から 2019 年 9 月 15 日までの期間に限定します。

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

照合レポートをダウンロードする

この例では、2019-08-26T12:00:00 にアップロードされた booking_report.csv レポート(JSON レスポンスとして)を取得します。

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

調整レポートを検証する

このメソッドを使用すると、レポートをアップロードする前に検証できます。レポートを検証しても、レポートがアップロードされることはありません。

調整レポートは、リクエストの本文で contents フィールドの値として含まれます。調整レポートは、調整レポートで説明されている構文に従っている必要があります。

次の例では、アカウント 12345678 のレポートを検証します。

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

照合レポートをアップロードする

照合レポートが有効であることを確認したら、次の例のように Google にアップロードできます。

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