Invitar o agregar a un usuario, un Grupo de Google o una app de Google Chat a un espacio

En esta guía, se explica cómo usar el método create en el recurso membership de la API de Google Chat para invitar o agregar a un usuario, un Grupo de Google o una app de Chat a un espacio que también se conoce como crear una membresía. Cuando creas una membresía, si el miembro especificado tiene desactivada su política de aceptación automática, se lo invitará y deberá aceptar la invitación al espacio antes de unirse. De lo contrario, si creas una membresía, se agrega al miembro directamente al espacio especificado.

El recurso Membership representa si se invita a un usuario humano o a una app de Google Chat a un espacio, si forma parte de él o si está ausente.

Requisitos previos

Python

  • Python 3.6 o superior
  • La herramienta de administración de paquetes pip

  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada. Para conocer los pasos, consulta Compila una app de Google Chat.

  • La autorización configurada para la app de Chat. Crear una membresía requiere la autenticación del usuario con el permiso de autorización chat.memberships o chat.memberships.app.

Node.js

  • Node.js y npm

  • Las bibliotecas cliente de Google más recientes para Node.js. Para instalarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada. Para conocer los pasos, consulta Compila una app de Google Chat.

  • La autorización configurada para la app de Chat. Crear una membresía requiere la autenticación del usuario con el permiso de autorización chat.memberships o chat.memberships.app.

Cómo invitar o agregar un usuario a un espacio

Para invitar o agregar un usuario a un espacio, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.memberships.
  • Llama al método create en el recurso membership.
  • Establece parent en el nombre de recurso del espacio en el que se creará la membresía.
  • Configura member como users/{user}, en el que {user} es la persona para la que quieres crear la membresía, y puede ser una de las siguientes opciones:
    • El ID de la persona en la API de People Por ejemplo, si la persona resourceName de la API de People es people/123456789, establece membership.member.name en users/123456789.
    • El ID del usuario en la API de Directory.
    • La dirección de correo electrónico del usuario. Por ejemplo, users/222larabrown@gmail.com o users/larabrown@cymbalgroup.com. Si el usuario usa una Cuenta de Google o pertenece a otra organización de Google Workspace, debes usar su dirección de correo electrónico.

En el siguiente ejemplo, se agrega un usuario a un espacio:

Python

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

  2. Incluye el siguiente código en chat_membership_user_create.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.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds a user to a Chat space by creating a membership.
    '''

    # 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().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which user the membership is for.
        body = {
          'member': {
            'name':'users/USER',
            'type': 'HUMAN'
          }
        }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre del espacio, que puedes obtener del método spaces.list en la API de Chat o desde la URL de un espacio.

    • USER: Es un ID de usuario.

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

    python3 chat_membership_user_create.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado add-user-to-space.js.

  2. Incluye el siguiente código en add-user-to-space.js:

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

/**
* Adds the user to the Chat space.
* @return {!Promise<!Object>}
*/
async function addUserToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

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

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

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/USER', type: 'HUMAN'}}
  });
}

addUserToSpace().then(console.log);

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre del espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

    • USER: Es un ID de usuario.

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

    node add-user-to-space.js

La API de Chat muestra una instancia de membership que detalla la membresía de usuario que se creó.

Invita o agrega un Grupo de Google a un espacio

Para invitar o agregar un Grupo de Google a un espacio, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.memberships.
  • Llama al método create en el recurso membership.
  • Establece parent en el nombre de recurso del espacio en el que se creará la membresía.
  • Establece groupMember en groups/{group}, en el que {group} es el ID del grupo para el que deseas crear la membresía. El ID del grupo se puede recuperar con la API de Cloud Identity. Por ejemplo, si la API de Cloud Identity muestra un grupo con el nombre groups/123456789, configura membership.groupMember.name como groups/123456789.

No se pueden agregar Grupos de Google a un chat en grupo ni a un mensaje directo, sino solo a un espacio con nombre. En el siguiente ejemplo, se agrega un grupo a un espacio con nombre:

Python

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

  2. Incluye el siguiente código en chat_membership_group_create.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.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds a group to a Chat space by creating a membership.
    '''

    # 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().members().create(

        # The named space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which group the membership is for.
        body = {
          'groupMember': {
            'name':'groups/GROUP',
          }
        }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre del espacio, que puedes obtener del método spaces.list en la API de Chat o desde la URL de un espacio.

    • GROUP: Es un ID de grupo.

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

    python3 chat_membership_group_create.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado add-group-to-space.js.

  2. Incluye el siguiente código en add-group-to-space.js:

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

/**
* Adds the group to the Chat space.
* @return {!Promise<!Object>}
*/
async function addUserToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships',
  ];

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

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

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {groupMember: {name: 'groups/GROUP'}}
  });
}

addUserToSpace().then(console.log);

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el nombre del espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

    • GROUP: Es un ID de grupo.

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

    node add-group-to-space.js

La API de Chat muestra una instancia de membership que detalla la membresía del grupo que se creó.

Agrega una app de Chat a un espacio

Una app de Chat no puede agregar otra app como miembro a un espacio. Para agregar una app de Chat a un espacio o un mensaje directo entre dos usuarios humanos, pasa lo siguiente en la solicitud:

  • Especifica el alcance de la autorización chat.memberships.app.
  • Llama al método create en el recurso membership.
  • Establece parent en el nombre de recurso del espacio en el que se creará la membresía.
  • Configura member como users/app, un alias que representa la app que llama a la API de Chat.

En el siguiente ejemplo, se agrega una app de Chat a un espacio:

Python

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

  2. Incluye el siguiente código en chat_membership_app_create.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.memberships.app"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then adds the Chat app to a Chat space.
    '''

    # 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().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Set the Chat app as the entity that gets added to the space.
        # 'app' is an alias for the Chat app calling the API.
        body = {
            'member': {
              'name':'users/app',
              'type': 'BOT'
            }
        }

    ).execute()

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

if __name__ == '__main__':
    main()

  3. En el código, reemplaza SPACE por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

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

    python3 chat_membership_app_create.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado add-app-to-space.js.

  2. Incluye el siguiente código en add-app-to-space.js:

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

/**
* Adds the app to the Chat space.
* @return {!Promise<!Object>}
*/
async function addAppToSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.memberships.app',
  ];

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

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

  return await chatClient.spaces.members.create({
    parent: 'spaces/SPACE',
    requestBody: {member: {name: 'users/app', type: 'BOT'}}
  });
}

addAppToSpace().then(console.log);

  3. En el código, reemplaza SPACE por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

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

    node add-app-to-space.js

La API de Chat muestra una instancia de membership que detalla la membresía de la app que se creó.