從聊天室中移除成員

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

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

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

必要條件

Node.js

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

如要透過使用者驗證從聊天室中移除使用者、Google 群組或 Chat 應用程式,請在要求中傳遞以下內容:

  • 指定 chat.memberships 授權範圍。授權使用者必須具備從聊天室中移除使用者或 Google 群組的權限。如要移除 Chat 應用程式,請指定 chat.memberships.app 授權範圍 (應用程式只能刪除自己的會員資格,而非其他應用程式的會員資格)。最佳做法是選擇最嚴格的範圍,讓應用程式仍可正常運作。
  • 呼叫 DeleteMembership() 方法。
  • 傳遞要刪除的會員 name。如果會員屬於聊天室中唯一的聊天室管理員,請先指派其他使用者擔任聊天室管理員,再刪除這項會籍。

以下說明如何透過使用者驗證刪除會員資格:

Node.js

chat/client-libraries/cloud/delete-space-user-cred.js
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:成員的 name 中的 ID。您可以呼叫 ListMemberships() 方法來取得 ID。

如果成功,回應主體會傳回會員資格,並附上 'state': 'NOT_A_MEMBER',表示會員已離開聊天室。

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

使用 Chat 應用程式從聊天室中移除成員

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

如要透過應用程式驗證從聊天室中移除使用者、Google 群組或 Chat 應用程式,請在要求中傳遞以下內容:

  • 指定 chat.app.memberships 授權範圍。只有在 Chat 應用程式建立的聊天室中,才能刪除聊天室管理員的會員資格。
  • membership 資源上呼叫 delete 方法
  • 傳遞要刪除的會員 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:聊天室名稱,可透過 Chat API 中的 spaces.list 方法或聊天室網址取得。

    • MEMBER:會員名稱,可透過 Chat API 中的 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 Workspace 機構中的任何聊天室移除使用者、Google 群組或 Chat 應用程式。

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

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

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