Cómo obtener detalles sobre un espacio

En esta guía, se explica cómo usar el método get en un recurso Space de la API de Google Chat para ver detalles de un espacio, como su nombre visible, descripción y lineamientos.

El recurso Space representa un lugar en el que 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 las apps de chat.
  • Los espacios con nombre son lugares persistentes en los que las personas envían mensajes, comparten archivos y colaboran.

La autenticación con la autenticación de la app permite que una app de Chat obtenga espacios a los que tiene acceso en Google Chat (por ejemplo, espacios a los que pertenece la app). La autenticación con autenticación de usuario te permite obtener espacios a los que tiene acceso el usuario autenticado.

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 obtención de un espacio admite los siguientes métodos de autenticación:

Obtener un espacio

Para obtener un espacio en Google Chat, pasa lo siguiente en tu solicitud:

  • Con la autenticación de la app, especifica el alcance de la autorización chat.bot. Con la autenticación de usuario, especifica el alcance de la autorización chat.spaces.readonly o chat.spaces.
  • Llama al método get en el recurso Space y pasa el name del espacio que deseas obtener. Obtén el nombre del espacio del recurso de espacios de Google Chat o de la URL de un espacio.

Obtén detalles del espacio con la autenticación de usuarios

A continuación, te mostramos cómo obtener detalles del espacio con la autenticación de usuarios:

Python

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

  2. Incluye el siguiente código en chat_space_get_user.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.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets details about a specified 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().get(

          # The space to get.
          #
          # Replace SPACE with a space name.
          # Obtain the space name from the spaces resource of Chat API,
          # or from a space's URL.
          name='spaces/SPACE'

      ).execute()

    # Prints details about the space.
    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_space_get_user.py

La API de Chat muestra una instancia de Space en la que se detalla el espacio especificado.

Obtén detalles del espacio con la autenticación de la app

A continuación, te mostramos cómo obtener detalles del espacio con la autenticación de apps:

Python

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

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

    from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

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

    # The space to get.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    name='spaces/SPACE'

).execute()

print(result)

  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 desde la URL de un espacio.

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

    python3 chat_space_get_app.py

La API de Chat muestra una instancia de Space en la que se detalla el espacio especificado.