Este documento contiene la autorización específica de la API de Google Workspace Events y la información de autenticación. Antes de leer este documento, asegúrate de leer el la información general de autenticación y autorización de Google Workspace en Obtén más información sobre la autenticación y la autorización.
Configura OAuth 2.0 para la autorización
Cómo configurar la pantalla de consentimiento de OAuth y elegir los permisos para definir qué información se mostrará a los usuarios y revisores de apps, y registrarte tu aplicación para poder 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 permisos de autorización Un alcance de autorización es una cadena de URI de OAuth 2.0 que contenga el nombre de la app de Google Workspace, a qué tipos de datos accede y el nivel de acceso. Los permisos son las solicitudes de tu app para trabajar con datos de Google Workspace, lo que incluye de los usuarios Datos de la Cuenta de Google.
Cuando se instala la app, se le pide al usuario que valide los permisos que se usaron por la aplicación. En general, debes elegir el alcance más específico como sea posible y evita solicitar permisos que tu app no requiere. Usuarios más fácilmente a alcances limitados y claramente descritos.
Cuando sea posible, recomendamos usar permisos no sensibles, ya que otorgan acceso por archivo y restringen el acceso a funciones específicas que necesita una app.
La API de Google Workspace Events usa permisos de Google Workspace que admiten suscripciones. Si tu app ya usa los permisos que son necesarias para tu suscripción, no necesitas agregar permisos para usar la API de Google Workspace Events.
En la siguiente tabla, se muestran los permisos admitidos para API de Google Workspace Events:
Código del permiso | 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. Aporta acceso a todas las funciones disponibles para las apps de Chat. | No sensible | ||
https://www.googleapis.com/auth/chat.memberships |
Ve, agrega y quita 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 |
Consulta el chat y los espacios en Google Chat. | Sensibles |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Ver, agregar y borrar reacciones a los mensajes de Chat | Sensibles |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Ver las reacciones a un mensaje en 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 |
||
Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permite que las apps creen, modifiquen y lean metadatos sobre salas de reuniones que creó 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 |
La columna Uso de la tabla anterior indica la sensibilidad de cada alcance. según las siguientes definiciones:
No sensibles: estos alcances proporcionan el permiso más pequeño acceso autorizado y solo requiere la verificación básica de la app. Para información sobre este requisito, consulte Pasos para prepararse verificación.
Sensibles: Estos permisos proporcionan acceso a datos específicos del usuario de Google que está autorizada por el usuario para tu app. Requiere que realices verificación adicional de apps. Para obtener información sobre este requisito, consulta Pasos para apps que soliciten datos sensibles permisos
Restringido: Estos permisos proporcionan un amplio acceso a los datos del usuario de Google. y requieren que realices un proceso de verificación de permiso restringido. Para Para obtener más información sobre este requisito, consulte Servicios de la API de Google: Datos del usuario. Política y Requisitos adicionales para la API específica Permisos. Si almacenas datos de alcance restringido en servidores (o los transmites), debes pasar por una evaluación de seguridad.
Si tu app requiere acceso a otras APIs de Google, puedes agregar esos permisos a tus conjuntos de datos. Para obtener más información sobre los alcances de la API de Google, consulta Cómo usar OAuth 2.0 para Accede a las APIs de Google
Para obtener más información sobre los alcances de OAuth 2.0, consulta Alcances de OAuth 2.0 para APIs de Google.
Verificación de OAuth
Si usas ciertos permisos de OAuth, es posible que tu app continúe con la función de Verificación de OAuth . Lee la documentación sobre la verificación con la API de OAuth Preguntas frecuentes para determinar cuándo y qué tipo de verificación la verificación es obligatoria. Consulta también las Condiciones Adicionales del Service.
Tipos de autenticación requerida
En esta sección, se explica qué tipos de autenticación se requieren o admiten y proporciona 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 apps para llamar a algunos de sus métodos. Si una API
admite ambas credenciales, el tipo de credencial que se usa en la llamada
afecta el resultado que se devuelve. Por ejemplo, si llamas al
subscriptions.list()
con autenticación de usuario, la API devuelve una lista de suscripciones que
al que pueda 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
los tipos de autenticación de Chat, consulta Autentica y autoriza
Apps de Chat y API de Google Chat
solicitudes.
En la siguiente tabla, se muestran los alcances y tipos de autenticación son obligatorias o son compatibles con cada API de Google Workspace Events método:
Método | Autenticación de usuario obligatoria o compatible | Compatibilidad con la autenticación de apps (solo apps de Google Chat) | Se admiten los permisos de autorización | |
---|---|---|---|---|
Crea una suscripción | — |
Requiere un alcance admitido 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 apps (solo para apps de Google Chat):
|
|||
Lista de 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 apps (solo para apps de Google Chat):
|
|||
Actualiza una suscripción | — |
Requiere un alcance admitido para cada tipo de evento:
|
||
Cómo reactivar una suscripción | — |
Requiere un alcance admitido 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 apps (solo para apps de Google Chat):
|
Alcances 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 del suscripción.
En la siguiente tabla, se muestran los permisos de autorización compatibles con cada uno tipo de evento:
Eventos | Tipos de eventos | Permisos de autorización compatibles | ||||||
---|---|---|---|---|---|---|---|---|
Google Chat | ||||||||
Se publicó o actualizó un mensaje. |
|
|
||||||
Se agrega o borra una reacción, o se cambian varias reacciones. |
|
|
||||||
Una membresía se crea, actualiza o quita, o varias membresías los cambios. |
|
|
||||||
Un espacio se actualiza o se borra. |
|
|
||||||
Google Meet | ||||||||
Una conferencia comienza o termina. |
|
|
||||||
Un participante se une a una conferencia o la abandona. |
|
|
||||||
Se generó una grabación. |
|
|
||||||
Se generó una transcripción. |
|
|