Receber detalhes sobre um espaço

Neste guia, explicamos como usar o método get() em um recurso Space da API Google Chat para conferir detalhes sobre um espaço, como o nome de exibição, a descrição e as diretrizes.

Se você é administrador do Google Workspace, pode chamar o método get() para extrair detalhes sobre qualquer espaço na sua organização do Google Workspace.

O recurso Space representa um lugar onde as pessoas e os apps de chat podem enviar mensagens, compartilhar arquivos e colaborar. Há vários tipos de espaços:

  • As mensagens diretas (DMs) são conversas entre dois usuários ou entre um usuário e um app do Chat.
  • As conversas em grupo são conversas entre três ou mais usuários e apps de chat.
  • Os espaços nomeados são lugares permanentes em que as pessoas enviam mensagens, compartilham arquivos e colaboram.

A autenticação com autenticação de apps permite que um app do Chat receba detalhes sobre um espaço em que ele é membro. A autenticação com autenticação do usuário permite que você acesse espaços aos quais o usuário autenticado tem acesso, seja como membro do espaço ou como administrador do Google Workspace.

Pré-requisitos

Node.js

Python

Java

Apps Script

Acessar os detalhes de um espaço

Para receber um espaço no Google Chat, transmita o seguinte na sua solicitação:

Conferir detalhes do espaço como usuário

Confira como conferir os detalhes do espaço com a autenticação do usuário:

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); }  main().catch(console.error);

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

Para executar este exemplo, substitua SPACE_NAME pelo ID do campo name do espaço. Para conseguir o ID, chame o método ListSpaces() ou o URL do espaço.

A API Chat retorna uma instância de Space que detalha o espaço especificado.

Conferir detalhes do espaço como administrador do Google Workspace

Se você for administrador do Google Workspace, poderá chamar o método GetSpace para extrair detalhes sobre qualquer espaço na sua organização do Google Workspace.

Para chamar esse método como administrador do Google Workspace, faça o seguinte:

Para mais informações e exemplos, consulte Gerenciar espaços do Google Chat como administrador do Google Workspace.

Conferir detalhes do espaço como um app do Chat

Saiba como conferir os detalhes do espaço com a autenticação de app:

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); }  main().catch(console.error);

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

Para executar este exemplo, substitua SPACE_NAME pelo ID do campo name do espaço. Para conseguir o ID, chame o método ListSpaces() ou o URL do espaço.

A API Chat retorna uma instância de Space que detalha o espaço especificado.

Limitações e considerações