Criar um espaço com nome no Google Chat

Este guia explica como criar um espaço nomeado usando o método create() no recurso Space da API Google Chat.

Um espaço nomeado (em que o spaceType é SPACE) é um lugar onde as pessoas enviam mensagens, compartilham arquivos e colaboram. Os espaços nomeados podem incluir apps do Chat. Os espaços nomeados têm administradores que podem aplicar configurações administrativas, descrições e adicionar ou remover pessoas e apps.

Para criar diferentes tipos de espaços do Chat (incluindo mensagens diretas ou em grupo), use o método setUp() no recurso Space para criar o espaço e adicionar participantes ao mesmo tempo. Para mais detalhes, configure um espaço.

Depois de criar um espaço nomeado, o único membro dele é o usuário autenticado. Para adicionar membros ao espaço, chame o método create() no recurso Membership para cada pessoa ou app que você quer adicionar. Ou use o método setUp() para criar um espaço nomeado e adicionar participantes ao mesmo tempo.

Pré-requisitos

Node.js

Python

Java

Apps Script

Criar um espaço nomeado como usuário

Para criar um espaço nomeado com autenticação de usuário, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.spaces.create ou chat.spaces.
  • Chame o método CreateSpace() transmitindo space como uma instância de Space com os seguintes campos:
    • spaceType definido como SPACE.
    • displayName definido como o nome do espaço visível para o usuário.
    • Se quiser, defina outros atributos, como:
      • spaceDetails: uma descrição visível para o usuário e um conjunto de diretrizes para o espaço.
      • predefinedPermissionSettings: permissões predefinidas para o espaço. Por exemplo, você pode configurar para que todos os participantes ou apenas os administradores do espaço possam postar mensagens.

Veja como criar um espaço nomeado:

Node.js

chat/client-libraries/cloud/create-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.create'];  // This sample shows how to create a named space with user credential async function main() {   // Create a client   const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);    // Initialize request argument(s)   const request = {     space: {       spaceType: 'SPACE',       // Replace DISPLAY_NAME here.       displayName: 'DISPLAY_NAME'     }   };    // Make the request   const response = await chatClient.createSpace(request);    // Handle the response   console.log(response); }  main().catch(console.error);

Python

chat/client-libraries/cloud/create_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.create"]  def create_space_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.CreateSpaceRequest(         space = {             "space_type": 'SPACE',             # Replace DISPLAY_NAME here.             "display_name": 'DISPLAY_NAME'         }     )      # Make the request     response = client.create_space(request)      # Handle the response     print(response)  create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.CreateSpaceRequest; import com.google.chat.v1.Space;  // This sample shows how to create space with user credential. public class CreateSpaceUserCred {    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.spaces.create";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()         .setSpace(Space.newBuilder()           .setSpaceType(Space.SpaceType.SPACE)           // Replace DISPLAY_NAME here.           .setDisplayName("DISPLAY_NAME"));       Space response = chatServiceClient.createSpace(request.build());        System.out.println(JsonFormat.printer().print(response));     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to create space with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'  * referenced in the manifest file (appsscript.json).  */ function createSpaceUserCred() {   // Initialize request argument(s)   const space = {     spaceType: 'SPACE',     // TODO(developer): Replace DISPLAY_NAME here     displayName: 'DISPLAY_NAME'   };    // Make the request   const response = Chat.Spaces.create(space);    // Handle the response   console.log(response); }

Criar um espaço nomeado como um app do Chat

A autenticação do app exige uma única aprovação do administrador.

Para convidar ou adicionar um usuário a um espaço com autenticação de app, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.app.spaces.create ou chat.app.spaces.
  • Chame o método create no recurso Space.
  • Defina spaceType como SPACE.
  • Defina displayName como o nome do espaço visível para o usuário. No exemplo a seguir, displayName está definido como API-made.
  • Especifique o ID do cliente do domínio do Google Workspace usando o campo customer.
  • Se quiser, defina outros atributos do espaço, como spaceDetails (uma descrição visível para o usuário e um conjunto de diretrizes para o espaço).

Escrever um script que chama a API Chat

Veja como criar um espaço nomeado:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_create_named_app.py.

  2. Inclua o seguinte código em chat_space_create_named_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.spaces.create"]  def main():     '''     Authenticates with Chat API using app authentication,     then creates a Chat 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().create(        # Details about the space to create.       body = {          # To create a named space, set spaceType to SPACE.         'spaceType': 'SPACE',          # The user-visible name of the space.         'displayName': 'API-made',          # The customer ID of the Workspace domain.         'customer': 'CUSTOMER'       }        ).execute()      # Prints details about the created space.     print(result)  if __name__ == '__main__':     main()

  3. No código, substitua o seguinte:

    • CUSTOMER: o ID do cliente do domínio do espaço no formato customer/{customer}, em que {customer} é o ID do recurso de cliente do SDK Admin. Para criar um espaço na mesma organização do Google Workspace que o app Chat, use customers/my_customer.

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_space_create_named_app.py

Abra o espaço no Google Chat.

Para navegar até o espaço, use o ID do recurso dele para criar o URL. Você pode encontrar o ID do recurso no corpo da resposta do espaço name no Google Chat. Por exemplo, se o name do seu espaço for spaces/1234567, navegue até ele usando o seguinte URL: https://mail.google.com/chat/u/0/#chat/space/1234567.

Limitações e considerações

  • Quando você cria um espaço usando a autenticação de app, o app do Chat autenticado é adicionado como participante, mas, ao contrário da autenticação de usuário, não como administrador. Por padrão, todos os membros do espaço podem remover o app Chat. Para permitir que apenas os administradores do espaço façam isso, defina permissionSettings.manageApps como managersAllowed.