このガイドでは、Google Chat API の Space
リソースの patch()
メソッドを使用して、スペースを更新する方法について説明します。スペースを更新して、ユーザーに表示される表示名、説明、ガイドラインなどのスペースの属性を変更します。
Google Workspace 管理者は、patch()
メソッドを呼び出して、Google Workspace 組織内の既存のスペースを更新できます。
Space
リソースは、ユーザーや Chat アプリがメッセージを送信したり、ファイルを共有したり、コラボレーションしたりできる場所を表します。スペースには次の 2 種類があります。
- ダイレクト メッセージ(DM)は、2 人のユーザー、またはユーザーと Chat アプリ間の会話です。
- グループ チャットとは、3 人以上のユーザーと Chat アプリの間で行われる会話です。
- 名前付きスペースは、メッセージの送信、ファイルの共有、コラボレーションを行う永続的な場所です。
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- デスクトップ アプリケーションの
OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。
- ユーザー認証をサポートする 承認スコープを選択します。
- Google Chat スペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Python
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Python の Cloud クライアント ライブラリをインストールします。
- デスクトップ アプリケーション用の
OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。
- ユーザー認証をサポートする 認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Java Cloud クライアント ライブラリをインストールします。
- デスクトップ アプリケーションの
OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。
- ユーザー認証をサポートする 認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Apps Script
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- スタンドアロンの Apps Script プロジェクトを作成し、Advanced Chat Service をオンにします。
- ユーザー認証をサポートする 認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
ユーザーとしてスペースを更新する
ユーザー認証を使用して Google Chat の既存のスペースを更新するには、リクエストで次の情報を渡します。
chat.spaces
認可スコープを指定します。UpdateSpace()
メソッドを呼び出します。リクエストで、スペースのname
フィールド、更新する 1 つ以上のフィールドを含むupdateMask
フィールド、更新されたスペース情報を含むbody
を指定します。
表示名、スペースの種類、履歴の状態などを更新できます。更新可能なすべてのフィールドについては、リファレンス ドキュメントをご覧ください。
既存のスペースの displayName
フィールドを更新する方法は次のとおりです。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、SPACE_NAME
をスペースの name
フィールドの ID に置き換えます。ID を取得するには、ListSpaces()
メソッドを呼び出すか、スペースの URL を使用します。
Google Chat API は、更新を反映した Space
のインスタンスを返します。
Google Workspace 管理者としてスペースを更新する
Google Workspace 管理者は、UpdateSpace()
メソッドを呼び出して、Google Workspace 組織内のスペースを更新できます。
Google Workspace 管理者としてこのメソッドを呼び出す手順は次のとおりです。
- ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドの呼び出しをサポートする認可スコープを指定します。
- リクエストでは、クエリ パラメータ
useAdminAccess
をtrue
に指定します。
詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。
スペースを Chat アプリとして更新する
アプリの認証には、1 回限りの管理者の承認が必要です。
アプリの認証を使用して Google Chat の既存のスペースを更新するには、リクエストで次のものを渡します。
chat.app.spaces
承認スコープを指定します。アプリ認証では、Chat アプリによって作成されたスペースのみを更新できます。Space
リソースでpatch
メソッドを呼び出します。リクエストで、スペースのname
フィールド、更新する 1 つ以上のフィールドを含むupdateMask
フィールド、更新されたスペース情報を含むbody
を指定します。
表示名、スペースの種類、履歴の状態、権限の設定などを更新できます。更新可能なすべてのフィールドについては、リファレンス ドキュメントをご覧ください。
API キーを作成する
Developer Preview API メソッドを呼び出すには、API ディスカバリ ドキュメントの非公開のデベロッパー プレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。
API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。
- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [API キー] をクリックします。
- 新しい API キーが表示されます。
- [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳しくは、API キーの制限を適用するをご覧ください。
Chat API を呼び出すスクリプトを記述する
既存のスペースの spaceDetails
フィールドを更新する方法は次のとおりです。
Python
- 作業ディレクトリに
chat_space_update_app.py
という名前のファイルを作成します。 chat_space_update_app.py
に次のコードを追加します。from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
コードで、次のように置き換えます。
API_KEY
: Chat API のサービス エンドポイントを構築するために作成した API キー。SPACE
はスペース名に置き換えます。スペース名は、Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
python3 chat_space_update_app.py
Google Chat API は、更新を反映した Space
リソースのインスタンスを返します。