Choisir les champs d'application de l'API Google Drive

Ce document contient des informations d'autorisation et d'authentification spécifiques à l'API Google Drive. Avant de lire ce document, veillez à lire les informations générales d'authentification et d'autorisation de Google Workspace sur la page En savoir plus sur l'authentification et l'autorisation.

Configurer OAuth 2.0 pour l'autorisation

Configurez l'écran de consentement OAuth et choisissez des autorisations pour définir les informations qui s'affichent auprès des utilisateurs et des examinateurs de l'application, et enregistrez votre application pour pouvoir la publier ultérieurement.

Champs d'application des API Drive

Pour définir le niveau d'accès accordé à votre application, vous devez identifier et déclarer des champs d'application de l'autorisation. Un champ d'application est une chaîne d'URI OAuth 2.0 qui contient le nom de l'application Google Workspace, le type de données auxquelles elle accède et le niveau d'accès. Les champs d'application correspondent aux demandes de votre application pour utiliser les données Google Workspace, y compris les données du compte Google des utilisateurs.

Lorsque votre application est installée, un utilisateur est invité à valider les champs d'application utilisés par l'application. En règle générale, vous devez choisir le champ d'application le plus ciblé possible et éviter de demander des champs d'application dont votre application n'a pas besoin. Les utilisateurs accordent plus facilement l'accès à des champs d'application limités et clairement décrits.

Lorsque cela est possible, nous vous recommandons d'utiliser des portées non sensibles, car elles accordent une portée d'accès par fichier et limitent l'accès aux fonctionnalités spécifiques requises par une application.

L'API Drive est compatible avec les champs d'application suivants:

Code de champ d'application Description Utilisation
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder
Consultez et gérez les données de configuration de l'application dans Google Drive. Recommandé
Non sensible
https://www.googleapis.com/auth/drive.install Autorisez les applications à apparaître en tant qu'option dans le menu "Ouvrir avec" ou "Nouveau". Recommandé
Non sensible
https://www.googleapis.com/auth/drive.file Créez des fichiers Drive ou modifiez des fichiers existants que vous ouvrez avec une application ou que l'utilisateur partage avec une application à l'aide de l'API Google Picker ou du sélecteur de fichiers de l'application. Recommandé
Non sensible
https://www.googleapis.com/auth/drive.apps.readonly Affichez les applications autorisées à accéder à votre Drive. Contenu à caractère sensible
https://www.googleapis.com/auth/drive Afficher et gérer tous vos fichiers Drive Limité
https://www.googleapis.com/auth/drive.readonly Consultez et téléchargez tous vos fichiers Drive. Limité
https://www.googleapis.com/auth/drive.activity Afficher le journal d'activités des fichiers de votre Drive et y ajouter des éléments Limité
https://www.googleapis.com/auth/drive.activity.readonly Afficher le journal d'activités des fichiers de votre Drive Limité
https://www.googleapis.com/auth/drive.meet.readonly afficher les fichiers Drive créés ou modifiés dans Google Meet ; Limité
https://www.googleapis.com/auth/drive.metadata Afficher et gérer les métadonnées des fichiers présents dans votre Drive Limité
https://www.googleapis.com/auth/drive.metadata.readonly Consultez les métadonnées de vos fichiers dans Drive. Limité
https://www.googleapis.com/auth/drive.scripts Modifiez le comportement de vos scripts Google Apps Script. Limité

La colonne "Utilisation" du tableau ci-dessus indique la sensibilité de chaque champ d'application, conformément aux définitions suivantes:

Si votre application nécessite l'accès à d'autres API Google, vous pouvez également ajouter ces champs d'application. Pour en savoir plus sur les champs d'application des API Google, consultez la section Utiliser OAuth 2.0 pour accéder aux API Google.

Pour en savoir plus sur des champs d'application OAuth 2.0 spécifiques, consultez la section Champs d'application OAuth 2.0 pour les API Google.

Validation OAuth

L'utilisation de certains champs d'application OAuth peut nécessiter que votre application passe par le Centre d'aide de la validation des applications OAuth. Consultez les questions fréquentes sur l'application OAuth pour déterminer quand votre application doit faire l'objet d'une validation et quel type de validation est requis. Consultez également les Conditions d'utilisation de Google Drive.

Quand utiliser un champ d'application limité ?

Pour Drive, seuls les types d'applications suivants peuvent accéder aux habilitations limitées:

  1. Applications Web et spécifiques à une plate-forme qui permettent une synchronisation locale ou une sauvegarde automatique des fichiers Drive des utilisateurs
  2. Applications de productivité et d'enseignement dont l'interface utilisateur peut impliquer une interaction avec des fichiers Drive (ou leurs métadonnées ou autorisations). Les applications de productivité incluent les applications de gestion des tâches, de prise de notes, de communication en groupe de travail et de collaboration en classe.
  3. Applications de reporting et de sécurité qui fournissent des insights sur la façon dont les fichiers sont partagés ou consultés par les utilisateurs ou les clients.

Pour continuer à utiliser des champs d'application restreints, vous devez préparer votre application à la validation des champs d'application restreints.

Migrer une application existante à partir de champs d'application restreints

Si vous avez développé une application Drive avec l'un des champs d'application restreints, nous vous recommandons de migrer votre application pour utiliser un niveau d'accès non sensible, car il accorde un niveau d'accès par fichier et limite l'accès aux fonctionnalités spécifiques requises par une application. De nombreuses applications fonctionnent avec un accès par fichier sans aucune modification. Si vous utilisez votre propre sélecteur de fichiers, nous vous recommandons de passer à l'API Google Picker, qui prend entièrement en charge différents champs d'application.

Avantages de l'habilitation OAuth drive.file

L'utilisation du champ d'application OAuth drive.file et de l'API Google Picker optimise à la fois l'expérience utilisateur et la sécurité de votre application.

Le champ d'application OAuth de drive.file permet aux utilisateurs de choisir les fichiers qu'ils souhaitent partager avec votre application. Ils ont ainsi davantage de contrôle et d'assurance que l'accès de votre application à leurs fichiers est limité et plus sécurisé. En revanche, exiger un accès étendu à tous les fichiers Drive peut décourager les utilisateurs d'interagir avec votre application. Voici quelques raisons d'utiliser la portée drive.file:

  • Facilité d'utilisation: le champ d'application drive.file fonctionne avec toutes les ressources REST de l'API Drive, ce qui signifie que vous pouvez l'utiliser de la même manière que les champs d'application OAuth plus larges.

  • Fonctionnalités: l'API Google Picker offre une interface semblable à celle de Drive. Cela comprend plusieurs affichages affichant des aperçus et des vignettes des fichiers Drive, ainsi qu'une fenêtre modale intégrée afin que les utilisateurs ne quittent jamais l'application principale.

  • Pratique: les applications peuvent appliquer des filtres à certains types de fichiers Drive (tels que Google Docs, Sheets et les photos) lorsqu'elles utilisent un filtre sur les fichiers Google Picker.

De plus, comme drive.file n'est pas sensible, il permet un processus de validation plus simplifié.

Enregistrer des jetons d'actualisation

Enregistrez les jetons d'actualisation dans un espace de stockage sécurisé et à long terme, et continuez à les utiliser tant qu'ils restent valides.