Usuwanie pokoju

Ten przewodnik wyjaśnia, jak używać metody delete() w zasobie Space interfejsu Google Chat API do usuwania nazwanego pokoju, gdy nie jest już potrzebny. Usunięcie pokoju powoduje też usunięcie wszystkich jego elementów, w tym wiadomości i załączników.

Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę delete() , aby usunąć dowolny nazwany pokój w organizacji Google Workspace.

SpaceZasób reprezentuje miejsce, w którym użytkownicy i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka rodzajów pokoi:

  • Wiadomości na czacie to rozmowy między 2 użytkownikami lub między użytkownikiem a aplikacją do obsługi czatu.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami i aplikacjami do czatowania.
  • Pokoje z nazwami to trwałe miejsca, w których użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować.

Wymagania wstępne

Node.js

Usuwanie nazwanego pokoju przez użytkownika

Aby usunąć istniejący pokój w Google Chat z uwierzytelnianiem użytkownika, w żądaniu przekaż te informacje:

  • Określ zakres autoryzacji chat.delete.
  • Wywołaj metodę DeleteSpace().
  • Przekaż name pokoju, który chcesz usunąć.

Aby usunąć pokój:

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);

Aby uruchomić ten przykład, zastąp SPACE_NAME identyfikatorem z pola name przestrzeni. Możesz go uzyskać, wywołując metodę ListSpaces() lub z adresu URL pokoju.

Usuwanie nazwanego pokoju jako aplikacja do Google Chat

Uwierzytelnianie aplikacji wymaga jednorazowego zatwierdzenia przez administratora.

W przypadku uwierzytelniania aplikacji możesz usuwać tylko pokoje utworzone przez aplikacje do obsługi czatu.

Aby usunąć istniejący pokój w Google Chat za pomocą uwierzytelniania aplikacji, w żądaniu przekaż:

  • Określ zakres autoryzacji chat.app.delete.
  • Wywołaj metodę delete w Spacezasobie.
  • Przekaż name pokoju, który chcesz usunąć.

Tworzenie klucza interfejsu API

Aby wywołać metodę interfejsu API wersji przedpremierowej dla programistów, musisz użyć niepublicznej wersji przedpremierowej dla programistów dokumentu wykrywania interfejsu API. Aby uwierzytelnić żądanie, musisz przekazać klucz interfejsu API.

Aby utworzyć klucz interfejsu API, otwórz projekt Google Cloud aplikacji i wykonaj te czynności:

  1. W konsoli Google Cloud otwórz Menu  > Interfejsy API i usługi > Dane logowania.

    Przejdź do danych logowania

  2. Kliknij Utwórz dane logowania > Klucz interfejsu API.
  3. Wyświetli się nowy klucz interfejsu API.
    • Kliknij Kopiuj , aby skopiować klucz interfejsu API do użycia w kodzie aplikacji. Klucz interfejsu API można też znaleźć w sekcji „Klucze interfejsu API” w danych logowania projektu.
    • Kliknij Ogranicz klucz, aby zaktualizować ustawienia zaawansowane i ograniczyć użycie klucza interfejsu API. Więcej informacji znajdziesz w artykule Stosowanie ograniczeń dotyczących kluczy interfejsu API.

Napisz skrypt, który wywołuje Chat API

Aby usunąć pokój:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_delete_app.py.

  2. Dodaj do pliku chat_space_delete_app.py ten kod:

    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()

  3. W kodzie zastąp te elementy:

    • API_KEY: klucz interfejsu API utworzony do budowania punktu końcowego usługi dla interfejsu Chat API.

    • SPACE z nazwą pokoju, którą możesz uzyskać za pomocą spaces.list metody w interfejsie Chat API lub z adresu URL pokoju.

  4. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_delete_app.py

Jeśli operacja się uda, treść odpowiedzi będzie pusta, co oznacza, że przestrzeń została usunięta.

Usuwanie pokoju z nazwą jako administrator Google Workspace

Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę DeleteSpace(), aby usunąć dowolny nazwany pokój w organizacji Google Workspace.

Aby wywołać tę metodę jako administrator Google Workspace:

  • Wywołaj metodę za pomocą uwierzytelniania użytkownika i określ zakres autoryzacji, który obsługuje wywoływanie metody z użyciem uprawnień administratora.
  • W żądaniu ustaw parametr zapytania useAdminAccess na true.

Więcej informacji i przykłady znajdziesz w artykule Zarządzanie pokojami w Google Chat jako administrator Google Workspace.