Удаление участника из пространства

В этом руководстве объясняется, как использовать метод delete() ресурса Membership API Google Chat для удаления участников из чат-группы, что также называется удалением членства. Менеджеров чат-группы нельзя удалить, если они являются единственными менеджерами в чат-группе. Перед удалением этих членств назначьте другого пользователя менеджером чат-группы.

Если вы являетесь администратором Google Workspace, вы можете удалять пользователей, группы Google или приложения чата из любого пространства в вашей организации Google Workspace.

Ресурс Membership показывает, приглашен ли пользователь-человек или приложение Google Chat в пространство, является его частью или отсутствует в нем.

Предпосылки

Node.js

Удалить участника из пространства как пользователя

Чтобы удалить пользователя, группу Google или приложение чата из пространства с аутентификацией пользователя , передайте в запросе следующее:

  • Укажите область авторизации 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);
}

await main();

Чтобы запустить этот пример, замените следующее:

  • SPACE_NAME : идентификатор из name пространства. Идентификатор можно получить, вызвав метод ListSpaces() или указав URL пространства.
  • MEMBER_NAME : идентификатор, полученный из name участника. Идентификатор можно получить, вызвав метод ListMemberships() .

В случае успеха тело ответа возвращает членство со значением 'state': 'NOT_A_MEMBER' , что указывает на то, что участник больше не находится в пространстве.

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

Удалить участника из пространства как чат-приложения

Аутентификация приложения требует однократного одобрения администратора .

Чтобы удалить пользователя, группу Google или приложение чата из пространства с аутентификацией приложения , передайте в запросе следующее:

  • Укажите область авторизации chat.app.memberships . Удаление членства менеджера пространства поддерживается только в пространствах, созданных приложениями Chat.
  • Вызовите метод delete для ресурса membership .
  • Передайте name удаляемого членства. Если членство принадлежит единственному менеджеру пространства, назначьте другого пользователя менеджером пространства, прежде чем удалять это членство.

Напишите скрипт, который вызывает Chat API

Вот как удалить членство с аутентификацией через приложение :

Питон

  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)

    # 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. В коде замените следующее:

    • SPACE : имя пространства, которое можно получить из метода spaces.list в API чата или из URL-адреса пространства.

    • MEMBER : имя участника, которое можно получить с помощью метода spaces.members.list в API чата. Чтобы удалить участника приложения, замените MEMBER на app .

  4. В вашем рабочем каталоге соберите и запустите пример:

    python3 chat_membership_delete_app.py

В случае успеха тело ответа возвращает членство со значением 'state': 'NOT_A_MEMBER' , что указывает на то, что участник больше не находится в пространстве.

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

Удалять пользователей или группы Google из пространства как администратор Google Workspace

Если вы являетесь администратором Google Workspace, вы можете вызвать метод DeleteMembership() , чтобы удалить пользователей, группы Google или приложения чата из любого пространства в вашей организации Google Workspace.

Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:

Дополнительную информацию и примеры см. в статье Управление пространствами Google Chat в качестве администратора Google Workspace .

Ограничения и соображения