Este documento contiene información de autorización y autenticación específica de la API de Google Workspace Events. Antes de leer este documento, asegúrate de leer la información general sobre autenticación y autorización de Google Workspace en Más información sobre la autenticación y la autorización.
Configura OAuth 2.0 para la autorización
Configura la pantalla de consentimiento de OAuth y elige permisos para definir qué información se muestra a los usuarios y revisores de apps, y registra tu app para que puedas publicarla más adelante.
Permisos de la API de Google Workspace Events
Para definir el nivel de acceso que se otorga a tu app, debes identificar y declarar los permisos de autorización. Un permiso de autorización es una cadena de URI de OAuth 2.0 que contiene el nombre de la app de Google Workspace, el tipo de datos a los que accede y el nivel de acceso. Los permisos son las solicitudes de tu app para trabajar con datos de Google Workspace, incluidos los datos de la Cuenta de Google de los usuarios.
Cuando se instala tu app, se le solicita al usuario que valide los permisos que usa la app. En general, debes elegir el permiso más específico posible y evitar solicitar permisos que tu app no requiera. Los usuarios otorgan acceso con mayor facilidad a permisos limitados y descritos con claridad.
La API de Google Workspace Events usa permisos de las aplicaciones de Google Workspace que admiten suscripciones. Si tu app ya usa los permisos necesarios para tu suscripción, no es necesario que agregues permisos para usar la API de Google Workspace Events. Si agregas permisos, elige el menos sensible que permita que tu app funcione. Para obtener detalles sobre las categorías de alcance, consulta Categorías de alcance.
En la siguiente tabla, se enumeran los permisos compatibles con la API de Google Workspace Events:
| Código de alcance | Descripción | Uso | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Permite que las apps de Chat vean los chats y envíen mensajes. Otorga acceso a todas las funciones disponibles para las apps de Chat. | No sensible | ||
https://www.googleapis.com/auth/chat.memberships |
Ver, agregar o quitar miembros de las conversaciones de Chat | Sensible |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Ver a los miembros de las conversaciones de Chat | Sensible |
||
https://www.googleapis.com/auth/chat.app.memberships |
Ver, agregar, actualizar y quitar miembros de conversaciones y espacios en Chat como una app de Chat Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Sensible |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Ver a los miembros de las conversaciones y los espacios de Google Chat como una app de Chat Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Sensible |
||
https://www.googleapis.com/auth/chat.spaces |
Crear conversaciones y espacios, y visualizar o actualizar metadatos (incluida la configuración del historial) en Chat | Sensible | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver chat y espacios en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.app.spaces |
Crear conversaciones y espacios, y visualizar o actualizar metadatos (incluida la configuración del historial) en Chat como una app de Chat Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Sensible |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Ver metadatos (incluida la configuración del historial) en Google Chat como una app de Chat Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Sensible |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Ver, agregar y borrar reacciones a los mensajes en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Ver las reacciones a un mensaje en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.messages |
Ver, redactar, enviar, actualizar y borrar mensajes, así como agregar, ver y borrar reacciones a los mensajes. | Restringido | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Ver mensajes y reacciones en Chat | Restringido |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Ver mensajes y reacciones en Chat como una app de Chat Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Restringido |
||
https://www.googleapis.com/auth/chat.users.readstate |
Ver y actualizar el estado de lectura de los usuarios en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Ver el estado de lectura de los usuarios en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.users.availability |
Ver y cambiar el estado de disponibilidad en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Ver el estado de disponibilidad en Chat | Sensible |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Ver los metadatos de todos los espacios y las conversaciones de Google Chat en toda tu organización de Google Workspace, incluso cuando la app de Chat no es miembro Este permiso solo se admite con las suscripciones de clientes. Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Restringido | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Ver a todos los miembros de los espacios y las conversaciones de Google Chat en toda tu organización de Google Workspace, incluso cuando la app de Chat no es miembro Este permiso solo se admite con las suscripciones de clientes. Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Restringido | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Ver todos los mensajes y las reacciones en tu organización de Google Workspace, incluso cuando la app de Chat no es miembro de un espacio o una conversación Este permiso solo se admite con las suscripciones de clientes. Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Restringido | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Ver la última hora de lectura de mensajes de todos los usuarios en todos los espacios y conversaciones en tu organización de Google Workspace, incluso cuando la app de Chat no es miembro Este permiso solo se admite con las suscripciones de clientes. Requiere la aprobación del administrador. Este permiso solo admite la autenticación de apps con cuentas de servicio. No puedes autenticarte con credenciales de usuario ni con la delegación para todo el dominio con este permiso. |
Restringido | ||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Crear archivos nuevos de Drive o modificar los existentes que abras con una app o que el usuario comparta con una app mientras usa la API de Google Picker o el selector de archivos de la app | No sensible | ||
https://www.googleapis.com/auth/drive |
Ver y administrar todos tus archivos de Drive | Restringido | ||
https://www.googleapis.com/auth/drive.readonly |
Ver y descargar todos tus archivos de Drive | Restringido | ||
https://www.googleapis.com/auth/drive.metadata |
Permite ver y administrar los metadatos de los archivos que almacenaste en Drive. | Restringido | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Permite ver los metadatos de los archivos de tu unidad de Drive. | Restringido | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permite que las apps creen, modifiquen y lean metadatos sobre los espacios de reunión creados por tu app. | Sensible |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permite que las apps lean metadatos sobre cualquier espacio de reunión al que tenga acceso el usuario. | Sensible |
||
La columna Uso de la tabla anterior indica la sensibilidad de cada permiso:
No sensibles: Estos permisos proporcionan el alcance más pequeño de acceso de autorización y solo requieren una verificación de app básica. Para obtener información sobre este requisito, consulta los requisitos de verificación.
Sensibles: Estos permisos proporcionan acceso a datos específicos del usuario de Google que el usuario autoriza para tu app. Requiere que pases por una verificación adicional de la app. Para obtener información sobre este requisito, consulta Requisitos de los permisos sensibles y restringidos.
Restringidos: Estos permisos proporcionan un acceso amplio a los datos del usuario de Google y requieren que realices un proceso de verificación de permisos restringidos. Para obtener información sobre este requisito, consulta la Política de Datos del Usuario de los Servicios de la API de Google y los Requisitos Adicionales para Permisos de API Específicos. Si almacenas datos de permisos restringidos en servidores (o los transmites), debes someterte a una evaluación de seguridad.
Si tu app requiere acceso a otras APIs de Google, también puedes agregar esos permisos. Para obtener más información sobre los permisos de las APIs de Google, consulta Usa OAuth 2.0 para acceder a las APIs de Google.
Para obtener más información sobre los permisos de OAuth 2.0 específicos, consulta Permisos de OAuth 2.0 para las APIs de Google.
Verificación de OAuth
Es posible que el uso de ciertos permisos de OAuth requiera que tu app pase por el Centro de ayuda de verificación de apps de OAuth. Lee las Preguntas frecuentes sobre las apps de OAuth para determinar cuándo tu app debe someterse a la verificación y qué tipo de verificación se requiere. Consulta también las Condiciones del Servicio de Drive.
Tipos de autenticación obligatoria
En esta sección, se explican los tipos de autenticación que se requieren o se admiten, y se proporcionan los permisos admitidos para cada método de la API de Google Workspace Events.
En el caso de las suscripciones a eventos de Chat, la
API de Google Workspace Events admite la autenticación de usuarios y de apps para llamar
a algunos de sus métodos. Si un método de la API admite ambas credenciales, el tipo de
credencial que se use en la llamada afectará el resultado que se devuelva. Por ejemplo, si llamas al método subscriptions.list con la autenticación del usuario, la API devuelve una lista de suscripciones a las que puede acceder el usuario autenticado. Si usas la autenticación de la app, la API
devuelve una lista de suscripciones a las que puede acceder la app. Para obtener más información sobre
los tipos de autenticación de Chat, consulta Autentica y autoriza
apps de Chat y solicitudes a la API de Chat.
En la siguiente tabla, se muestran los permisos y los tipos de autenticación que se requieren o admiten para cada método de la API de Google Workspace Events:
| Método | Se requiere o se admite la autenticación del usuario | Autenticación de apps compatible (solo para apps de Chat) | Permisos de autorización admitidos | |
|---|---|---|---|---|
| Crea una suscripción | — |
Con la autenticación de usuarios, se requiere un permiso compatible para cada tipo de evento:
Con la autenticación de la app y la aprobación del administrador (solo para las apps de Google Chat), se requiere un permiso compatible para cada tipo de evento:
|
||
| Obtén una suscripción |
Con la autenticación de usuarios, este método requiere un permiso que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Chat):
|
|||
| Enumera las suscripciones |
Con la autenticación de usuarios, este método requiere un permiso que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Chat):
|
|||
| Actualiza una suscripción | — |
Con la autenticación de usuarios, se requiere un permiso compatible para cada tipo de evento:
Con la autenticación de la app y la aprobación del administrador (solo para las apps de Google Chat), se requiere un permiso compatible para cada tipo de evento:
|
||
| Cómo reactivar una suscripción | — |
Con la autenticación de usuarios, se requiere un permiso compatible para cada tipo de evento:
Con la autenticación de apps y la aprobación del administrador (solo para apps de Chat), se requiere un permiso compatible para cada tipo de evento:
|
||
| Borra una suscripción |
Con la autenticación de usuarios, este método requiere un permiso que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Chat):
|
|||
Permisos por tipo de evento
Cuando llamas a la API de Google Workspace Events con la autenticación de usuario, debes especificar uno o más permisos que correspondan a los tipos de eventos de la suscripción.
En la siguiente tabla, se muestran los permisos de autorización que se admiten para cada tipo de evento:
| Eventos | Tipos de eventos | Alcances de autorización admitidos | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| Se publica o actualiza un mensaje. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Se agrega o borra una reacción, o se cambian varias reacciones. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Se crea, actualiza o quita una membresía, o se modifican varias membresías. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Se actualiza o borra un espacio. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Se actualiza el estado de lectura del espacio o el estado de lectura de la conversación de un usuario. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Se actualiza una disponibilidad. |
|
Con la autenticación de usuarios, se aplica lo siguiente:
|
||||||
| Drive | ||||||||
| Se crea, modifica, mueve, borra, cambia de nombre, envía a la papelera o quita de la papelera un archivo. |
|
|
||||||
| Se crea o resuelve una propuesta de acceso en un archivo. |
|
|
||||||
| Se cancela, completa, crea o restablece una aprobación, o bien se cambian los revisores o estos responden en un archivo. |
|
|
||||||
| Se crea, borra, edita, vuelve a abrir o resuelve un comentario en un archivo. |
|
|
||||||
| Se crea, borra o edita una respuesta en un archivo. |
|
|
||||||
| Se crea, borra o edita un permiso en un archivo. |
|
|
||||||
| Meet | ||||||||
| Se inicia o finaliza una conferencia. |
|
|
||||||
| Un participante se une a una conferencia o la abandona. |
|
|
||||||
| Se generó una grabación. |
|
|
||||||
| Se generó una transcripción. |
|
|
||||||