Cómo obtener detalles sobre un espacio (original) (raw)

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, su descripción y sus lineamientos.

Si eres administrador de Google Workspace, puedes llamar al método get() para recuperar detalles sobre cualquier espacio de tu organización de Google Workspace.

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 entre un usuario y una app de Chat.
• Los chats grupales 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, comparten archivos y colaboran.

La autenticación con autenticación de la app permite que una app de Chat obtenga detalles sobre un espacio del que es miembro. La autenticación con autenticación de usuarios te permite obtener los espacios a los que tiene acceso el usuario autenticado, ya sea como miembro del espacio o como administrador de Google Workspace.

Requisitos previos

Node.js

• Una cuenta de Google Workspace para empresas o Enterprise 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, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Node.js.
  • Crea credenciales de acceso según cómo quieras autenticar tu solicitud a la API de Google Chat:
    * Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    * Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.
• Un espacio de Google Chat en el que el usuario autenticado o la app de Chat que realiza la llamada es miembro. Para autenticarte como la app de Chat, agrega la app de Chat al espacio.

Python

• Una cuenta de Google Workspace para empresas o Enterprise 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, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Python.
  • Crea credenciales de acceso según cómo quieras autenticar tu solicitud a la API de Google Chat:
    * Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    * Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.
• Un espacio de Google Chat en el que el usuario autenticado o la app de Chat que realiza la llamada es miembro. Para autenticarte como la app de Chat, agrega la app de Chat al espacio.

Java

• Una cuenta de Google Workspace para empresas o Enterprise 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, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Java.
  • Crea credenciales de acceso según cómo quieras autenticar tu solicitud a la API de Google Chat:
    * Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    * Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.
• Un espacio de Google Chat en el que el usuario autenticado o la app de Chat que realiza la llamada es miembro. Para autenticarte como la app de Chat, agrega la app de Chat al espacio.

Apps Script

• Una cuenta de Google Workspace para empresas o Enterprise 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, un ícono y una descripción para tu app de Chat.
  • Crea un proyecto independiente de Apps Script y activa el servicio de Chat avanzado.
  • En esta guía, debes usar la autenticación de usuario o de app. Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio. Para conocer los pasos, consulta Cómo autenticar y autorizar como una app de Google Chat.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.
• Un espacio de Google Chat en el que el usuario autenticado o la app de Chat que realiza la llamada es miembro. Para autenticarte como la app de Chat, agrega la app de Chat al espacio.

Obtén un espacio

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

• Un permiso de autorización:
  • Con la autenticación de usuarios, especifica el alcance de autorización chat.spaces.readonly o chat.spaces.
  • Con la autenticación de la app, especifica el alcance de autorización chat.bot o el alcance chat.app.spaces. El alcance de chat.app.spaces está disponible en la versión preliminar para desarrolladores y requiere la aprobación del administrador una sola vez.
• Llama al método GetSpace() y pasa el name del espacio que se obtendrá. Obtén el nombre del espacio del recurso Space de Google Chat o de la URL de un espacio.

Obtén detalles del espacio como usuario

Sigue estos pasos para obtener detalles del espacio con autenticación de usuario:

Node.js

Python

Java

Apps Script

Para ejecutar este ejemplo, reemplaza SPACE_NAME por el ID del campo name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.

La API de Chat devuelve una instancia de Space que detalla el espacio especificado.

Obtén detalles del espacio como administrador de Google Workspace

Si eres administrador de Google Workspace, puedes llamar al método GetSpace para recuperar detalles sobre cualquier espacio de tu organización de Google Workspace.

Para llamar a este método como administrador de Google Workspace, haz lo siguiente:

• Llama al método con la autenticación del usuario y especifica un alcance de autorización que admita llamar al método con privilegios de administrador.
• En tu solicitud, especifica el parámetro de consulta useAdminAccess como true.

Para obtener más información y ejemplos, consulta Cómo administrar espacios de Google Chat como administrador de Google Workspace.

Obtén detalles del espacio como una app de Chat

Sigue estos pasos para obtener detalles del espacio con la autenticación de la app:

Node.js

Python

Java

Apps Script

Para ejecutar este ejemplo, reemplaza SPACE_NAME por el ID del campo name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.

La API de Chat devuelve una instancia de Space que detalla el espacio especificado.

Limitaciones y consideraciones

• Los campos accessSettings, predefinedPermissionSettings y permissionSettings solo se completan cuando te autenticas con el alcance chat.app.spaces, y la configuración de permisos se limita a los espacios que creó la app de Chat.
• Crea un espacio.
• Configura un espacio.
• Crea listas de espacios.
• Actualiza un espacio.
• Borra un espacio.
• Busca un espacio de mensajes directos.