このページは Cloud Translation API によって翻訳されました。

API の承認

このドキュメントでは、Travel Partner API や Price Feeds API などのホテル API にアクセスする際に、アプリケーションで OAuth2.0 を設定する手順について説明します。アプリケーションを承認するには、OAuth 2.0 を使用した Google API へのアクセスをご覧ください。

OAuth 2.0 のセットアップ

OAuth 2.0 では、Google アカウントに関連付けられたサービスアカウントを使用して本人確認を行う必要があります。サービスアカウントは、OAuth 2.0 アクセストークンと引き換えに秘密鍵を送信します。その後、このトークンをホテル API の呼び出しで使用して、ホテル料金フィードに関する料金、ホテル、診断レポートデータなどの読み取り専用データを取得できます。

アクセストークンの有効期間は 1 時間（3,600 秒）です。

以前に ClientLogin を実装していた場合、OAuth 2.0 のアプローチは類似していますが、次の点が異なります。

アプリケーションが Google サービスアカウントを使用して API にアクセスしている。
API を呼び出すときに、Authorization HTTP ヘッダーで OAuth 2.0 アクセストークンを渡します。

Hotels API で OAuth 2.0 を使用するようにアカウントを設定するには、次の手順を行います。

Google Cloud コンソールで新しいプロジェクトを作成する
サービスアカウントと認証情報を作成する
サービスアカウントにホテルデータへのアクセス権を付与する

それぞれの手順は、次のセクションで説明します。

ステップ 1: Google Cloud コンソールで新しいプロジェクトを作成する

Google Cloud コンソールを使用すると、プロジェクトで使用する Google API のトラフィックデータ、認証情報、請求情報を管理および表示できます。

Google Cloud コンソールで、プロジェクトは、Google Developer API と Google Cloud リソースを使用するアプリケーションに関する設定、認証情報、メタデータのコレクションです。

Google Cloud コンソールでは、API 認証情報の生成、API の有効化、プロジェクトに関連付けられたチームと請求情報の管理にも使用できます。

Google Cloud コンソールで新しいプロジェクトを作成するには:

Gmail または Google アカウントにログインします。
Google Cloud コンソールを開きます。初めてのプロジェクトの場合は、メインビューに [プロジェクトを作成] ボタンが表示されます。
[プロジェクトの作成] ボタンをクリックします。Google Cloud コンソールに [新しいプロジェクト] ダイアログが表示されます。

[プロジェクト名] 入力フィールドに、新しいプロジェクトのわかりやすい名前を入力します。Google Cloud コンソールでは、このフィールドの下にプロジェクト ID が生成されます。この ID は、すべてのプロジェクトで一意になります。たとえば、「My New Project」と入力すると、Google Cloud コンソールによって my-new-project-266022 などの ID が割り当てられます。
[作成] ボタンをクリックして、新しいプロジェクトを作成します。
ナビゲーションメニューで、[API とサービス] > [ダッシュボード] を選択します。

次の図は、Google Cloud コンソールの左上にあるナビゲーションメニューを示しています。プロジェクトの [ダッシュボード] ビューが表示されます。

詳細については、プロジェクトの作成と管理をご覧ください。

ステップ 2: サービスアカウントを作成し、認証情報を生成する

サービスアカウントは、ウェブアプリケーションとホテルデータ間のサーバー間通信で使用されます。

サービスアカウントを作成して構成するには、次の手順を行います。

Google API Console のメインビューで、左側のナビゲーションで [認証情報] をクリックします。Google Cloud コンソールに [認証情報] ビューが表示されます。

[認証情報] ビューには、プロジェクトのクライアント ID と認証情報が表示されます。アプリケーションは、OAuth 2.0 アクセストークンをリクエストするときにクライアント ID を使用します。新しいプロジェクトには、まだクライアントや認証情報がありません。
[API とサービスの認証情報] リンクをクリックします。
[認証情報を作成] ボタンをクリックし、フィルタから [サービスアカウントキー] を選択します。[サービスアカウントキーの作成] ビューが表示されます。
[サービスアカウント] フィルタから [新しいサービスアカウント] を選択します。
サービスアカウント名とサービスアカウント ID を入力します。

