Cómo configurar un espacio con miembros iniciales

En esta guía, se explica cómo usar el método setup en el recurso Space de la La API de Google Chat para configurar un espacio de Google Chat Configurar un espacio genera espacio. y le agrega usuarios específicos.

El Recurso Space representa un lugar donde las personas y las apps de Chat pueden enviar mensajes, compartir archivos y colaborar. Existen varios tipos de espacios:

  • Los mensajes directos (MD) son conversaciones entre dos usuarios o un usuario y una app de Chat.
  • Los chats en grupo son conversaciones entre tres o más usuarios y Apps de Chat
  • Los espacios con nombre son lugares persistentes donde las personas envían mensajes, y colaborar.

Cuando configures un espacio, ten en cuenta lo siguiente:

  • El usuario que realiza la llamada (autenticado) se agrega automáticamente al espacio, por lo que no necesita especificar la membresía del usuario en la solicitud.
  • Cuando se crea un mensaje directo (MD), si hay un DM entre dos usuarios, y, luego, se devuelve el DM. De lo contrario, se crea un MD.
  • Cuando crees un chat en grupo, si ninguna de las membresías proporcionadas en la solicitud se agreguen correctamente al chat en grupo (por ejemplo, si hay un problema con los permisos) y, luego, Es posible que se cree un chat en grupo vacío (incluido solo el usuario que realiza la llamada).
  • No puedes configurar espacios con respuestas en múltiples conversaciones ni agregar personas fuera de tu en Google Workspace.
  • Se proporcionaron membresías duplicadas (incluido el usuario que llama) en la solicitud. en lugar de generar un error de solicitud.

Requisitos previos

Python

Node.js

Configura un espacio

Para configurar un espacio, pasa lo siguiente en la solicitud:

  • Especifica el permiso de autorización chat.spaces.create o chat.spaces.
  • Llama al Método setup en el recurso Space.
  • Para agregar un usuario humano como miembro del espacio, especifica users/{user}, en el que {user} es el {person_id} de la person de la API de People o el ID de un user en la API de Directory. Por ejemplo, si la persona de la API de People resourceName es people/123456789, puedes agregar el usuario al espacio incluida una membresía con users/123456789 como member.name.
  • Para agregar un grupo como miembro del espacio, especifica groups/{group}, donde {group} es el ID del grupo para el que quieres crear la membresía. El ID del grupo se puede se recuperarán con la API de Cloud Identity. Por ejemplo, si la API de Cloud Identity muestra un grupo con el nombre groups/123456789 y, luego, establece membership.groupMember.name a groups/123456789. Los Grupos de Google no se pueden a un chat en grupo o MD, pero solo a un espacio con nombre.
  • Para crear un MD entre el usuario que realiza la llamada y otra persona usuario, especifica la membresía del usuario humano en tu solicitud.
  • Para crear un MD entre el usuario que realiza la llamada y la app que realiza la llamada, configura Space.singleUserBotDm a true y no se especifica ninguna membresía. Puedes solo usarás este método para configurar un MD con la app que realiza la llamada. Para agregar la llamada como miembro de un espacio o un DM existente entre dos usuarios humanos, consulta crea una membresía.

En el siguiente ejemplo, se crea un espacio con nombre y membresías para él para un grupo y tres usuarios humanos (incluidos el usuario autenticado y dos otros usuarios especificados).

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_space_setup.py.

  2. Incluye el siguiente código en chat_space_setup.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.spaces.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then sets up a Chat space by creating a space and adding members.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().setup(

      # Details about the space to set up.
      body = {

        # Attributes of the space to set up, like space type and display name.
        'space': {

            # To set up a named space, set spaceType to SPACE.
            'spaceType': 'SPACE',

            # The user-visible name of the space
            'displayName': 'API-setup'
        },

        # The users and groups to add to the space.
        #
        # The authenticated user is automatically added to the space,
        # and doesn't need to be specified in the memberships array.
        'memberships': [
            {
              'member': {
                'name':'users/123456789',
                'type': 'HUMAN'
              }
            },
            {
              'member': {
                'name':'users/987654321',
                'type': 'HUMAN'
              }
            },
            {
              'groupMember': {
                'name': 'groups/11223344'
              }
            }
        ]
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

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

    python3 chat_space_setup.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado setup-space.js.

  2. Incluye el siguiente código en setup-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Sets up a new Chat space with users.
* @return {!Promise<!Object>}
*/
async function setupSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.create',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.setup({
    requestBody: {
      space: {
        spaceType: 'SPACE',
        displayName: 'API-made',
      },
      memberships: [
        {member: {name: 'users/123456789', type: 'HUMAN'}},
        {member: {name: 'users/987654321', type: 'HUMAN'}},
        {groupMember: {name: 'groups/11223344'}},
      ]
    }
  });
}

setupSpace().then(console.log);

  3. En tu directorio de trabajo, ejecuta la muestra:

    node setup-space.js

Un espacio de chat con nombre con un grupo y tres usuarios humanos, incluido el usuario autenticado.

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