Invita o agrega a un usuario 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 un usuario o una app de Chat a un espacio, también conocido como creación de una membresía. Cuando se crea una membresía, si el miembro especificado tiene desactivada la política de aceptación automática, se lo invita y debe aceptar la invitación al espacio antes de unirse. De lo contrario, si creas una membresía, el miembro se agregará directamente al espacio especificado.

El recurso Membership representa si un usuario humano o una app de Google Chat están invitados a un espacio, forman parte de él o no están presentes.

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 la interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Una app de Chat publicada. Para crear y publicar una app de Chat, consulta Cómo compilar una app de Google Chat.

  • Autorización configurada para la app de Chat. La creación de 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 la solicitud:

  • Especifica el alcance de la autorización de chat.memberships.
  • Llama al método create en el recurso membership.
  • Establece parent en el nombre del recurso del espacio en el que se creará la membresía.
  • Establece member en users/{user}, en el que {user} es la persona para la que deseas crear membresía y es una de las siguientes opciones:
    • Es el ID de la persona en la API de People. Por ejemplo, si la persona resourceName de la API de Personas es people/123456789, configura membership.member.name como users/123456789.
    • Es 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:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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 un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.

    • USER: Es un ID de usuario.

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

    python3 chat_membership_user_create.py

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

Cómo agregar 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 de chat.memberships.app.
  • Llama al método create en el recurso membership.
  • Establece parent en el nombre del recurso del espacio en el que se creará la membresía.
  • Configura member como users/app; un alias que representa a 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:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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 el nombre de un espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.

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

    python3 chat_membership_app_create.py

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