名前は任意ですが、アカウント ID はすべてのプロジェクトで一意である必要があります。Google Cloud コンソールでは、入力した名前に基づいて一意のアカウント ID が生成されます。
キーのタイプとして [JSON] を選択します。JSON は必須です。
[Create] ボタンをクリックします。Google Cloud コンソールで、プロジェクトの秘密鍵または公開鍵ペアが生成されます。秘密鍵は、ブラウザがダウンロードを保存するデフォルトの場所に保存されます。.JSON 形式のファイルをダウンロードする必要があります。

秘密鍵は、API にアクセスするスクリプトやその他のアプリケーションで使用します。

注意: 秘密鍵ファイルには、トークンを取得するためにクライアントがアクセスする必要がある機密データが含まれているため、安全な場所に保存する必要があります。
キーの生成が完了すると、Google Cloud コンソールに「サービスアカウントが作成されました」というメッセージが表示されます。

主なポイント: サーバーごとにサービスアカウントは必要ありません。サービスアカウントは 1 つだけ必要です。ただし、サーバー間の負荷を軽減する場合は、複数のサービスアカウントを作成できます。
[OK] ボタンをクリックします。Google Cloud コンソールが [認証情報] ビューに戻ります。サービスアカウントの詳細を確認して、プロジェクトに関連付けられているサービスアカウントを表示するには、このビューで [サービスアカウントの管理] をクリックします。

サービスアカウントには、次の認証情報が関連付けられます。
- クライアント ID: アプリケーションが OAuth 2.0 アクセストークンをリクエストするときに使用する一意の識別子。
- メールアドレス: サービスアカウントの生成されたメールアドレス。形式は「account_name@project_name.google.com.iam.gserviceaccount.com」です。
- 証明書のフィンガープリント: ダウンロードした秘密鍵の ID。

詳細については、サーバー間アプリケーションに OAuth 2.0 を使用するをご覧ください。

ステップ 3: サービスアカウントに Hotel Center データへのアクセス権を付与する

最後のステップとして、新しいサービスアカウントに Hotel Center へのアクセス権を付与します。サービスアカウントは、前の手順で作成した生成されたメールアドレスで識別されます。このアカウントへのアクセス権は、Hotel Center の共有設定を使用して付与します。

アカウントにユーザーを追加する適切なアクセス権がない場合は、お問い合わせフォームを使用して Google ホテルチームに連絡し、アカウントの所有権の設定をリクエストしてください。1 人以上のオーナーにメールを送信するようリクエストできます。Hotel Center へのアクセスについて詳しくは、Hotel Center と Google 広告をリンクするをご覧ください。

サービスアカウントに Hotel Center データへのアクセス権を付与するには:

新しいブラウザウィンドウでホテルセンターを開きます。
[Hotel Center by Google] バナーで、ユーザーの追加アイコンをクリックして共有ダイアログを開きます。
[ユーザーを追加] フィールドに、Hotel Center に追加するサービスアカウントのメールアドレスを入力します。
[通知を送信する] オプションを選択したままにします。
フィルタから [管理] を選択します。
[招待] ボタンをクリックします。
Hotel Center にユーザーを追加すると、サービスアカウントが API アクセス用に有効になり、約 24 時間以内に有効になります。

サービスアカウントで API アクセスが有効になったことを Google から通知されたら、OAuth 2.0 を使用して API へのアクセスを開始できます。

OAuth 2.0 の使用方法

API にアクセスするには、サービスアカウントで生成されたメールアドレスと秘密鍵を使用して、アプリケーションが Google に対して自身を識別する必要があります。Google の認証メカニズムはこの鍵を OAuth 2.0 アクセストークンと交換します。このトークンは、アプリの API 呼び出しの Authorization ヘッダーで渡します。

委任された API 呼び出しを行う準備をご覧ください。

スコープ

Hotels API の SCOPES は次のとおりです。

