スペースの詳細を表示する

このガイドでは、Google Chat API の Space リソースで get メソッドを使用して、スペースの詳細（表示名、説明、ガイドラインなど）を確認する方法について説明します。

Google Workspace 管理者は、get メソッドを呼び出して、Google Workspace 組織内の任意のスペースの詳細を取得できます。

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

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

アプリ認証で 認証 すると、Chat アプリは、Chat アプリがメンバーであるスペース の詳細を取得できます。ユーザー認証で認証すると、認証されたユーザーがスペース メンバーまたはGoogle Workspace 管理者としてアクセスできるスペースを取得できます。

前提条件

Node.js

Python

Java

Apps Script

スペースを取得する

Google Chat でスペースを取得するには、リクエストで次の情報を渡します。

  • 認可スコープ:
    • ユーザー認証の場合は、 chat.spaces.readonly または chat.spaces 認可スコープを指定します。
    • アプリ認証の場合は、 認可スコープまたはchat.botスコープchat.app.spacesを指定します。 chat.app.spaces スコープは デベロッパー プレビューで利用できます。使用するには、 管理者の承認が 1 回必要です。
  • GetSpace メソッドを呼び出し、取得するスペースの name を渡します。スペース名は、Google Chat の Space リソースまたはスペースの URL から取得します。

ユーザーとしてスペースの詳細を取得する

ユーザー認証でスペースの詳細を取得する手順は次のとおりです。

Node.js

chat/client-libraries/cloud/get-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.spaces.readonly',
];

// This sample shows how to get 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.getSpace(request);

  // Handle the response
  console.log(response);
}

await main();

Python

chat/client-libraries/cloud/get_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]

# This sample shows how to get space with user credential
def get_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

    # Make the request
    response = client.get_space(request)

    # Handle the response
    print(response)

get_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with user credential.
public class GetSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.readonly";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get space with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = "spaces/SPACE_NAME";

  // Make the request
  const response = Chat.Spaces.get(name);

  // Handle the response
  console.log(response);
}

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

Chat API は、指定されたスペースの詳細を示す Space のインスタンスを返します。

Google Workspace 管理者としてスペースの詳細を取得する

Google Workspace 管理者は、GetSpace メソッドを呼び出して、Google Workspace 組織内の任意のスペースの詳細を取得できます。

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

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

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

Chat アプリとしてスペースの詳細を取得する

アプリ認証でスペースの詳細を取得する手順は次のとおりです。

Node.js

chat/client-libraries/cloud/get-space-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to get space with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME',
  };

  // Make the request
  const response = await chatClient.getSpace(request);

  // Handle the response
  console.log(response);
}

await main();

Python

chat/client-libraries/cloud/get_space_app_cred.py
from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to get space with app credential
def get_space_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

    # Make the request
    response = client.get_space(request)

    # Handle the response
    print(response)

get_space_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with app credential.
public class GetSpaceAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get space with app credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getSpaceAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = "spaces/SPACE_NAME";
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.get(
    name,
    parameters,
    getHeaderWithAppCredentials(),
  );

  // Handle the response
  console.log(response);
}

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

Chat API は、指定されたスペースの詳細を示す Space のインスタンスを返します。

制限事項と考慮事項

  • accessSettings （accessPermissionSettings を含む）、 predefinedPermissionSettings、 および permissionSettings フィールドは、 chat.app.spaces スコープで認証した場合にのみ入力されます。権限設定は、 Chat アプリが作成したスペースに限定されます。