Crea un espacio con nombre en Google Chat

En esta guía, se explica cómo crear un espacio con nombre usando el método create() del recurso Space de la API de Google Chat.

Un espacio con nombre (en el que spaceType es SPACE) es un lugar donde las personas envían mensajes, comparten archivos y colaboran. Los espacios con nombre pueden incluir apps de Chat. Los espacios con nombre tienen administradores que pueden aplicar parámetros de configuración administrativos, descripciones, y agregar o quitar personas y apps.

Para crear diferentes tipos de espacios de Chat (incluidos los mensajes directos o los mensajes grupales), usa el método setUp() en el recurso Space para crear el espacio y agregar miembros al mismo tiempo. Para obtener más información, consulta Cómo configurar un espacio.

Después de crear un espacio con nombre, el único miembro del espacio es el usuario autenticado. Para agregar miembros al espacio, llama al método create() en el recurso Membership para cada persona o app que quieras agregar. También puedes usar el método setUp() para crear un espacio con nombre y agregar miembros al mismo tiempo.

Requisitos previos

Node.js

Python

Java

Apps Script

Crea un espacio con nombre como usuario

Para crear un espacio con nombre con autenticación de usuario, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de autorización chat.spaces.create o chat.spaces.
  • Llama al método CreateSpace() y pasa space como una instancia de Space con los siguientes campos:
    • spaceType está establecido en SPACE.
    • displayName establecido en el nombre del espacio visible para el usuario
    • De manera opcional, establece otros atributos, como los siguientes:
      • spaceDetails: Una descripción visible para el usuario y un conjunto de lineamientos para el espacio.
      • predefinedPermissionSettings: Permisos predefinidos para el espacio. Por ejemplo, puedes configurarlo para que todos los miembros o solo los administradores del espacio puedan publicar mensajes.

Sigue estos pasos para crear un espacio con nombre:

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

Crea un espacio con nombre como una app de Chat

La autenticación de la app requiere la aprobación del administrador una sola vez.

Para invitar o agregar un usuario a un espacio con autenticación de la app, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de autorización de chat.app.spaces.create o chat.app.spaces.
  • Llama al método create en el recurso Space.
  • Configura spaceType como SPACE.
  • Establece displayName en el nombre del espacio visible para el usuario. En el siguiente ejemplo, displayName se establece en API-made.
  • Especifica el ID de cliente del dominio de Google Workspace con el campo customer.
  • De manera opcional, puedes establecer otros atributos del espacio, como spaceDetails (una descripción visible para el usuario y un conjunto de lineamientos para el espacio).

Crea una clave de API

Para llamar a un método de la API de la versión preliminar para desarrolladores, debes usar una versión preliminar para desarrolladores no pública del documento de descubrimiento de la API. Para autenticar la solicitud, debes pasar una clave de API.

Para crear la clave de API, abre el proyecto de Google Cloud de tu app y haz lo siguiente:

  1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Credenciales.

    Ir a Credenciales

  2. Haz clic en Crear credenciales > Clave de API.
  3. Se mostrará tu nueva clave de API.
    • Haz clic en Copiar para copiar tu clave de API y usarla en el código de tu app. La clave de API también se puede encontrar en la sección "Claves de API" de las credenciales de tu proyecto.
    • Haz clic en Restringir clave para actualizar la configuración avanzada y limitar el uso de tu clave de API. Para obtener más detalles, consulta Aplica restricciones de claves de API.

Escribe un script que llame a la API de Chat

Sigue estos pasos para crear un espacio con nombre:

Python

  1. En tu directorio de trabajo, crea un archivo llamado chat_space_create_named_app.py.

  2. Incluye el siguiente código en 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, 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().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. En el código, reemplaza lo siguiente:

    • API_KEY: Es la clave de API que creaste para compilar el extremo de servicio de la API de Chat.

    • CUSTOMER: Es el ID de cliente del dominio del espacio en el formato customer/{customer}, en el que {customer} es el ID del recurso del cliente del SDK de Admin. Para crear un espacio en la misma organización de Google Workspace que la app de Chat, usa customers/my_customer.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_space_create_named_app.py

Abre el espacio en Google Chat

Para navegar al espacio, usa el ID de recurso del espacio para compilar su URL. Puedes encontrar el ID del recurso en el objeto name del cuerpo de la respuesta de Google Chat. Por ejemplo, si el name de tu espacio es spaces/1234567, puedes navegar al espacio con la siguiente URL: https://mail.google.com/chat/u/0/#chat/space/1234567.

Limitaciones y consideraciones

  • Cuando creas un espacio con la autenticación de la app, la app de Chat que se autentica se agrega como miembro del espacio, pero, a diferencia de la autenticación de usuarios, no como administrador del espacio. De forma predeterminada, todos los miembros del espacio pueden quitar la app de Chat. Para permitir que solo los administradores del espacio quiten la app de Chat, configura permissionSettings.manageApps como managersAllowed.