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 de autenticación y autorización de Google Workspace en Más información sobre la autenticación y la autorización.
Configurar OAuth 2.0 para la autorización
Configura la pantalla de consentimiento de OAuth y elige los alcances para definir la información que se muestra a los usuarios y revisores de la app, y registra tu app para que puedas publicarla más tarde.
Permisos de la API de Google Workspace Events
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los permisos de autorización. Un alcance de autorización es una string de URI de OAuth 2.0 que contiene el nombre de la app de Google Workspace, a qué tipo de datos 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 esta usa. En general, debes elegir el alcance más específico posible y evitar solicitar permisos que tu app no requiere. Los usuarios otorgan acceso a permisos limitados y claramente descritos.
Cuando sea posible, te recomendamos que uses permisos no sensibles, ya que otorga un permiso de acceso por archivo y reduce el acceso a funciones específicas que necesita una app.
La API de Google Workspace Events usa permisos de aplicaciones de Google Workspace que admiten suscripciones. Si tu app ya usa los permisos necesarios para la suscripción, no necesitas agregar permisos adicionales para usar la API de Google Workspace Events.
En la siguiente tabla, se muestran los permisos compatibles con la API de Google Workspace Events:
| Código de permiso | 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 sensible | ||
https://www.googleapis.com/auth/chat.memberships |
Ver, agregar y quitar miembros de las conversaciones en Google Chat | Sensibles |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Ver a los miembros en las conversaciones de Google Chat | Sensibles |
||
https://www.googleapis.com/auth/chat.spaces |
Crear conversaciones y espacios, y ver o actualizar los metadatos (incluida la configuración del historial) en Google Chat | Sensible | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver el chat y los espacios en Google Chat | Sensibles |
||
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 |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Consulta, agrega y borra reacciones a los mensajes en Chat. | Restringido |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Vea las reacciones a un mensaje en Chat. | Restringido |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permite que las apps creen, modifiquen y lean metadatos sobre salas de reuniones creadas por tu app. | Sensibles |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permite que las apps lean metadatos sobre cualquier sala de reuniones a la que tenga acceso el usuario. | Sensibles |
||
En la columna Uso de la tabla anterior, se indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos alcances proporcionan el permiso más pequeño del acceso de autorización y solo requieren la verificación básica de la app. Para obtener información sobre este requisito, consulta Pasos de preparación para la verificación.
Sensibles: Estos permisos proporcionan acceso a datos específicos del usuario de Google autorizados por el usuario para tu app. Es necesario que realices una verificación adicional de la app. Si deseas obtener información sobre este requisito, consulta Pasos para las apps que solicitan alcances sensibles.
Restringido: Estos permisos proporcionan un acceso amplio a los datos del usuario de Google y requieren que pases por un proceso de verificación de permiso restringido. Para obtener información sobre este requisito, consulta Servicios de la API de Google: Política de datos del usuario y Requisitos adicionales para permisos específicos de API. Si almacenas datos de alcance restringido en servidores (o los transmites), debes realizar una evaluación de seguridad.
Si tu app requiere acceso a cualquier otra API de Google, también puedes agregar esos permisos. Si quieres obtener más información sobre los alcances de la API de Google, consulta Usa OAuth 2.0 para acceder a las API 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 permisos de OAuth puede requerir que tu app pase por 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 realizar la verificación de 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 obligatoria
En esta sección, se explica qué tipos de autenticación son necesarios o compatibles, y se proporcionan los permisos compatibles para cada método de la API de Google Workspace Events.
En el caso de las suscripciones a eventos de Google Chat, la API de Google Workspace Events admite la autenticación del usuario y 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 autenticación de usuario, la API muestra una lista de suscripciones a las que puede acceder el usuario autenticado. Si usas la autenticación de la app, la API muestra una lista de suscripciones a las que la app puede acceder. Para obtener más información sobre los tipos de autenticación de Chat, consulta Cómo autenticar y autorizar apps de Chat y las solicitudes a la API de Google Chat.
En la siguiente tabla, se muestran los permisos y 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 | Compatibilidad con la autenticación de apps (solo apps de Google Chat) | Permisos de autorización compatibles | |
|---|---|---|---|---|
| Crea una suscripción | — |
Requiere un alcance compatible para cada tipo de evento:
|
||
| Obtener una suscripción |
Con la autenticación de usuarios, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de la app (solo en apps de Google Chat):
|
|||
| Enumerar suscripciones |
Con la autenticación de usuarios, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de la app (solo en apps de Google Chat):
|
|||
| Cómo actualizar 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 de usuarios, este método requiere un alcance que admita al menos un tipo de evento para la suscripción.
Con la autenticación de la app (solo en apps de Google 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 son compatibles con cada tipo de evento:
| Eventos | Tipos de eventos | Alcances de autorización compatibles | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Cuando 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. |
|
|
||||||
| Cuando se actualiza o borra un espacio. |
|
|
||||||
| Google Meet | ||||||||
| Una conferencia comienza o finaliza. |
|
|
||||||
| Un participante se une a una conferencia o la abandona. |
|
|
||||||
| Se generó una grabación. |
|
|
||||||
| Se generó una transcripción. |
|
|
||||||