從聊天室中移除成員

本指南將說明如何使用 delete() 方法是使用 Google Chat API 的 Membership 資源，藉此從 聊天室也稱為刪除成員資格如果聊天室管理員是聊天室中唯一的管理員，就無法移除。請先指派其他使用者擔任聊天室管理員，再移除這些會籍。

如果您是 Google Workspace 管理員，可以從 Google Workspace 機構中的任何聊天室移除使用者、Google 群組或 Chat 應用程式。

Membership 項資源 代表受邀參加的使用者或 Google Chat 應用程式 屬於或不存在於空格中。

必要條件

Node.js

• 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用並設定 Google Chat API。 圖示和說明
  • 安裝 Node.js Cloud 用戶端程式庫。
  • 根據您要在 Google Chat API 要求中驗證的方式，建立存取憑證：
    • 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
    • 如要以 Chat 應用程式的身分進行驗證， 建立服務帳戶 憑證，並將憑證儲存為 JSON 檔案 credentials.json。
• 根據您想以使用者或 Chat 應用程式身分進行驗證，選擇授權範圍。

• Google Chat 聊天室。如要使用 Google Chat API 建立聊天室，請參閱「建立聊天室」一文。如要在 Chat 中建立聊天室，請按照下列步驟操作： 請前往 說明中心文件。

本頁中的程式碼範例使用 gRPC API 介面與 Google Cloud 用戶端 程式庫或者，您也可以使用 REST API 介面。如要進一步瞭解 gRPC 和 REST 介面，請參閱 Google Chat API 總覽。

以使用者身分移除成員的聊天室

如要從應用程式中移除使用者、Google 群組或 Chat 應用程式，請按照下列步驟操作： 與 使用者驗證，傳遞 包括：

• 指定 chat.memberships 授權範圍。 授權使用者必須擁有移除使用者或 Google 群組的權限 從空間中學習如要移除 Chat 擴充應用程式，請指定 chat.memberships.app 授權範圍 (應用程式只能刪除各自的 個人會籍；而非其他應用程式)。最佳做法是選擇 讓應用程式正常運作。
• 呼叫 DeleteMembership() 方法。
• 傳遞要刪除的會員 name。如果成員資格屬於 只有聊天室中的聊天室管理員，請在 之前將其他使用者指派為聊天室管理員 正在刪除此會員資格。

刪除會員資格的方法如下： 使用者驗證：

Node.js

chat/client-libraries/cloud/delete-space-user-cred.js

前往 GitHub 查看

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

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME'
  };

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

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

main().catch(console.error);

如要執行這個範例，請取代下列項目：

• SPACE_NAME：聊天室的 name 中的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
• MEMBER_NAME：成員的 ID name。 您可以呼叫 ListMemberships() 方法來取得 ID。

如果成功，回應主體會傳回包含 'state': 'NOT_A_MEMBER'：表示成員已不在聊天室中。

{
    "name": "spaces/SPACE_NAME/members/MEMBER_NAME",
    "state": "NOT_A_MEMBER"
}

以 Chat 應用程式身分將成員從聊天室中移除

開發人員預覽版： Google Workspace 開發人員預覽版計畫， 可讓你搶先體驗特定功能。

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

如要從應用程式中移除使用者、Google 群組或 Chat 應用程式，請按照下列步驟操作： 與 應用程式驗證，通過 包括：

• 指定 chat.app.memberships 授權範圍僅刪除聊天室管理員的成員資格 但適用於透過 Chat 擴充應用程式建立的聊天室。
• 呼叫 delete 方法 的 membership 項資源。
• 傳遞會員方案的 name 即可刪除。如果會員屬於聊天室中唯一的聊天室管理員，請先指派其他使用者擔任聊天室管理員，再刪除這項會員資格。

建立 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 的指令碼

刪除會員資格的方法如下： 應用程式驗證：

Python

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

2. 在 chat_membership_delete_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 deletes the specified membership.
       '''
   
       # 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().delete(
   
           # The membership to delete.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MEMBER with a membership name.
           # Obtain the membership name from the memberships resource of
           # Chat API. To delete a Chat app's membership, replace MEMBER
           # with app; an alias for the app calling the API.
           name='spaces/SPACE/members/MEMBER'
   
       ).execute()
   
       # Print Chat API's response in your command line interface.
       # When deleting a membership, the response body is empty.
       print(result)
   
   if __name__ == '__main__':
       main()
   

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

   • API_KEY：您為了建構而建立的 API 金鑰 Chat API 的服務端點

   • SPACE：聊天室名稱，您可以從中取得 spaces.list 方法 或聊天室網址傳送

   • MEMBER：您可以取得的會員名稱 透過 spaces.members.list 方法 。如要刪除應用程式的會員資格，請將 MEMBER 替換為 app。

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

   python3 chat_membership_delete_app.py

如果成功，回應主體會傳回包含 'state': 'NOT_A_MEMBER'：表示成員已不在聊天室中。

{
    "name": "spaces/SPACE/members/MEMBER",
    "state": "NOT_A_MEMBER"
}

限制與考量

• 透過應用程式驗證，Chat 應用程式可以移除使用者，但無法移除 Google 群組。

以 Google Workspace 管理員身分移除聊天室中的使用者或 Google 群組

如果您是 Google Workspace 管理員，可以呼叫 使用 DeleteMembership() 種方法移除使用者、Google 網路論壇或 Google Workspace 聊天室中的任何聊天室應用程式 並根據貴機構的使命 價值觀和目標進行調整

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

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

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

相關主題

• 取得使用者或 Chat 應用程式的會籍詳情。
• 列出聊天室成員。
• 更新使用者在 Google Chat 聊天室中的成員資格。
• 邀請或新增使用者或 Chat 應用程式至聊天室。