En este documento, se incluye 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 de 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 otorgado a tu app, debes identificar y declarar los alcances de autorización. Un alcance 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 los datos de Google Workspace, incluidos los datos de las Cuentas de Google de los usuarios.
Cuando se instala tu app, se le solicita al usuario que valide los permisos que esta usa. Por lo 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.
Cuando sea posible, te recomendamos que uses permisos no sensibles, ya que otorgan acceso por archivo y limitan el acceso a la funcionalidad específica que necesita una app.
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 adicionales para usar la API de Google Workspace Events.
En la siguiente tabla, se muestran los permisos compatibles para 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 Google Chat vean chats y envíen mensajes. Otorga acceso a todas las funciones disponibles para las apps de Chat. | No sensibles | ||
https://www.googleapis.com/auth/chat.memberships |
Ver, agregar y quitar miembros de las conversaciones de Google Chat | Sensible |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Ver a los miembros en las conversaciones de Google Chat | Sensible |
||
https://www.googleapis.com/auth/chat.spaces |
Crear conversaciones y espacios, y ver o actualizar metadatos (incluida la configuración del historial) en Google Chat | Sensible | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver chat y espacios en Google Chat | Sensible |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
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 |
Puede 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 Google Chat | 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 que creó la app. | Sensible |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permite que las apps lean metadatos sobre cualquier espacio de reunión al que el usuario tenga acceso. | Sensible |
||
La columna Uso en la tabla anterior indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos permisos proporcionan el permiso de acceso de autorización más pequeño y solo requieren una verificación básica de la app. Para obtener información sobre este requisito, consulta Pasos para prepararte para la verificación.
Sensibles: Estos permisos proporcionan acceso a datos de usuarios de Google específicos que el usuario autoriza para tu app. Para ello, debes realizar una verificación adicional de la app. Para obtener información sobre este requisito, consulta Pasos para las apps que solicitan permisos sensibles.
Restringido: 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 Específicos de la API. Si almacenas (o transmites) datos de alcance restringido en servidores, debes realizar 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 específicos de OAuth 2.0, consulta Permisos de OAuth 2.0 para las APIs de Google.
Verificación de OAuth
El uso de ciertos alcances de OAuth puede requerir que tu app siga el proceso de verificación de OAuth de Google. Lee las Preguntas frecuentes sobre la verificación de la API de OAuth para determinar cuándo se debe verificar tu app y qué tipo de verificación se requiere. Consulta también las Condiciones del Servicio Adicionales de Google Drive.
Tipos de autenticación requerida
En esta sección, se explica qué tipos de autenticación son obligatorios o compatibles, y se proporcionan los permisos compatibles para cada método de la API de Eventos de Google Workspace.
En el caso de las suscripciones a eventos de Google Chat, la API de Google Workspace Events admite la autenticación del usuario y de la app para llamar a algunos de sus métodos. Si un método de API admite ambas credenciales, el tipo de credencial que se usa en la llamada afecta el resultado que se muestra. Por ejemplo, si llamas al método subscriptions.list() con la autenticación del usuario, la API muestra una lista de suscripciones a las que puede acceder el usuario autenticado. Si usas la autenticación de apps, la API muestra 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 las solicitudes a la API de Google Chat y la app 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 Eventos de Google Workspace:
| Método | Autenticación del usuario requerida o admitida | Se admite la autenticación de apps (solo para apps de Google Chat) | Permisos de autorización admitidos | |
|---|---|---|---|---|
| Crea una suscripción | — |
Requiere un alcance compatible para cada tipo de evento:
|
||
| Obtén una suscripción |
Con la autenticación del usuario, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Google Chat):
|
|||
| Enumera las suscripciones |
Con la autenticación del usuario, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Google Chat):
|
|||
| Actualiza una suscripción | — |
Requiere un alcance compatible para cada tipo de evento:
|
||
| Cómo reactivar una suscripción | — |
Requiere un alcance compatible para cada tipo de evento:
|
||
| Cómo borrar una suscripción |
Con la autenticación del usuario, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de apps (solo para apps de Google Chat):
|
|||
Alcances por tipo de evento
Cuando llames a la API de Google Workspace Events con la autenticación del 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 compatibles para cada tipo de evento:
| Eventos | Tipos de eventos | Permisos de autorización admitidos | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Se publica o actualiza un mensaje. |
|
|
||||||
| Se agrega o borra una reacción, o se cambian varias reacciones. |
|
|
||||||
| Se crea, actualiza o quita una membresía, o se cambian varias membresías. |
|
|
||||||
| Se actualiza o borra un espacio. |
|
|
||||||
| Google Meet | ||||||||
| Comienza o finaliza una conferencia. |
|
|
||||||
| Un participante se une a una conferencia o la abandona. |
|
|
||||||
| Se generó una grabación. |
|
|
||||||
| Se generó una transcripción. |
|
|
||||||