В этом руководстве объясняется, как использовать метод delete()
ресурса Space
API Google Chat для удаления именованного пространства, когда оно больше не нужно. Удаление пространства также удаляет все, что оно содержит, включая сообщения и вложения.
Если вы администратор Google Workspace, вы можете вызвать метод delete()
чтобы удалить любое именованное пространство в вашей организации Google Workspace.
Ресурс Space
представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:
- Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
- Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
- Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.
Предварительные условия
Node.js
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat , указав имя, значок и описание для вашего приложения Chat.
- Установите облачную клиентскую библиотеку Node.js.
- Создайте учетные данные идентификатора клиента OAuth для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде файла JSON с именем
client_secrets.json
в локальном каталоге.
- Выберите область авторизации , которая поддерживает аутентификацию пользователей.
- Пространство Google Chat. Чтобы создать его с помощью Google Chat API, см. раздел Создание пространства . Чтобы создать его в Chat, посетите документацию Справочного центра .
Удалить именованное пространство в качестве пользователя
Чтобы удалить существующее пространство в Google Chat с аутентификацией пользователя , передайте в запросе следующее:
- Укажите область авторизации
chat.delete
. - Вызовите метод
DeleteSpace()
. - Передайте
name
пространства, которое нужно удалить.
Вот как удалить пробел:
Node.js
Чтобы запустить этот пример, замените SPACE_NAME
идентификатором из поля name
пространства. Вы можете получить идентификатор, вызвав метод ListSpaces()
или по URL-адресу пространства.
Удаление именованного пространства как приложения Chat
Для аутентификации приложения требуется однократное одобрение администратора .
С помощью аутентификации приложений вы можете удалять только группы, созданные приложениями чата.
Чтобы удалить существующее пространство в Google Chat с аутентификацией через приложение , передайте в запросе следующее:
- Укажите область
chat.app.delete
. - Вызовите метод
delete
для ресурсаSpace
. - Передайте
name
пространства, которое нужно удалить.
Создайте ключ API
Чтобы вызвать метод API Developer Preview, необходимо использовать закрытую предварительную версию документа обнаружения API для разработчиков. Для аутентификации запроса необходимо передать ключ API.
Чтобы создать ключ API, откройте проект Google Cloud вашего приложения и выполните следующие действия:
- В консоли Google Cloud выберите > API и службы > Учетные данные .
- Нажмите Создать учетные данные > Ключ API .
- Отобразится ваш новый ключ API.
- Нажмите «Копировать , чтобы скопировать ключ API для использования в коде вашего приложения. Ключ API также можно найти в разделе «Ключи API» учетных данных вашего проекта.
- Нажмите «Ограничить ключ» , чтобы обновить дополнительные настройки и ограничить использование вашего ключа API. Дополнительные сведения см. в разделе «Применение ограничений ключей API» .
Напишите скрипт, вызывающий Chat API.
Вот как удалить пробел:
Питон
- В своем рабочем каталоге создайте файл с
chat_space_delete_app.py
. Включите следующий код в
chat_space_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.delete"] def main(): ''' Authenticates with Chat API using app authentication, then deletes the specified space. ''' # 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().delete( # The space 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. name='spaces/SPACE' ).execute() # Print Chat API's response in your command line interface. # When deleting a space, the response body is empty. print(result) if __name__ == '__main__': main()
В коде замените следующее:
API_KEY
: ключ API, который вы создали для создания конечной точки службы для Chat API.SPACE
с именем пространства, которое можно получить с помощью методаspaces.list
в Chat API или из URL-адреса пространства.
В своем рабочем каталоге соберите и запустите пример:
python3 chat_space_delete_app.py
В случае успеха тело ответа становится пустым, что указывает на то, что пробел удален.
Удаление именованного пространства в качестве администратора Google Workspace
Если вы администратор Google Workspace, вы можете вызвать метод DeleteSpace()
чтобы удалить любое именованное пространство в вашей организации Google Workspace.
Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:
- Вызовите метод, используя аутентификацию пользователя, и укажите область авторизации , которая поддерживает вызов метода с правами администратора .
- В своем запросе укажите для параметра запроса
useAdminAccess
значениеtrue
.
Дополнительную информацию и примеры см. в разделе «Управление пространствами Google Chat от имени администратора Google Workspace» .
Связанные темы
- Создайте пространство
- Получите подробную информацию о помещении .
- Перечислите пространства .
- Обновите пространство .
- Удалить пробел .
- Обустройте пространство .
- Найдите место для прямых сообщений .