Получить подробную информацию о пространстве

В этом руководстве объясняется, как использовать метод get() для ресурса Space API Google Chat, чтобы просмотреть сведения о пространстве, такие как его отображаемое имя, описание и правила.

Если вы являетесь администратором Google Workspace, вы можете вызвать метод get() , чтобы получить сведения о любом пространстве в вашей организации Google Workspace.

Ресурс Space представляет собой место, где люди и приложения Chat могут отправлять сообщения, обмениваться файлами и сотрудничать. Существует несколько типов пространств:

  • Прямые сообщения (ЛС) — это беседы между двумя пользователями или пользователем и приложением чата.
  • Групповые чаты — это беседы между тремя и более пользователями и приложениями чата.
  • Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

Аутентификация с аутентификацией приложения позволяет приложению Chat получать сведения о пространстве, участником которого является приложение Chat. Аутентификация с аутентификацией пользователя позволяет вам получать пространства, к которым аутентифицированный пользователь имеет доступ либо как участник пространства, либо как администратор Google Workspace .

Предпосылки

Node.js

Питон

Ява

Скрипт приложений

Получить место

Чтобы получить место в Google Chat, передайте в запрос следующее:

Получить подробную информацию о пространстве как пользователь

Вот как получить данные о пространстве с аутентификацией пользователя :

Node.js

чат/клиентские-библиотеки/облако/получить-пространство-пользователь-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);
}

main().catch(console.error);

Питон

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

Ява

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

Скрипт приложений

чат/расширенный-сервис/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 на ID из поля name пространства. Вы можете получить ID, вызвав метод ListSpaces() или из URL пространства.

API чата возвращает экземпляр Space , который детализирует указанное пространство.

Получите сведения о пространстве как администратор Google Workspace

Если вы являетесь администратором Google Workspace, вы можете вызвать метод GetSpace , чтобы получить сведения о любом пространстве в вашей организации Google Workspace.

Чтобы вызвать этот метод от имени администратора Google Workspace, выполните следующие действия:

Дополнительную информацию и примеры см. в статье Управление пространствами Google Chat в качестве администратора Google Workspace .

Получите подробную информацию о пространстве в виде чат-приложения

Вот как получить данные о пространстве с помощью аутентификации через приложение :

Node.js

чат/клиентские-библиотеки/облако/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);
}

main().catch(console.error);

Питон

чат/клиентские-библиотеки/облако/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()

Ява

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

Скрипт приложений

чат/расширенный-сервис/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 на ID из поля name пространства. Вы можете получить ID, вызвав метод ListSpaces() или из URL пространства.

API чата возвращает экземпляр Space , который детализирует указанное пространство.

Ограничения и соображения

  • Поля accessSettings , predefinedPermissionSettings и permissionSettings заполняются только при аутентификации в области chat.app.spaces , а настройки разрешений ограничиваются пространствами, созданными приложением Chat.