API Looker Studio

L'API Looker Studio vous permet de rechercher et de gérer des assets Looker Studio.

Le principal cas d'utilisation de l'API est d'autoriser les organisations Google Workspace ou Cloud Identity à automatiser la gestion et la migration des composants Looker Studio.

Important :L'API n'est disponible que pour les utilisateurs d'une organisation disposant de Google Workspace ou Cloud Identity.

Présentation des exigences

Pour utiliser l'API Looker Studio, procédez comme suit:

1. Configurer une application pour utiliser l'API
2. Utilisez la console d'administration Google pour autoriser l'application.
3. Obtenez les jetons d'accès OAuth 2.0 et appelez l'API.

Les étapes ci-dessus peuvent être effectuées par les mêmes organisations ou par des organisations différentes, en fonction des scénarios courants suivants:

• Applications internes développées pour une organisation L'organisation configure et autorise l'application pour tous les utilisateurs de son organisation.
• Applications tierces développées pour des utilisateurs ou des clients externes (développeurs et utilisateurs appartenant à différentes organisations) Le développeur configure l'application, mais l'organisation de l'utilisateur autorise l'application tierce.

1. Configurer une application pour utiliser l'API

Pour configurer votre application, procédez comme suit:

• Activer l'API
• Créer un client OAuth

Activer l'API

Pour activer une API pour votre projet:

1. Ouvrez l'API Looker Studio dans la console Google APIs.
2. Si vous y êtes invité, sélectionnez un projet ou créez-en un.
3. Cliquez sur Activer.
4. Si vous y êtes invité, lisez et acceptez les conditions d'utilisation de l'API.

Créer un client OAuth

Les étapes suivantes de création d'un client OAuth sont des consignes générales. Vous devez les ajuster pour répondre aux exigences de votre application.

Important :N'ajoutez pas de champs d'application Looker Studio à votre client OAuth. Les champs d'application seront ajoutés par l'administrateur Workspace lorsqu'il autorisera l'application.

1. Accédez à Configurer l'écran de consentement OAuth.
   1. Sélectionnez Interne, puis cliquez sur Créer.
   2. Remplissez les champs obligatoires, puis cliquez sur Enregistrer.
2. Accédez à Identifiants.
   1. Cliquez sur CRÉER DES IDENTIFIANTS.
   2. Sélectionnez ID client OAuth.
   3. Sélectionnez le Application Type approprié. (l'application Web est la plus courante).
   4. Remplissez les champs obligatoires, puis cliquez sur Créer.
3. Notez l'ID client, car il est utilisé pour autoriser l'application.

2. Autoriser l'application pour une organisation

Les applications qui utilisent l'API Looker Studio ne peuvent authentifier et autoriser les utilisateurs Google Workspace que si l'organisation de l'utilisateur les a autorisées à contrôler l'accès à l'API via la délégation au niveau du domaine.

Configurez la délégation au niveau du domaine avec l'ID client OAuth de l'application et les champs d'application requis par celle-ci.

Important :Les étapes suivantes doivent être réalisées par un administrateur Workspace. L'administrateur aura besoin de l'ID client OAuth de l'application et de la liste des champs d'application OAuth requis par l'application.

1. Connectez-vous à la console d'administration Google et accédez à la délégation au niveau du domaine.
2. Dans API clients, cliquez sur Ajouter.
3. Saisissez le Client ID de l'application à autoriser (c'est-à-dire l'application qui utilise l'API Looker Studio).
4. Saisissez tous les champs d'application OAuth requis par l'application. Les champs d'application suivants sont couramment demandés si vous utilisez l'API Looker Studio pour gérer les éléments :
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. Cliquez sur Autoriser.

Remarque :Si votre application n'a pas besoin de gérer les composants Looker Studio, envisagez d'utiliser le champ d'application https://www.googleapis.com/auth/datastudio.readonly plus restrictif plutôt que https://www.googleapis.com/auth/datastudio.

Une fois l'application autorisée, tout utilisateur Workspace appartenant à l'organisation sera automatiquement autorisé à l'utiliser avec l'API Looker Studio.

3. Obtenir des jetons d'accès OAuth 2.0 et appeler l'API

Une fois que vous avez développé et autorisé l'application, vous disposez des accès nécessaires pour appeler l'API pour les utilisateurs Workspace. Pour savoir comment utiliser les API Google avec OAuth, consultez Utiliser OAuth 2.0 pour accéder aux API Google. Consultez la documentation de référence de l'API pour connaître les opérations disponibles.

Dépannage

Boîte de dialogue OAuth manquante

Si l'organisation d'un utilisateur a autorisé l'application, les utilisateurs de cette organisation ne verront pas la boîte de dialogue OAuth lors de l'autorisation de l'application. La seule exception serait si l'application demande une autorisation pour des champs d'application d'API Google supplémentaires que l'administrateur Workspace n'a pas configurés, auquel cas les utilisateurs verront la boîte de dialogue OAuth.

Erreur 400: champ d'application non valide

Si un utilisateur reçoit un message Error 400: invalid_scope lorsqu'il tente d'autoriser l'application, cela signifie que son organisation n'a pas ou non autorisé l'application. Pour résoudre le problème, l'utilisateur devra demander l'autorisation de l'application.