スペースを削除する

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

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

Space リソースは、ユーザーや Chat アプリがメッセージを送信したり、ファイルを共有したり、コラボレーションしたりできる場所を表します。スペースには次の 2 種類があります。

  • ダイレクト メッセージ(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 の既存のスペースを削除するには、リクエストで次の情報を渡します。

API キーを作成する

デベロッパー プレビュー版の API メソッドを呼び出すには、非公開のデベロッパー プレビュー版の API 検出ドキュメントを使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

  1. Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。

    [認証情報] に移動

  2. [認証情報を作成] > [API キー] をクリックします。
  3. 新しい API キーが表示されます。
    • [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
    • [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳細については、API キーの制限を適用するをご覧ください。

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

    • API_KEY: Chat API のサービス エンドポイントを構築するために作成した API キー。

    • SPACE は、Chat API の spaces.list メソッドまたはスペースの URL から取得できるスペース名に置き換えます。

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

    python3 chat_space_delete_app.py

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

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

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

Google Workspace 管理者としてこのメソッドを呼び出す手順は次のとおりです。

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

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