Usage

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

Travel Partner API のエンドポイントは、HTTPS 呼び出しによる REST 構文を使用しています。すべての 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

料金マッチ率

価格マッチ ビュー サービスは、最新の価格保証レポートや価格保証の履歴全体を提供します。

最新の価格保証データを取得する

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

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

料金マッチの履歴を取得する

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

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

Price

料金表示サービスを使用すると、特定の宿泊施設の料金レポートを取得できます。

プロパティの料金データを取得する

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

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

調整レポート

調整レポート サービス

照合レポートのリストの取得

次の例では、アカウント 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