Python のクイックスタート

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。

Google Workspace のクイックスタートでは、API クライアント ライブラリを使用して、認証と承認フローの詳細の一部を処理します。ご自身でアプリを開発する際には、このクライアント ライブラリを使用することをおすすめします。このクイックスタートでは、 テストに適したシンプルな認証アプローチ できます。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について学習することをおすすめします。

Google Chat API にリクエストを送信する Python コマンドライン アプリケーションを作成します。

目標

• 環境を設定する。
• クライアント ライブラリをインストールする。
• サンプルを設定します。
• サンプルを実行します。

前提条件

このクイックスタートを実行するには、次の前提条件を満たしている必要があります。

• Python 3.10.7 以降
• pip パッケージ管理ツール
• Google Cloud プロジェクト。

• Google Chat へのアクセス権を持つビジネスまたはエンタープライズの Google Workspace アカウント。

環境の設定

このクイックスタートを完了するには、環境を設定します。

API を有効にする

Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。 1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

• Google Cloud コンソールで、Google Chat API を有効にします。

  API の有効化

OAuth 同意画面を構成する

このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用する場合は、 OAuth 同意画面を開き、自分自身をテストユーザーとして追加します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。

1. Google Cloud コンソールで、メニュー menu に移動します。 > API とサービス > OAuth 同意画面。

   OAuth 同意画面に移動

2. [ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
3. アプリ登録フォームに入力し、[保存して続行] をクリックします。

4. 現時点では、スコープの追加をスキップして [保存して次へ] をクリックします。 今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更し、アプリに必要な認可スコープを追加する必要があります。

5. アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がなければ、[ダッシュボードに戻る] をクリックします。

デスクトップ アプリケーションの認証情報を承認する

エンドユーザーを認証してアプリでユーザーデータにアクセスするには、次のことを行う必要があります。 OAuth 2.0 クライアント ID を作成します。クライアント ID は Google の OAuth サーバーに送信します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。

1. Google Cloud コンソールで、メニュー menu > [API とサービス] > [認証情報] に移動します。

   [認証情報] に移動

2. [認証情報を作成] > [OAuth クライアント ID] をクリックします。
3. [アプリケーションの種類] > [デスクトップ アプリ] をクリックします。
4. [名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
5. [作成] をクリックします。OAuth クライアントの作成画面が表示され、新しいクライアント ID とクライアント シークレットが表示されます。
6. [OK] をクリックします。新しく作成された認証情報が [OAuth 2.0 クライアント ID] に表示されます。
7. ダウンロードした JSON ファイルを credentials.json として保存し、作業ディレクトリに移動します。

Google Chat アプリを構成する

Google Chat API を呼び出すには、 Google Chat アプリ。すべての書き込みリクエストに対して、Google Chat は UI に Google Chat アプリの属性が表示されます。 次の情報が含まれます。

1. Google Cloud コンソールで、Chat API の [構成] ページに移動します。

   [Chat API の構成] ページに移動

2. [アプリケーション情報] で、次の情報を入力します。

   1. [アプリ名] フィールドに「Chat API quickstart app」と入力します。
   2. [アバターの URL] フィールドに「https://developers.google.com/chat/images/quickstart-app-avatar.png」と入力します。
   3. [説明] フィールドに「Quickstart for calling the Chat API」と入力します。

3. [インタラクティブ機能] で、[インタラクティブ機能を有効にする] をクリックします。 インタラクティブ機能を無効にするには、 Chat アプリ。

4. [保存] をクリックします。

Google クライアント ライブラリをインストールする

• Python 用 Google クライアント ライブラリをインストールします。

  pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib
  

サンプルを構成する

1. 作業ディレクトリに quickstart.py という名前のファイルを作成します。

2. quickstart.py に次のコードを追加します。

   chat/quickstart/quickstart.py

   GitHub で表示
   from __future__ import print_function
   
   import os.path
   
   from google.auth.transport.requests import Request
   from google.oauth2.credentials import Credentials
   from google_auth_oauthlib.flow import InstalledAppFlow
   from google.apps import chat_v1 as google_chat
   
   
   # If modifying these scopes, delete the file token.json.
   SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']
   
   
   def main():
       """Shows basic usage of the Google Chat API.
       """
       creds = None
       # The file token.json stores the user's access and refresh tokens, and is
       # created automatically when the authorization flow completes for the first
       # time.
       if os.path.exists('token.json'):
           creds = Credentials.from_authorized_user_file('token.json', SCOPES)
       # If there are no (valid) credentials available, let the user log in.
       if not creds or not creds.valid:
           if creds and creds.expired and creds.refresh_token:
               creds.refresh(Request())
           else:
               flow = InstalledAppFlow.from_client_secrets_file(
                   'credentials.json', SCOPES)
               creds = flow.run_local_server(port=0)
           # Save the credentials for the next run
           with open('token.json', 'w') as token:
               token.write(creds.to_json())
   
       try:
           # Create a client
           client = google_chat.ChatServiceClient(
               credentials = creds,
               client_options = {
                   "scopes" : SCOPES
               }
           )
   
           # Initialize request argument(s)
           request = google_chat.ListSpacesRequest(
               # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
               filter = 'space_type = "SPACE"'
           )
   
           # Make the request
           page_result = client.list_spaces(request)
   
           # Handle the response. Iterating over page_result will yield results and
           # resolve additional pages automatically.
           for response in page_result:
               print(response)
       except Exception as error:
           # TODO(developer) - Handle errors from Chat API.
           print(f'An error occurred: {error}')
   
   
   if __name__ == '__main__':
       main()

サンプルの実行

1. 作業ディレクトリで、サンプルをビルドして実行します。

   python3 quickstart.py
   

2. サンプルを初めて実行すると、アクセスの承認を求められます。 <ph type="x-smartling-placeholder">
   </ph>
   1. Google アカウントにログインしていない場合は、プロンプトが表示されたらログインします。条件 複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択してください。
   2. [Accept] をクリックします。

   Python アプリケーションが実行され、Google Chat API が呼び出されます。

   認証情報はファイル システムに保存されるため、次回サンプルを実行する際に 承認を求められることはありません。

次のステップ

• クライアント ライブラリのドキュメント