Menghapus ruang

Panduan ini menjelaskan cara menggunakan metode delete() pada resource Space Google Chat API untuk menghapus ruang bernama saat tidak lagi diperlukan. Menghapus ruang juga akan menghapus semua yang berisi, termasuk pesan dan lampiran.

Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode delete() untuk menghapus ruang bernama apa pun di organisasi Google Workspace Anda.

Resource Space mewakili tempat orang dan aplikasi Chat dapat mengirim pesan, berbagi file, dan berkolaborasi. Ada beberapa jenis ruang:

  • Pesan langsung (DM) adalah percakapan antara dua pengguna atau pengguna dan aplikasi Chat.
  • Chat grup adalah percakapan antara tiga pengguna atau lebih dan aplikasi Chat.
  • Ruang bernama adalah tempat persisten tempat orang mengirim pesan, berbagi file, dan berkolaborasi.

Prasyarat

Node.js

Menghapus ruang bernama sebagai pengguna

Untuk menghapus ruang yang ada di Google Chat dengan autentikasi pengguna, teruskan hal berikut dalam permintaan Anda:

  • Tentukan cakupan otorisasi chat.delete.
  • Panggil metode DeleteSpace().
  • Teruskan name ruang yang akan dihapus.

Berikut cara menghapus ruang:

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

Untuk menjalankan contoh ini, ganti SPACE_NAME dengan ID dari kolom name ruang. Anda bisa mendapatkan ID dengan memanggil metode ListSpaces() atau dari URL ruang.

Menghapus ruang bernama sebagai aplikasi Chat

Autentikasi aplikasi memerlukan persetujuan administrator satu kali.

Dengan autentikasi aplikasi, Anda hanya dapat menghapus ruang yang dibuat oleh aplikasi Chat.

Untuk menghapus ruang yang ada di Google Chat dengan autentikasi aplikasi, teruskan hal berikut dalam permintaan Anda:

Membuat kunci API

Untuk memanggil metode Developer Preview API, Anda harus menggunakan versi pratinjau developer non-publik dari dokumen penemuan API. Untuk mengautentikasi permintaan, Anda harus meneruskan kunci API.

Untuk membuat Kunci API, buka project Google Cloud aplikasi Anda dan lakukan hal berikut:

  1. Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create credentials > API key.
  3. Kunci API baru Anda akan ditampilkan.
    • Klik Salin untuk menyalin kunci API Anda agar dapat digunakan dalam kode aplikasi. Kunci API juga dapat ditemukan di bagian "API keys" pada kredensial project Anda.
    • Klik Batasi kunci untuk memperbarui setelan lanjutan dan membatasi penggunaan kunci API Anda. Untuk mengetahui detail selengkapnya, lihat Menerapkan pembatasan kunci API.

Menulis skrip yang memanggil Chat API

Berikut cara menghapus ruang:

Python

  1. Di direktori kerja, buat file bernama chat_space_delete_app.py.

  2. Sertakan kode berikut di 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()

  3. Dalam kode, ganti kode berikut:

    • API_KEY: kunci API yang Anda buat untuk membuat endpoint layanan untuk Chat API.

    • SPACE dengan nama ruang, yang dapat Anda peroleh dari metode spaces.list di Chat API, atau dari URL ruang.

  4. Di direktori kerja, build dan jalankan contoh:

    python3 chat_space_delete_app.py

Jika berhasil, isi respons akan kosong, yang menunjukkan bahwa ruang telah dihapus.

Menghapus ruang bernama sebagai administrator Google Workspace

Jika Anda adalah administrator Google Workspace, Anda dapat memanggil metode DeleteSpace() untuk menghapus ruang bernama apa pun di organisasi Google Workspace Anda.

Untuk memanggil metode ini sebagai administrator Google Workspace, lakukan hal berikut:

  • Panggil metode menggunakan autentikasi pengguna, dan tentukan cakupan otorisasi yang mendukung pemanggilan metode menggunakan hak istimewa administrator.
  • Dalam permintaan, tentukan parameter kueri useAdminAccess ke true.

Untuk mengetahui informasi selengkapnya dan contoh, lihat Mengelola ruang Google Chat sebagai administrator Google Workspace.