En esta guía, se explica cómo usar el método get
en un recurso Space
de la
La API de Google Chat para ver los detalles de un espacio, como su nombre visible, 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 Apps de Chat
- Los espacios con nombre son lugares persistentes donde las personas envían mensajes, y colaborar.
Autentica con autenticación de apps permite que una app de Chat obtenga espacios La app de Chat tiene acceso en Google Chat (por ejemplo, espacios a los que pertenece la app). Autentica con autenticación de usuarios te permite obtener espacios a los que tiene acceso el usuario autenticado.
Requisitos previos
Python
- Una empresa o empresa de Google Workspace con acceso a Google Chat.
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre. y la descripción de tu app de Chat.
- Instala el Python Biblioteca cliente de las APIs de Google
- Crea credenciales de acceso según cómo quieras autenticarte en tu API de Google Chat
solicitud:
- Sigue estos pasos para autenticarte como usuario de Chat:
crear un ID de cliente de OAuth
credenciales y las guarda como un archivo JSON llamado
client_secrets.json
a tu directorio local. - Para autenticarte como la app de Chat, sigue estos pasos:
crear cuenta de servicio
credenciales y las guarda como un archivo JSON llamado
credentials.json
- Sigue estos pasos para autenticarte como usuario de Chat:
crear un ID de cliente de OAuth
credenciales y las guarda como un archivo JSON llamado
- Elige un alcance de autorización en función de si deseas autenticarte como usuario o App de Chat
Node.js
- Una empresa o empresa de Google Workspace con acceso a Google Chat.
- Configura tu entorno:
- Crea un proyecto de Google Cloud
- Configura la pantalla de consentimiento de OAuth.
- Habilita y configura la API de Google Chat con un nombre. y la descripción de tu app de Chat.
- Instala el Node.js Biblioteca cliente de las APIs de Google
- Crea credenciales de acceso según cómo quieras autenticarte en tu API de Google Chat
solicitud:
- Sigue estos pasos para autenticarte como usuario de Chat:
crear un ID de cliente de OAuth
credenciales y las guarda como un archivo JSON llamado
client_secrets.json
a tu directorio local. - Para autenticarte como la app de Chat, sigue estos pasos:
crear cuenta de servicio
credenciales y las guarda como un archivo JSON llamado
credentials.json
- Sigue estos pasos para autenticarte como usuario de Chat:
crear un ID de cliente de OAuth
credenciales y las guarda como un archivo JSON llamado
- Elige un alcance de autorización en función de si deseas autenticarte como usuario o App de Chat
Obtener un espacio
Para obtener un espacio en Google Chat, pasa lo siguiente en tu solicitud:
- Con
autenticación de apps,
especifica el permiso de autorización
chat.bot
. Con autenticación de usuarios, especifica el permiso de autorizaciónchat.spaces.readonly
ochat.spaces
. - Llama al
Método
get
en la RecursoSpace
, pasando elname
del espacio para obtener. Obtén el nombre del espacio de los espacios recurso de Google Chat o desde la URL de un espacio.
Cómo obtener detalles del espacio con la autenticación de usuario
A continuación, te indicamos cómo obtener los detalles del espacio con 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 que puedes obtener de la Métodospaces.list
en la API de Chat o desde la URL de un espacio.En tu 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 que puedes obtener de la 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 devuelve una instancia de
Space
que detalla el espacio especificado
Cómo obtener detalles del espacio con la autenticación de apps
A continuación, te indicamos cómo obtener los detalles del espacio con 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 que puedes obtener de la Métodospaces.list()
en desde la API de Chat o desde la URL de un espacio.En tu 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 que puedes obtener de la 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 devuelve una instancia de
Space
que detalla el espacio especificado.
Temas relacionados
- Crea un espacio.
- Configura un espacio.
- Crea listas de espacios.
- Actualiza un espacio.
- Borra un espacio.
- Busca un espacio para mensaje directo.