このガイドでは、Google Chat API の Membership
リソースの update()
メソッドを使用して、メンバーシップに関する属性を変更する方法について説明します。たとえば、スペース メンバーをスペース管理者に変更したり、スペース管理者をスペース メンバーに変更したりします。
Google Workspace 管理者は、update()
メソッドを呼び出して、Google Workspace 組織内のスペースのメンバーシップを更新できます。
Membership
リソースは、人間のユーザーまたは Google Chat アプリがスペースに招待されているか、スペースの一部であるか、スペースから離脱したかを表します。
前提条件
Node.js
- Google Chat にアクセスできる Business または Enterprise の Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
メンバーシップを更新する
スペースのメンバーシップを更新するには、リクエストに次の内容を渡します。
- 認可スコープを指定します。
- ユーザー認証で、
chat.memberships
認可スコープを指定します。 - アプリ認証(デベロッパー プレビューで利用可能)では、
chat.app.memberships
承認スコープを指定します。アプリ認証でメンバーシップを更新する場合、更新できるのは Chat アプリによって作成されたスペースのメンバーシップのみです。アプリの認証には、1 回限りの管理者の承認が必要です。
- ユーザー認証で、
UpdateMembership()
メソッドを呼び出します。- 次のように、
membership
をMembership
のインスタンスとして渡します。- 更新するメンバーシップに設定された
name
フィールド(スペース ID とメンバー ID を含む)。 - 更新するメンバーシップ フィールドが新しい値に設定されている。
- 更新するメンバーシップに設定された
updateMask
を渡して、更新するメンバーシップの要素を指定します。これには次のものが含まれます。role
: Chat スペース内のユーザーのロール。これにより、スペースで許可されるアクションが決まります。有効な値は次のとおりです。ROLE_MEMBER
: スペースのメンバー。ユーザーには、スペースへのメッセージの送信などの基本的な権限が付与されます。1 対 1 の会話と名前のないグループの会話では、全員がこのロールを持ちます。ROLE_MANAGER
: スペースの管理者。ユーザーには、すべての基本権限に加えて、メンバーの追加や削除など、スペースを管理するための管理権限が付与されます。spaceType
がSPACE
であるスペース(名前付きスペース)でのみサポートされます。
スペースの通常のメンバーをユーザーとしてスペースの管理者にする
次の例では、ユーザー認証を使用して Chat API を呼び出し、role
を ROLE_MANAGER
として指定して、通常のスペース メンバーをスペース マネージャーにします。
Node.js
サンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MEMBER_NAME
: メンバーシップのname
の ID。ID は、ListMemberships()
メソッドを呼び出すか、Chat API で非同期的にメンバーシップを作成した後に返されるレスポンスの本文から取得できます。ROLE_NAME
: 更新されたロールROLE_MANAGER
。
Google Chat API は、指定されたメンバーシップをスペース管理者に更新し、Membership
のインスタンスを返します。
スペース管理者をユーザーとして通常のメンバーにする
次の例では、ユーザー認証を使用して Chat API を呼び出し、role
を ROLE_MEMBER
として指定して、スペースの管理者を通常のスペース メンバーにします。
Node.js
サンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MEMBER_NAME
: メンバーシップのname
の ID。ID は、ListMemberships()
メソッドを呼び出すか、Chat API で非同期的にメンバーシップを作成した後に返されるレスポンスの本文から取得できます。ROLE_NAME
: 更新されたロールROLE_MEMBER
。
Google Chat API は、指定されたメンバーシップをスペース管理者に更新し、Membership
のインスタンスを返します。
Chat アプリとして通常のスペース メンバーをスペース管理者に設定する
アプリの認証には、1 回限りの管理者の承認が必要です。
API キーを作成する
デベロッパー プレビュー版 API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。
API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。
- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [API キー] をクリックします。
- 新しい API キーが表示されます。
- [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳細については、API キーの制限を適用するをご覧ください。
Chat API を呼び出すスクリプトを作成する
次の例では、アプリ認証を使用して Chat API を呼び出し、更新されたメンバーシップ属性を指定する body
で role
を ROLE_MANAGER
として指定することで、通常のスペース メンバーをスペース管理者にします。
Python
- 作業ディレクトリに
chat_membership_update_to_manager_app.py
という名前のファイルを作成します。 chat_membership_update_to_manager_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.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
コードで、次のように置き換えます。
API_KEY
: Chat API のサービス エンドポイントを構築するために作成した API キー。SPACE
: スペース名。Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。MEMBERSHIP
: メンバーシップ名。Chat API のspaces.members.list
メソッドから取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
python3 chat_membership_update_to_manager_app.py
スペースの管理者を Chat アプリとして通常のメンバーにする
アプリの認証には、1 回限りの管理者の承認が必要です。
API キーを作成する
デベロッパー プレビュー版 API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。
API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。
- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > [API キー] をクリックします。
- 新しい API キーが表示されます。
- [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳しくは、API キーの制限を適用するをご覧ください。
Chat API を呼び出すスクリプトを作成する
次の例では、アプリ認証を使用して Chat API を呼び出し、更新されたメンバーシップ属性を指定する body
で role
を ROLE_MEMBER
として指定することで、スペース管理者を通常のスペース メンバーにします。
Python
- 作業ディレクトリに、
chat_membership_update_to_member_app.py
という名前のファイルを作成します。 chat_membership_update_to_member_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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
コードで、次のように置き換えます。
API_KEY
: Chat API のサービス エンドポイントを構築するために作成した API キー。SPACE
: スペース名。Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。MEMBERSHIP
: メンバーシップ名。Chat API のspaces.members.list
メソッドから取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
python3 chat_membership_update_to_member_app.py
Google Workspace 管理者としてメンバーシップを更新する
Google Workspace 管理者は、update()
メソッドを呼び出して、Google Workspace 組織内の任意のスペースのメンバーシップを更新できます。
Google Workspace 管理者としてこのメソッドを呼び出す手順は次のとおりです。
- ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドの呼び出しをサポートする認可スコープを指定します。
- リクエストで、クエリ パラメータ
useAdminAccess
をtrue
に指定します。
詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。
関連トピック
- ユーザーまたは Google Chat アプリをスペースに招待または追加する。
- ユーザーまたは Chat アプリのメンバーシップに関する詳細情報を取得する。
- スペースのメンバーを一覧表示する。
- スペースからユーザーまたは Chat 用アプリを削除する。