Este documento contiene información específica sobre la autorización y la autenticación de la API de Google Workspace Events. Antes de leer este documento, asegúrate de leer la información general sobre la autenticación y la 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 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 datos de Google Workspace, incluidos los datos de las Cuentas de Google de los usuarios.
Cuando se instala tu app, se le pide al usuario que valide los alcances que usa la app. Por lo general, debes elegir el alcance más específico posible y evitar solicitar alcances que tu app no necesite. Los usuarios otorgan acceso más fácilmente a los permisos limitados y claramente descritos.
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 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 Google 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 y quitar miembros de las conversaciones en 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 visualizar o actualizar metadatos (incluida la configuración del historial) en Google Chat | Sensible | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver chats 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 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 |
Permite 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 en tu 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 reuniones 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 el usuario tenga acceso. | Sensible |
||
La columna Uso de la tabla anterior indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos permisos proporcionan el alcance más pequeño de acceso de autorización y solo requieren la verificación básica de la app. Para obtener información sobre este requisito, consulta Requisitos de verificación.
Sensibles: Estos permisos proporcionan acceso a datos específicos de los usuarios de Google que el usuario autoriza para tu app. Requieren que pases por una verificación adicional de la app. Para obtener información sobre este requisito, consulta Requisitos de alcance sensible y restringido.
Restringidos: Estos permisos proporcionan un amplio acceso a los datos del usuario de Google y requieren que pases por 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 las APIs de Google y los Requisitos Adicionales para Permisos Específicos de la API. Si almacenas datos con alcance restringido 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. Si deseas 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.
Si deseas obtener más información sobre 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 Centro de ayuda para la verificación de apps de OAuth. Lee las preguntas frecuentes sobre las apps con 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 Google Drive.
Tipos de autenticación requerida
En esta sección, se explican los tipos de autenticación que se requieren o admiten, y se proporcionan los alcances admitidos 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 de usuarios y de apps para llamar a algunos de sus métodos. Si un método de API admite ambos tipos de credenciales, el tipo de credencial que se usa en la llamada afecta el resultado que se devuelve. Por ejemplo, si llamas al método subscriptions.list con autenticación del usuario, la API devuelve una lista de las 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 Cómo autenticar y autorizar solicitudes a la API de Google Chat y apps de Chat.
En la siguiente tabla, se muestran los alcances 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 admite la autenticación del usuario | 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:
|
||
| Obtener 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 la app (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 la app (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 la app (solo para apps de Google Chat):
|
|||
Permisos por tipo de evento
Cuando llamas 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 admitidos 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 Drive | ||||||||
| Se crea, cambia, mueve, borra, envía a la papelera o quita de la papelera un archivo. |
|
|
||||||
| Se crea o resuelve una propuesta de acceso en un archivo. |
|
|
||||||
| 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. |
|
|
||||||