Usuwanie pokoju

Z tego przewodnika dowiesz się, jak użyć metody delete() w zasobach Space interfejsu Google Chat API, aby usunąć przestrzeń nazwaną, gdy nie jest już potrzebna. Usunięcie pokoju powoduje również 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 pokonywany pokój w organizacji Google Workspace.

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

  • Czaty to rozmowy między dwoma użytkownikami lub użytkownikiem a aplikacją czatu.
  • Czaty grupowe to rozmowy między 3 lub większą liczbą użytkowników i aplikacji Google Chat.
  • Nazwane pokoje to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Wymagania wstępne

Node.js

Usuwanie nazwanego pokoju przez użytkownika

Aby usunąć istniejący pokój w Google Chat za pomocą uwierzytelniania użytkownika, podaj w żądaniu:

  • Określ zakres upoważnienia 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 wartość SPACE_NAME identyfikatorem z pola name w pokoju. Identyfikator możesz uzyskać, wywołując metodę ListSpaces() lub korzystając z adresu URL pokoju.

Usuwanie pokoju o nazwie w aplikacji Google Chat

Uwierzytelnianie aplikacji wymaga jednorazowego zatwierdzenia przez administratora.

W przypadku uwierzytelniania aplikacji możesz usuwać tylko pokoje utworzone przez aplikacje Google Chat.

Aby usunąć istniejący pokój w Google Chat za pomocą uwierzytelniania aplikacji, prześlij w żądaniu te informacje:

  • Określ zakres upoważnienia chat.app.delete.
  • Wywołaj metodę delete zasobu Space.
  • Przekaż name pokoju, który chcesz usunąć.

Tworzenie klucza interfejsu API

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

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

  1. W konsoli Google Cloud kliknij 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 API.
    • Kliknij Kopiuj , aby skopiować klucz interfejsu API i użyć go w kodzie aplikacji. Klucz interfejsu API znajdziesz też w sekcji „Klucze interfejsu API” w danych logowania projektu.
    • Aby zaktualizować ustawienia zaawansowane i ograniczyć użycie klucza API, kliknij Ogranicz klucz. Więcej informacji znajdziesz w artykule Stosowanie ograniczeń kluczy interfejsu API.

Napisać skrypt, który wywołuje interfejs 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 zamień:

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

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

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

    python3 chat_space_delete_app.py

W przypadku powodzenia treść odpowiedzi jest pusta, co oznacza, że pokój został usunięty.

Usuwanie pokoju o nazwie jako administrator Google Workspace

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

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

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

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