API de Data Studio

La API de Data Studio te permite buscar y administrar elementos de Data Studio.

El caso de uso principal de la API es permitir que las organizaciones de Google Workspace o Cloud Identity automaticen la administración y la migración de los elementos de Data Studio.

Punto clave: La API solo está disponible para los usuarios que pertenecen a una organización con Google Workspace o Cloud Identity.

Descripción general de los requisitos

Se requieren los siguientes pasos para usar la API de Data Studio:

1. Configura una app para usar la API.
2. Usa la Consola del administrador de Google para autorizar la app.
3. Obtén tokens de acceso de OAuth 2.0 y llama a la API.

Las organizaciones pueden realizar los pasos anteriores de forma individual o en conjunto según las siguientes situaciones comunes:

• Apps internas desarrolladas para una organización. La organización configura y autoriza la app para todos sus usuarios.
• Apps de terceros desarrolladas para usuarios o clientes externos (es decir, el desarrollador y los usuarios pertenecen a organizaciones diferentes). El desarrollador configura la app, pero la organización del usuario autoriza la app de terceros.

1. Configura una app para usar la API

Completa los siguientes pasos para configurar tu app:

• Habilita la API
• Crea un cliente de OAuth

Habilita la API

Para habilitar una API en tu proyecto, haz lo siguiente:

1. Abre la [API de Data Studio] en la Consola de APIs de Google.
2. Si se te solicita, selecciona un proyecto o crea uno nuevo.
3. Haz clic en Habilitar.
4. Si se te solicita, lee y acepta las Condiciones del Servicio de la API.

Crea un cliente de OAuth

Los siguientes pasos para crear un cliente de OAuth son lineamientos generales y se deben ajustar para satisfacer los requisitos de tu app.

Importante: No agregues permisos de Data Studio a tu cliente de OAuth. El administrador de Workspace agregará los permisos cuando autorice la app.

1. Navega a Configurar la pantalla de consentimiento de OAuth.
   1. Elige Interno y haz clic en Crear.
   2. Completa los campos obligatorios y haz clic en Guardar.
2. Navega a Credenciales.
   1. Haz clic en CREAR CREDENCIALES.
   2. Selecciona ID de cliente de OAuth.
   3. Elige el Application Type adecuado. (La aplicación web es la más común).
   4. Completa los campos obligatorios y haz clic en Crear.
3. Toma nota del ID de cliente , ya que se usa para autorizar la app.

2. Autoriza la app para una organización

Las apps que usan la API de Data Studio solo pueden autenticar y autorizar a los usuarios de Google Workspace cuando la organización del usuario autorizó la app con la delegación en todo el dominio para controlar el acceso a la API.

Configura la delegación en todo el dominio con el ID de cliente de OAuth de la app y los permisos que requiere la app.

Importante: Un administrador de Workspace debe completar los siguientes pasos. El administrador necesitará el ID de cliente de OAuth de la app y una lista de los permisos de OAuth que requiere la app.

1. Accede a la Consola del administrador de Google y navega a la delegación en todo el dominio.
2. En API clients, haz clic en Add new.
3. Ingresa el Client ID de la app que deseas autorizar (es decir, la app que usa la API de Data Studio).
4. Ingresa todos los permisos de OAuth que requiere la app. Los siguientes permisos se solicitan con frecuencia si se usa la API de Data Studio para administrar elementos:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Haz clic en Autorizar.

Nota: Si tu app no necesita administrar elementos de Data Studio, considera usar el permiso más restrictivo https://www.googleapis.com/auth/datastudio.readonly en lugar de https://www.googleapis.com/auth/datastudio.

Después de autorizar la app, cualquier usuario de Workspace que pertenezca a la organización se autorizará automáticamente para usar la app con la API de Data Studio.

3. Obtén tokens de acceso de OAuth 2.0 y llama a la API

Una vez que desarrolles y autorices la app, tendrás el acceso necesario para llamar a la API para los usuarios de Workspace. Consulta Usa OAuth 2.0 para acceder a las APIs de Google para obtener detalles sobre cómo trabajar con las APIs de Google con OAuth. Consulta la referencia de la API para ver las operaciones disponibles.

Solución de problemas

Falta el diálogo de OAuth

Si la organización de un usuario autorizó la app, los usuarios de esa organización no verán el diálogo de OAuth cuando autoricen la app. La única excepción sería si la app solicita autorización para permisos adicionales de la API de Google que el administrador de Workspace no configuró, en cuyo caso se mostrará el diálogo de OAuth a los usuarios.

Error 400: invalid_scope

Si un usuario recibe un mensaje Error 400: invalid_scope cuando intenta autorizar la app, significa que la organización del usuario no autorizó la app o lo hizo de forma incorrecta autorizado la app. Para resolver el problema, el usuario deberá solicitar que su organización autorice la app.