クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。
Google Workspace のクイックスタートでは、API クライアント ライブラリを使用して認証と認可のフローの詳細を処理します。独自のアプリにはクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡素化された認証アプローチを使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について学習することをおすすめします。
Google Docs API にリクエストを行う Python コマンドライン アプリケーションを作成する。
目標
- 環境を設定する。
- クライアント ライブラリをインストールする。
- サンプルを設定します。
- サンプルを実行します。
前提条件
このクイックスタートを実行するには、次の前提条件を満たす必要があります。
- Python 3.10.7 以降
- pip パッケージ管理ツール
- Google Cloud プロジェクト。
- Google アカウント
環境を設定する
このクイックスタートを完了するには、環境を設定します。
API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Docs API を有効にします。
OAuth 同意画面を構成する
新しい Google Cloud プロジェクトを使用してこのクイックスタートを実施する場合は、OAuth 同意画面を構成し、自分自身をテストユーザーとして追加します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。
- Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
- アプリ登録フォームに入力し、[保存して次へ] をクリックします。
現時点では、スコープの追加をスキップして、[保存して次へ] をクリックします。今後、Google Workspace 組織の外部で使用するアプリを作成する場合は、[ユーザーの種類] を [外部] に変更してから、アプリに必要な認証スコープを追加する必要があります。
- アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がない場合は、[Back to Dashboard] をクリックします。
デスクトップ アプリケーションの認証情報を承認する
エンドユーザーを認証してアプリ内でユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [OAuth クライアント ID] をクリックします。
- [アプリケーションの種類] > [デスクトップ アプリ] をクリックします。
- [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
- [作成] をクリックします。OAuth クライアントの作成画面が表示され、新しいクライアント ID とクライアント シークレットが表示されます。
- [OK] をクリックします。新しく作成された認証情報が [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 Docs API を呼び出します。
認可情報はファイル システムに保存されるため、次回サンプルコードを実行するときに認可を求められることはありません。
次のステップ
- 認証と認可に関する問題のトラブルシューティング
- Docs API リファレンス ドキュメント
- Python 用 Google API クライアントのドキュメント
- Google Docs API の PyDoc ドキュメント