Travel Partner API: "https://www.googleapis.com/auth/travelpartner"

Price Feeds API: "https://www.googleapis.com/auth/travel-partner-price-upload"

認証情報を作成するときに、サービスアカウントを指定する必要があります。サービスアカウントを作成し、認証情報を生成するをご覧ください。

アプリケーションを開発する際は、API キーを使用してアプリケーションを認証するためのベストプラクティスに従ってください。詳細

例

from google.oauth2 import service_account
from google.auth.transport.requests import Request

# You can use a single or multiple scopes
SCOPES =
['https://www.googleapis.com/auth/travel-partner-price-upload','https://www.googleapis.com/auth/travelpartner']
SERVICE_ACCOUNT_FILE = 'service_account_key_file.json'

cred = service_account.Credentials.from_service_account_file(
                        SERVICE_ACCOUNT_FILE,
                        scopes=SCOPES)
cred.refresh(Request())
headers = {}
cred.apply(headers)

Travel Partner API

Travel Partner API を使用すると、宿泊施設パートナーは、大規模または複雑なアカウントを管理するために、Hotel Center の情報を取得したり、Hotel Center のデータを変更したりできます。

OAUTH 2.0 の設定の手順に沿って、Travel Partner API の認可を取得します。

Travel Partners API 用に新しいプロジェクトを作成する場合は、新しい Google Cloud コンソールプロジェクトへのアクセスを有効にする必要があります。

次の手順に沿って、Travel Partners API へのアクセスを有効にします。

プロジェクトのダッシュボードビューに移動します。
[API とサービスを有効化] をクリックします。API ライブラリのウェルカムページが表示されます。
検索フィールドに「Travel Partner API」と入力すると、入力内容に一致する API のリストがコンソールに表示されます。
表で一致する API をクリックします。Google Cloud コンソールに、その API の説明が表示されます。
[API を有効にする] ボタンをクリックして、プロジェクトでこの API を有効にします。

詳細については、サービスの有効化と無効化をご覧ください。

Google アカウントの新しいプロジェクトで Travel Partner API が有効になりました。

Travel Partner API のスコープは次のとおりです。 "https://www.googleapis.com/auth/travelpartner"

Travel Partner API のエンドポイントは次のとおりです。 "https://travelpartner.googleapis.com/v3/accounts/<account_id>/<path>"

Price Feeds API

Price Feeds API を使用すると、宿泊施設のパートナーはすべてのホテルにカスタマイズされた料金データを提供できます。Google の宿泊施設パートナーは、Google に料金をアップロードする際に OAuth2.0 を使用して自身を認証し、承認できます。OAUTH 2.0 の設定手順に沿って、Price Feeds API の承認を取得します。

注意点

Price Feeds API の認可手順には重要な違いがあります。

パートナーは、OAuth 2.0 の設定に記載されている手順と同じ手順で、Google Cloud コンソールで新しい料金フィード OAuth2.0 プロジェクトを作成する必要があります。
Google Cloud コンソールで Price Feeds API を有効にすることはNOT。無視してもかまいません。必要なサービスアカウントとキーは 1 つだけです。同じサービスアカウントとキーを使用して、料金フィードプロジェクトに Hotel Center データへのアクセス権を付与します。OAuth2.0 の設定で説明されている残りの手順に沿って、API の構成を完了します。

料金フィードの OAuth2.0 アクセストークンを取得する

次のステップでは、サービスアカウントキーファイルを使用して、宿泊料金アップロードスコープの OAuth2.0 アクセストークンを取得します。委任された API 呼び出しを行う準備の手順に沿って、料金フィードプロジェクトへのリクエストを承認し、取得した認証情報からアクセストークンを抽出して "Authorization" HTTP ヘッダーに設定します。

宿泊料金のアップロードの対象は次のとおりです。 "https://www.googleapis.com/auth/travel-partner-price-upload"

料金をアップロードする

アクセストークンを取得した後、パートナーは、認証と承認に静的 IP を使用する場合と同様に、次の変更を加えて料金フィードをアップロードできます。

