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

Google Chat スペースでユーザーのメンバーシップを更新する

このガイドでは、 update() メソッド（Google Chat API の Membership リソースのメソッド）で属性を変更しますたとえば、スペースのメンバーをスペースの管理者に変更する、スペースの管理者をスペースのメンバーに変更できます。

Google Workspace 管理者は、update() メソッドを呼び出して、Google Workspace 組織内のスペースのメンバーシップを更新できます。

「 Membership リソース人間のユーザーまたは Google Chat アプリのどちらが招待されているかを表します。その場から離れることがなくなります。

前提条件

Node.js

企業または大企業以下へのアクセス権を持つ Google Workspace アカウント Google Chat。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアントライブラリをインストールします。
- Google Chat API での認証方法に基づいてアクセス認証情報を作成する request: <ph type="x-smartling-placeholder">
  - Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を client_secrets.json という名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとして保存します。
ユーザーとして認証するか、Chat アプリとして認証するかに応じて、認可スコープを選択します。

メンバーシップを更新する

スペースのメンバーシップを更新するには、リクエストに次の内容を渡します。

認可スコープを指定します。
- ユーザー認証で、chat.memberships 認可スコープを指定します。
- ありアプリの認証（デベロッパープレビューで利用可能） chat.app.memberships 承認スコープを指定します。アプリ認証でメンバーシップを更新する場合、更新できるのは Chat アプリによって作成されたスペースのメンバーシップのみです。アプリの認証には、1 回限りの管理者の承認が必要です。
UpdateMembership() メソッドを呼び出します。
次のように、membership を Membership のインスタンスとして渡します。
- 更新するメンバーシップに設定された name フィールド（スペース ID とメンバー ID を含む）。
- 更新するメンバーシップフィールドが新しい値に設定されている。
updateMask を渡して、更新するメンバーシップの要素を指定します。次の内容が含まれます。
- role: Chat スペース内のユーザーのロール。これにより、許可されるユーザーが決まります。方法について説明します。有効な値は次のとおりです。 <ph type="x-smartling-placeholder">
  - ROLE_MEMBER: スペースのメンバー。ユーザーには基本的な権限がありますが、スペースへのメッセージの送信など、1 対 1 の無名のグループ全員がこの役割を持ちます。
  - ROLE_MANAGER: スペース管理者。ユーザーにはすべての基本的な権限に加え、たとえば、スペースを管理するための管理者権限を付与できます。メンバーの削除方法も学びます。spaceType が SPACE であるスペース（名前付きスペース）でのみサポートされます。

スペースの通常のメンバーをユーザーとしてスペースの管理者にする

次の例では、Google Chat でユーザー認証スペースの通常のメンバーをスペースの管理者にするには、role を ROLE_MANAGER:

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js

GitHub で表示

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

サンプルを実行するには、次のように置き換えます。

SPACE_NAME: スペースの name の ID。ID を取得するには、このメソッドを呼び出して、 ListSpaces() スペースの URL から取得できます。
MEMBER_NAME: メンバーシップの ID name。 ID を取得するには、このメソッドを呼び出して、 ListMemberships() メソッドを使用するか、メンバーシップの作成後に返されるレスポンスの本文から取得できます。やり取りできます。
ROLE_NAME: 更新されたロール ROLE_MANAGER。

Google Chat API は、指定されたメンバーシップをスペースの管理者に更新し、スペースの管理者の Pod の Membership。

スペースの管理者をユーザーとして通常のメンバーにする

次の例では、Google Chat でユーザー認証 role をスペースの通常のメンバーとして指定するには、スペースの管理者を ROLE_MEMBER:

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js

GitHub で表示

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.memberships'];

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

  // Make the request
  const response = await chatClient.updateMembership(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

サンプルを実行するには、次のように置き換えます。

SPACE_NAME: スペースの ID name。 ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
MEMBER_NAME: メンバーシップの ID name。 ID は、ListMemberships() メソッドを呼び出すか、Chat API で非同期的にメンバーシップを作成した後に返されるレスポンスの本文から取得できます。
ROLE_NAME: 更新されたロール ROLE_MEMBER。

Google Chat API は、指定されたメンバーシップをスペース管理者に更新し、Membership のインスタンスを返します。

スペースの通常のメンバーを Chat アプリとしてスペースの管理者にする

アプリの認証にはワンタイム認証が必要です管理者の承認が必要です。

API キーを作成する

デベロッパープレビュー版 API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパープレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

Google Cloud コンソールで、メニューに移動します。 > 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: メンバーシップ名。こちらの spaces.members.list メソッド使用します。
作業ディレクトリでサンプルをビルドして実行します。
```
python3 chat_membership_update_to_manager_app.py
```

スペースの管理者を Chat 用アプリとして通常のメンバーに設定する

アプリの認証には、1 回限りの管理者の承認が必要です。

API キーを作成する

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
[認証情報] に移動
[認証情報を作成] > [API キー] をクリックします。
新しい API キーが表示されます。
- コピーアイコンをクリックします。を使用して、アプリのコードで使用する API キーをコピーできます。API キーは [API キー] セクションにあるセクション内にあります。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳細については、API キーの制限を適用するをご覧ください。

Chat API を呼び出すスクリプトを作成する

次の例では、Google Chat でアプリの認証 role をスペースの通常のメンバーとして指定するには、スペースの管理者を更新されたメンバーシップ属性を指定する body の 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: ビルド用に作成した API キーサービスエンドポイントとして機能します。
- SPACE: スペース名。こちらの 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 スペースでユーザーのメンバーシップを更新する

前提条件

Node.js

メンバーシップを更新する

スペースの通常のメンバーをユーザーとしてスペースの管理者にする

Node.js

スペースの管理者をユーザーとして通常のメンバーにする

Node.js

スペースの通常のメンバーを Chat アプリとしてスペースの管理者にする

API キーを作成する

Chat API を呼び出すスクリプトを作成する

Python

スペースの管理者を Chat 用アプリとして通常のメンバーに設定する

API キーを作成する

Chat API を呼び出すスクリプトを作成する

Python

Google Workspace 管理者としてメンバーシップを更新する

関連トピック