API de Looker Studio

La API de Looker Studio te permite buscar y administrar recursos de Looker 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 migración de los recursos de Looker 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 Looker Studio:

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

Los mismos pasos pueden realizar la misma organización o una diferente en función de las siguientes situaciones comunes:

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

1. Configura una app para usar la API

Completa lo siguiente para configurar tu app:

• Habilitar la API
• Crea un cliente de OAuth

Cómo habilitar la API

Si quieres habilitar una API para tu proyecto, sigue estos pasos:

1. Abre la API de Looker Studio en la Consola de API 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 a fin de cumplir con los requisitos de tu app.

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

1. Navega a Configura la pantalla de consentimiento de OAuth.
   1. Seleccione Interno y haga clic en Crear.
   2. Completa los campos obligatorios y haz clic en Guardar.
2. Ve a Credenciales.
   1. Haga 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 aplicación.

2. Autoriza la app para una organización

Las apps que usan la API de Looker Studio solo pueden autenticar y autorizar a los usuarios de Google Workspace en los casos en que la organización del usuario haya autorizado la app mediante la delegación de todo el dominio para controlar el acceso a la API.

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

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 permisos de OAuth que la app requiere.

1. Accede a la Consola del administrador de Google y navega a Delegación de todo el dominio.
2. En API clients, haz clic en Agregar nuevo.
3. Ingresa el Client ID de la app que deseas autorizar (es decir, la app que usa la API de Looker Studio).
4. Ingresa todos los permisos de OAuth que requiere la app. Por lo general, los siguientes alcances se solicitan si se usa la API de Looker Studio para administrar recursos:
   • 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 recursos de Looker Studio, considera usar el alcance https://www.googleapis.com/auth/datastudio.readonly más restrictivo 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 tendrá autorización automática para usar la app con la API de Looker Studio.

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

Una vez que hayas desarrollado y autorizado la app, tendrás el acceso necesario para llamar a la API de los usuarios de Workspace. Consulta cómo usar OAuth 2.0 para acceder a las API de Google y obtener detalles sobre cómo trabajar con las API de Google mediante OAuth. Consulta la referencia de la API para conocer las operaciones disponibles.

Solución de problemas

Falta el diálogo de OAuth

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

Error 400: invalid_scope

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