"Authorization" HTTP ヘッダーにアクセストークンを設定する

curl -X POST -H "Authorization: Bearer <access token>"
www.google.com/travel/lodging/uploads/accounts/<account_id>/ota/hotel_rate_amount_notif --data-binary @<price_feed_file_location>

Price Feeds API の OAuth2.0 設定をテストする

OAuth2.0 の設定をテストするには、空のファイルまたは実際の料金データをいずれかのアップロードパスにアップロードします。次の表を使用して、HTTP レスポンスのステータスを確認します。

HTTP レスポンスステータス	メッセージ
200	Successful (OK)
401	Service account creation or access token fetch was not successful
403	Service account access wasn't granted to the Hotel Center account or both the service account key and access token has expired

トラブルシューティング

問題が発生した場合は、次の項目を簡単に確認することで、問題が解決することがあります。

Google Cloud コンソールでプロジェクトを作成しましたか？
プロジェクトでサービスを有効にしましたか？
[クライアント ID を作成] をクリックして [サービスアカウント] を選択した後、.JSON ファイル（秘密鍵）をダウンロードしましたか？
nnnnnnn@app_name.google.com.iam.gserviceaccount.com という形式のサービスアカウントクライアント ID のメールアドレスを取得しましたか？
[このアカウントを共有] ボタンをクリックして、Hotel Ads Center アカウントをサービスアカウントと共有しましたか？
サービスアカウントのメールアドレスとパートナー ID をテクニカルアカウントマネージャー（TAM）に送信しましたか？
API 呼び出しで、最近取得したトークンが Authorization ヘッダーで渡されていますか？
トークンが 1 時間以上経過していますか？

次の表に、一般的なエラーとその解決策を示します。

エラー	説明
Invalid credentials	このメッセージが表示される原因はいくつか考えられます。このエラーが発生した場合は、次の点を確認してください。有効な署名なしトークンを含む `Authorization` ヘッダーを指定しました。ベアラトークンが 1 時間以内である。トークンは 1 時間のみ有効です。正しいパートナー名が指定されています（`partner` クエリ文字列パラメータを使用）。この値は、Hotel Ads Center に表示されるパートナー名ではなく、一意のパートナー ID です。パートナー ID がわからない場合は、テクニカルアカウントマネージャー（TAM）にお問い合わせください。
Not found	エンドポイントの形式が正しくありません。`GET` リクエストを送信していること、リクエスト URL が有効であること（アクセスしようとしている API 構文に準拠していること）を確認します。
Invalid string value	エンドポイントの 1 つ以上の部分に無効な構文が含まれています。たとえば、パスの一部にスペルミスがある可能性があります。パス全体で、アンダースコア、大文字、単語が正しく使用されていることを確認します。
Unsupported output format	このエラーは、Reports API を使用している場合によく発生します。`GET` リクエストの URL に `"alt=csv"` を指定する必要があります。Reports API は JSON をサポートしていません。
AccessTokenRefreshError/Invalid grant	アプリの実行時にこのエラーが発生する原因として、次のことが考えられます。サービスアカウントのメールアドレスが正しくありません。Google Cloud コンソールでメールアカウントを確認し、API へのアクセスが承認されていることを確認します。メールアドレスに API アクセス権がありません。Hotel Center で共有されているホテルデータにアクセスする権限がメールアドレスに付与されているかどうかを確認します。キーファイルがサービスアカウントの正しいキーファイルではありません。Google Cloud コンソールを使用して新しい `.JSON` 証明書をダウンロードし、アプリが正しい証明書を参照していることを確認します。
HotelAdsAPIConnection object has no attribute credentials	アプリの実行時に、`.JSON` ファイルのパスが正しくない。
Invalid scope	アプリを実行する際の API スコープは、次のいずれかである必要があります。 "https://www.googleapis.com/auth/travelpartner" "https://www.googleapis.com/auth/travel-partner-price-upload"
Forbidden	使用しているアカウント ID にアクセスする権限がない。サブアカウントの所有者は、親アカウントまたはルートアカウント ID にアクセスできない場合があります。