Python クイックスタート

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

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。このクイックスタートでは、テスト環境に適した簡素化された認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と認可について学習することをおすすめします。

このクイックスタートでは、Google Workspace が推奨する API クライアントライブラリを使用して、認証と認可フローの詳細を処理します。

目標

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

前提条件

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

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

Google Workspace にアクセスできる Business または Enterprise のアカウントと、Google Chat にアクセスできるアカウント。

環境をセットアップする

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

API を有効にする

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

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

API を有効にする

OAuth 同意画面を構成する

このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用する場合は、OAuth 同意画面を構成します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進んでください。

Google API Console で、メニューアイコン menu > [Google Auth Platform] > [ブランディング] に移動します。
[ブランディング] に移動
Google Auth Platform をすでに構成している場合は、[ブランディング]、[対象]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[**Google Auth Platform はまだ構成されていません**] というメッセージが表示されたら、[**スタートガイド**] をクリックします。

[アプリ情報] の [アプリ名] に、アプリの名前を入力します。
[**ユーザーサポートメール**] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
[続行] をクリックします。
[対象] で [内部] を選択します。
[続行] をクリックします。
[連絡先情報] で、プロジェクトに対する変更の通知を受け取る [メールアドレス] を入力します。
[続行] をクリックします。
[完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
[続行] をクリックします。
[作成] をクリックします。

現時点では、スコープの追加はスキップできます。今後、 Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、 OAuth 同意画面を構成するをご覧ください。

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

エンドユーザーを認証してアプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。

Google API Console で、メニューアイコン Menu > [Google Auth Platform] > [クライアント] に移動します。
[クライアント] に移動
[クライアントの作成] をクリックします。
[アプリケーションタイプ] [>] [デスクトップアプリ] をクリックします。
[名前] フィールドに、認証情報の名前を入力します。この名前は Google API Console にのみ表示されます。
[作成] をクリックします。
新しく作成した認証情報が [OAuth 2.0 クライアント ID] に表示されます。
ダウンロードした JSON ファイルを credentials.json として保存し、ファイルを作業ディレクトリに移動します。

Google Chat アプリを構成する

Google Chat API を呼び出すには、Google Chat アプリを構成する必要があります。書き込みリクエストの場合、Google Chat は次の情報を使用して、UI で Google Chat アプリを属性付けします。

Google API Console で、Chat API の [構成] ページに移動します。

Chat API の [構成] ページに移動
[アプリケーション情報] に次の情報を入力します。
1. [アプリ名] フィールドに「Chat API quickstart app」と入力します。
2. [アバター URL] フィールドに「https://developers.google.com/chat/images/quickstart-app-avatar.png」と入力します。
3. [説明] フィールドに「Quickstart for calling the Chat API」と入力します。
[インタラクティブ機能] で、[インタラクティブ機能を有効にする] 切り替えボタンをクリックしてオフの位置に切り替え、 Chat アプリのインタラクティブ機能を無効にします。
[保存] をクリックします。

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

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

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

サンプルを構成する

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

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()

サンプルを実行する

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

サンプルを初めて実行すると、アクセス権の承認を求めるメッセージが表示されます。
1. Google アカウントにまだログインしていない場合は、ログインを求められたらログインします。複数のアカウントにログインしている場合は、認可に使用するアカウントを 1 つ選択します。
2. [Accept] をクリックします。
Python アプリケーションが実行され、Google Chat API が呼び出されます。

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

次のステップ

API エクスプローラで Google Workspace API を試す

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

Python クイックスタート コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

目標