スペースを削除する

このガイドでは、Google Chat API の Space リソースで delete() メソッドを使用して、不要になった名前付きスペースを削除する方法について説明します。スペースを削除すると、メッセージや添付ファイルなど、スペースに含まれるすべてのコンテンツも削除されます。

Google Workspace 管理者は、delete() メソッドを呼び出して、Google Workspace 組織内の名前付きスペースを削除できます。

Space リソースは、ユーザーと Chat 用アプリがメッセージの送信、ファイルの共有、共同作業を行える場所を表します。スペースにはいくつかの種類があります。

  • ダイレクト メッセージ（DM）は、2 人のユーザー間、またはユーザーと Chat 用アプリ間の会話です。
  • グループ チャットは、3 人以上のユーザーと Chat 用アプリ間の会話です。
  • 名前付きスペースは、ユーザーがメッセージの送信、ファイルの共有、共同作業を行うための永続的な場所です。

前提条件

Node.js

ユーザーとして名前付きスペースを削除する

ユーザー認証を使用して Google Chat の既存のスペースを削除するには、リクエストで次の値を渡します。

  • chat.delete 認可スコープを指定します。
  • DeleteSpace() メソッドを呼び出します。
  • 削除するスペースの 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);
}

main().catch(console.error);

このサンプルを実行するには、SPACE_NAME をスペースの name フィールドの ID に置き換えます。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。

Chat 用アプリとして名前付きスペースを削除する

アプリの認証には、1 回限りの管理者による承認が必要です。

アプリ認証では、Chat 用アプリによって作成されたスペースのみを削除できます。

アプリ認証を使用して Google Chat の既存のスペースを削除するには、リクエストで次の情報を渡します。

Chat API を呼び出すスクリプトを作成する

スペースを削除する手順は次のとおりです。

Python

  1. 作業ディレクトリに chat_space_delete_app.py という名前のファイルを作成します。

  2. 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)

    # 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. コードで、次のように置き換えます。

    • SPACE（スペース名）。これは、Chat API の spaces.list メソッドまたはスペースの URL から取得できます。

  4. 作業ディレクトリで、サンプルをビルドして実行します。

    python3 chat_space_delete_app.py

成功すると、レスポンスの本文は空になり、スペースが削除されたことを示します。

Google Workspace 管理者として名前付きスペースを削除する

Google Workspace 管理者は、DeleteSpace() メソッドを呼び出して、Google Workspace 組織内の名前付きスペースを削除できます。

Google Workspace 管理者としてこのメソッドを呼び出すには、次の操作を行います。

  • ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドを呼び出すことをサポートする認可スコープを指定します。
  • リクエストで、クエリ パラメータ useAdminAccess を true に指定します。

詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。