更新 Google Chat 聊天室中的使用者和成員身分

本指南說明如何在 Google Chat API 的 Membership 資源上使用 update() 方法，變更會員的屬性，例如將聊天室成員變更為聊天室管理員，或將聊天室管理員變更為聊天室成員。

如果您是 Google Workspace 管理員，可以呼叫 update() 方法，更新 Google Workspace 機構中的任何聊天室成員資格。

Membership 資源代表使用者或 Google Chat 應用程式是否已受邀加入聊天室、是否已加入聊天室或未加入聊天室。

必要條件

Node.js

更新會員方案

如要更新工作區會員資格，請在要求中傳遞下列資訊：

  • 指定授權範圍：
    • 透過使用者驗證，請指定 chat.memberships 授權範圍。
    • 透過應用程式驗證 (適用於開發人員預覽版)，請指定 chat.app.memberships 授權範圍。使用應用程式驗證功能更新會員資格時，您只能在 Chat 應用程式建立的聊天室中更新會員資格。應用程式驗證功能需要一次性的管理員核准。
  • 呼叫 UpdateMembership() 方法。
  • 使用以下方法，將 membership 傳遞為 Membership 的例項：
    • name 欄位設為要更新的會員資格，其中包含聊天室 ID 和成員 ID。
    • 更新的會員欄位已設為新的值。
  • 傳遞 updateMask 以指定要更新的會員身分層面，包括：
    • role：使用者在 Chat 聊天室中的角色，決定他們在聊天室中可執行的動作。可能的值包括：
      • ROLE_MEMBER：聊天室成員。使用者具備基本權限，例如傳送訊息至聊天室。在 1:1 和未命名的群組對話中，每個人都具備這個角色。
      • ROLE_MANAGER：聊天室管理員。使用者擁有所有基本權限，以及管理權限，可讓他們管理聊天室，例如新增或移除成員。僅支援 spaceType 為 SPACE 的聊天室 (已命名的聊天室)。

將一般聊天室成員設為聊天室管理員

以下範例使用使用者驗證呼叫 Chat API，藉由指定 role 為 ROLE_MANAGER，將一般聊天室成員設為聊天室管理員：

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
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。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
  • MEMBER_NAME：會員 name 中的 ID。您可以呼叫 ListMemberships() 方法，或透過 Chat API 以非同步方式建立會員資格後，從傳回的回應主體取得 ID。
  • ROLE_NAME：更新的角色 ROLE_MANAGER。

Google Chat API 會將指定的會員資格更新為聊天室管理員，並傳回 Membership 的例項。

將聊天室管理員設為一般成員

以下範例使用使用者驗證呼叫 Chat API，藉由指定 role 為 ROLE_MEMBER，將聊天室管理員設為聊天室的一般成員：

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
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。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
  • MEMBER_NAME：會員 name 中的 ID。您可以呼叫 ListMemberships() 方法，或透過 Chat API 以非同步方式建立會員資格後，從傳回的回應主體取得 ID。
  • ROLE_NAME：更新的角色，ROLE_MEMBER。

Google Chat API 會將指定的會員資格更新為聊天室管理員，並傳回 Membership 的例項。

將一般聊天室成員設為 Chat 應用程式的聊天室管理員

應用程式驗證功能需要一次性的管理員核准。

建立 API 金鑰

如要呼叫開發人員預覽版 API 方法，您必須使用 API 探索文件的非公開開發人員預覽版。您必須傳送 API 金鑰，才能驗證要求。

如要建立 API 金鑰，請開啟應用程式的 Google Cloud 專案，然後執行下列操作：

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。

    前往「憑證」

  2. 依序按一下「建立憑證」 「API 金鑰」。
  3. 系統會顯示新的 API 金鑰。
    • 按一下「複製」 即可複製 API 金鑰，以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
    • 按一下「限制金鑰」，即可更新進階設定並限制 API 金鑰的使用情形。詳情請參閱「套用 API 金鑰限制」一節。

編寫呼叫 Chat API 的指令碼

以下範例會使用應用程式驗證呼叫 Chat API，藉此將一般聊天室成員設為聊天室管理員，方法是在指定更新會員屬性的 body 中，將 role 指定為 ROLE_MANAGER：

Python

  1. 在工作目錄中建立名為 chat_membership_update_to_manager_app.py 的檔案。

  2. 在 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()

  3. 在程式碼中，請替換下列內容：

    • API_KEY：您建立的 API 金鑰，用於建構 Chat API 的服務端點。

    • SPACE：聊天室名稱，可透過 Chat API 中的 spaces.list 方法或聊天室網址取得。

    • MEMBERSHIP：會員名稱，可透過 Chat API 中的 spaces.members.list 方法取得。

  4. 在工作目錄中建構並執行範例：

    python3 chat_membership_update_to_manager_app.py

將聊天室管理員設為 Chat 應用程式的一般成員

應用程式驗證功能需要一次性的管理員核准。

建立 API 金鑰

如要呼叫開發人員預覽版 API 方法，您必須使用 API 探索文件的非公開開發人員預覽版。您必須傳送 API 金鑰，才能驗證要求。

如要建立 API 金鑰，請開啟應用程式的 Google Cloud 專案，然後執行下列操作：

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。

    前往「憑證」

  2. 依序按一下「建立憑證」 「API 金鑰」。
  3. 系統會顯示新的 API 金鑰。
    • 按一下「複製」 即可複製 API 金鑰，以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
    • 按一下「限制金鑰」，即可更新進階設定並限制 API 金鑰的使用方式。詳情請參閱「套用 API 金鑰限制」。

編寫呼叫 Chat API 的指令碼

以下範例會使用應用程式驗證呼叫 Chat API，藉此將聊天室管理員設為聊天室的一般成員，方法是在指定更新的成員屬性的 body 中，將 role 指定為 ROLE_MEMBER：

Python

  1. 在工作目錄中建立名為 chat_membership_update_to_member_app.py 的檔案。

  2. 在 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()

  3. 在程式碼中，請替換下列內容：

    • API_KEY：您建立的 API 金鑰，用於建構 Chat API 的服務端點。

    • SPACE：聊天室名稱，可透過 Chat API 中的 spaces.list 方法或聊天室網址取得。

    • MEMBERSHIP：會員名稱，可透過 Chat API 中的 spaces.members.list 方法取得。

  4. 在工作目錄中建構並執行範例：

    python3 chat_membership_update_to_member_app.py

以 Google Workspace 管理員身分更新會員

如果您是 Google Workspace 管理員，可以呼叫 update() 方法，更新 Google Workspace 機構內任何空間的成員資格。

如要以 Google Workspace 管理員身分呼叫這個方法，請按照下列步驟操作：

  • 使用使用者驗證來呼叫方法，並指定支援使用管理員權限呼叫方法的授權範圍。
  • 在要求中，將查詢參數 useAdminAccess 指定為 true。

如需詳細資訊和範例，請參閱「以 Google Workspace 管理員身分管理 Google Chat 聊天室」。