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

Python のクイックスタート

クイックスタートでは、 Google Workspace API

Google Workspace クイックスタートでは、API クライアントライブラリを使用して認証と認可のフローの詳細を確認できます。おすすめの方法独自のアプリ用のクライアントライブラリを使用します。このクイックスタートでは、テストに適したシンプルな認証アプローチできます。本番環境では、Terraform の IAM 構成の認証と認可次の日付より前アクセス認証情報の選択選択することもできます

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

目標

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

前提条件

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

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

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

環境の設定

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

API を有効にする

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

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

API の有効化

OAuth 同意画面を構成する

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

Google Cloud コンソールで、メニューに移動します。 > API とサービス > OAuth 同意画面。
OAuth 同意画面に移動
[ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
アプリ登録フォームに入力し、[保存して次へ] をクリックします。
現時点では、スコープの追加をスキップして [保存して次へ] をクリックします。今後、Google Play 以外で使用するアプリを作成した場合、 [ユーザーの種類] を [外部] に変更してから、アプリに必要な認証スコープを追加します。
アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリが問題がなければ、[ダッシュボードに戻る] をクリックします。

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

エンドユーザーを認証してアプリでユーザーデータにアクセスするには、次のことを行う必要があります。 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 Chat アプリを構成する

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

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

[Chat API の構成] ページに移動
[Application info] で、次の情報を入力します。
1. [App name] フィールドに「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 クライアントライブラリをインストールします。
```
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 が呼び出されます。

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

次のステップ

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