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 sobre un espacio, como su nombre visible, una descripción y lineamientos.
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 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 esta tiene acceso en Google Chat (por ejemplo, espacios de los que la app es miembro). La autenticación con la autenticación de usuario te permite obtener los 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 tu interfaz de línea de comandos:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- 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. La obtención de un espacio admite los siguientes métodos de autenticación:
- Autenticación de usuarios con el alcance de autorización
chat.spaces.readonly
ochat.spaces
. - Autenticación de la app con el alcance de autorización
chat.bot
.
- Autenticación de usuarios con el alcance de autorización
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. La obtención de un espacio admite los siguientes métodos de autenticación:
- Autenticación de usuarios con el alcance de autorización
chat.spaces.readonly
ochat.spaces
. - Autenticación de la app con el alcance de autorización
chat.bot
.
- Autenticación de usuarios con el alcance de autorizació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 usuarios, especifica el alcance de la autorizaciónchat.spaces.readonly
ochat.spaces
. - Llama al método
get
en el recursoSpace
y pasa elname
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 usuario
A continuación, te mostramos cómo obtener detalles del espacio con la autenticación de usuarios:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_space_get_user.py
. Incluye el siguiente código en
chat_space_get_user.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.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()
En el código, reemplaza
SPACE
por un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat o desde la URL de un espacio.En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_space_get_user.py
Node.js
- En el directorio de trabajo, crea un archivo llamado
get-space.js
. Incluye el siguiente código en
get-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Gets details about a Chat space by name. * @return {!Object} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
En el código, reemplaza
SPACE
por un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu directorio de trabajo, ejecuta la muestra:
node get-space.js
La API de Chat muestra una instancia de Space
que 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 la app:
Python
- En el directorio de trabajo, crea un archivo llamado
chat_space_get_app.py
. Incluye el siguiente código en
chat_space_get_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # 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)
En el código, reemplaza
SPACE
por un nombre de espacio, que puedes obtener del métodospaces.list()
en la API de Chat o desde la URL de un espacio.En el directorio de trabajo, compila y ejecuta la muestra:
python3 chat_space_get_app.py
Node.js
- En el directorio de trabajo, crea un archivo llamado
app-get-space.js
. Incluye el siguiente código en
app-get-space.js
:const chat = require('@googleapis/chat'); /** * Gets details about a Chat space by name. * @return {!Promise<!Object>} */ async function getSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.get({name: 'spaces/SPACE'}); } getSpace().then(console.log);
En el código, reemplaza
SPACE
por un nombre de espacio, que puedes obtener del métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu directorio de trabajo, ejecuta la muestra:
node app-get-space.js
La API de Chat muestra una instancia de Space
que detalla el espacio especificado.
Temas relacionados
- Crea un espacio.
- Configura un espacio.
- Crea listas de espacios.
- Actualiza un espacio.
- Cómo borrar un espacio
- Busca un espacio de mensaje directo.