Google Vault API にリクエストを行う Python コマンドライン アプリケーションを作成します。
クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。このクイックスタートでは、テスト環境に適した簡略化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について学習することをおすすめします。
このクイックスタートでは、Google Workspace の推奨 API クライアント ライブラリを使用して、認証および承認フローの詳細の一部を処理します。
目標
- 環境をセットアップする。
- クライアント ライブラリをインストールする。
- サンプルを設定します。
- サンプルを実行します。
前提条件
このクイックスタートを実行するには、次の前提条件を満たしている必要があります。
- Python 3.10.7 以降
- pip パッケージ管理ツール
- Google Cloud プロジェクト。
- Google アカウント。
環境の設定
このクイックスタートを完了するには、環境を設定します。
API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Vault API を有効にします。
OAuth 同意画面を構成する
このクイックスタートを新しい Google Cloud プロジェクトを使用して完了する場合は、OAuth 同意画面を構成します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進んでください。
- Google Cloud コンソールで、メニュー > > [ブランディング] に移動します。
- をすでに構成している場合は、[ブランディング]、[ユーザー]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[ まだ設定されていません] というメッセージが表示された場合は、[使ってみる] をクリックします。
- [アプリ情報] の [アプリ名] に、アプリの名前を入力します。
- [ユーザー サポートメール] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
- [続行] をクリックします。
- [対象] で [内部] を選択します。
- [続行] をクリックします。
- [連絡先情報] で、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
- [続行] をクリックします。
- [完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
- [続行] をクリックします。
- [作成] をクリックします。
- 現時点では、スコープの追加はスキップできます。今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、OAuth 同意画面を構成するの完全なガイドをご覧ください。
デスクトップ アプリケーションの認証情報を承認する
エンドユーザーを認証してアプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google Cloud コンソールで、メニュー > > [クライアント] に移動します。
- [Create Client] をクリックします。
- [アプリケーション タイプ] > [デスクトップ アプリ] をクリックします。
- [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
- [Create] をクリックします。
新しく作成した認証情報は、[OAuth 2.0 クライアント ID] に表示されます。
- ダウンロードした JSON ファイルを
credentials.json
として保存し、作業ディレクトリに移動します。
Google クライアント ライブラリをインストールする
Python 用 Google クライアント ライブラリをインストールします。
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
サンプルを構成する
- 作業ディレクトリに
quickstart.py
という名前のファイルを作成します。 quickstart.py
に次のコードを含めます。
サンプルの実行
作業ディレクトリで、サンプルをビルドして実行します。
python3 quickstart.py
-
サンプルを初めて実行すると、アクセス権限の承認を求めるメッセージが表示されます。
- Google アカウントにまだログインしていない場合は、プロンプトが表示されたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
- [Accept] をクリックします。
Python アプリケーションが実行され、Google Vault API が呼び出されます。
認可情報はファイル システムに保存されるため、次回サンプルコードを実行するときに認可を求められることはありません。
次のステップ
- 認証と認可に関する問題のトラブルシューティング
- Vault API リファレンス ドキュメント
- Python 用 Google API クライアントのドキュメント
- Google Vault API PyDoc ドキュメント