Ce guide contient des tâches liées à la gestion des Drive partagés, telles que la création de Drive partagés, la gestion des membres et des autorisations à l'aide de l'API Google Drive.
Si vous souhaitez spécifier les champs à renvoyer dans la réponse, vous pouvez définir le
fields paramètre
système
avec n'importe quelle méthode de la ressource drives. Si vous ne spécifiez pas le paramètre fields, le serveur renvoie un ensemble de champs par défaut spécifique à la méthode. Par exemple, la
list méthode ne renvoie que les champs kind, id,
et name pour chaque Drive partagé. Pour en savoir plus, consultez la section Renvoyer
des champs spécifiques.
Pour en savoir plus sur les limites applicables aux dossiers des Drive partagés, consultez Limites applicables aux dossiers des Drive partagés.
Créer un Drive partagé
Pour créer un Drive partagé, utilisez la create
méthode sur la ressource drives avec le
requestId paramètre.
Le paramètre requestId identifie la tentative logique de création idempotente d'un Drive partagé. Si la requête expire ou renvoie une erreur de backend indéterminée, la même requête peut être répétée sans créer de doublons. Le requestId et le corps de la requête doivent rester identiques.
L'exemple de code suivant montre comment créer un Drive partagé :
Java
Python
Node.js
PHP
.NET
Les appels de la create méthode sont
idempotents.
Si le Drive partagé a été créé lors d'une requête précédente ou en raison d'une nouvelle tentative, la méthode renvoie une instance de la ressource drives. Parfois, par exemple après une période prolongée ou si le corps de la requête a changé, une erreur 409 peut être renvoyée, indiquant que le requestId doit être ignoré.
Obtenir un Drive partagé
Pour obtenir les métadonnées d'un Drive partagé, utilisez la
get méthode sur la ressource drives avec le paramètre de chemin d'accès driveId. Si vous
ne connaissez pas l'ID du Drive, vous pouvez lister tous les Drive partagés
à l'aide de la méthode list.
La méthode get renvoie un Drive partagé en tant qu'instance d'une ressource drives.
Pour émettre la requête en tant qu'administrateur de domaine, définissez le paramètre de requête useDomainAdminAccess sur true. Pour en savoir plus, consultez Gérer les Drive partagés en tant qu'
administrateur de domaine.
Lister les Drive partagés
Pour lister les Drive partagés d'un utilisateur, utilisez la list
méthode sur la drives ressource. La méthode renvoie une liste de Drive partagés.
Transmettez les paramètres de requête suivants pour personnaliser la pagination ou filtrer les Drive partagés :
pageSize: nombre maximal de Drive partagés à renvoyer par page.pageToken: jeton de page reçu lors d'un appel de liste précédent. Fournissez ce jeton pour récupérer la page suivante.q: chaîne de requête pour rechercher des Drive partagés. Pour en savoir plus, consultez Rechercher des Drive partagés.useDomainAdminAccess: définissez la valeur surtruepour émettre la requête en tant qu'administrateur de domaine afin de renvoyer tous les Drive partagés du domaine dans lequel le demandeur est administrateur. Pour en savoir plus, consultez Gérer les Drive partagés en tant qu'administrateur de domaine.
Mettre à jour un Drive partagé
Pour mettre à jour les métadonnées d'un Drive partagé, utilisez la update méthode sur la
drives ressource avec le driveId paramètre
de chemin d'accès.
La méthode renvoie un Drive partagé en tant qu'instance d'une ressource drives.
Pour émettre la requête en tant qu'administrateur de domaine, définissez le paramètre de requête useDomainAdminAccess sur true. Pour en savoir plus, consultez Gérer les Drive partagés en tant qu'
administrateur de domaine.
Masquer et afficher un Drive partagé
Pour masquer un Drive partagé dans la vue par défaut, utilisez la hide méthode sur la
drives ressource avec le driveId paramètre.
Lorsqu'un Drive partagé est masqué, Drive marque la ressource de Drive partagé comme hidden=true. Les Drive partagés masqués n'apparaissent pas dans l'interface utilisateur de Drive ni dans la liste des fichiers renvoyés.
Pour rétablir un Drive partagé dans la vue par défaut, utilisez la unhide méthode sur la
drives ressource avec le driveId paramètre.
Les deux méthodes renvoient un Drive partagé en tant qu'instance d'une ressource drives.
Supprimer un Drive partagé
Pour supprimer définitivement un Drive partagé, utilisez la
delete méthode sur la drives ressource avec le driveId paramètre.
Avant de supprimer un Drive partagé, tout son contenu doit être placé dans la corbeille ou supprimé. L'utilisateur doit également disposer du role=organizer sur le dossier du Drive partagé. Pour en savoir plus, consultez Placer des fichiers et des dossiers dans la corbeille ou les supprimer.
Transmettez les paramètres de requête suivants pour filtrer les Drive partagés :
useDomainAdminAccess: définissez la valeur surtruepour émettre la requête en tant qu'administrateur de domaine afin de renvoyer tous les Drive partagés du domaine dans lequel le demandeur est administrateur. Pour en savoir plus, consultez Gérer les Drive partagés en tant qu'administrateur de domaine.allowItemDeletion: définissez la valeur surtruepour supprimer des éléments dans le Drive partagé. Cette option n'est compatible que lorsqueuseDomainAdminAccessest également défini surtrue.
Ajouter ou supprimer des membres d'un Drive partagé
Ajoutez ou supprimez des membres d'un Drive partagé à l'aide de la
permissions ressource.
Pour ajouter un membre, créez l'autorisation sur le Drive partagé. Les méthodes d'autorisation peuvent également être utilisées sur des fichiers individuels d'un Drive partagé pour accorder des privilèges supplémentaires aux membres ou permettre aux non-membres de collaborer sur des éléments spécifiques.
Pour en savoir plus et obtenir un exemple de code, consultez Partager des fichiers, des dossiers et des Drive.
Gérer les Drive partagés en tant qu'administrateur de domaine
Appliquez le useDomainAdminAccess paramètre avec les drives et permissions
ressources pour gérer les Drive partagés dans une organisation.
Les utilisateurs qui appellent ces méthodes avec useDomainAdminAccess=true doivent disposer du
Drive and Docs privilège
d'administrateur.
Les administrateurs peuvent rechercher des Drive
partagés ou mettre à jour les autorisations des Drive
partagés appartenant à leur organisation, quel que soit leur statut de membre
dans un Drive partagé donné.
Lorsque vous utilisez des comptes de service, vous devrez peut-être emprunter l'identité d'un administrateur authentifié à l'aide de l'emprunt d'identité de compte de service. Notez que les comptes de service n'appartiennent pas à votre domaine Google Workspace, contrairement aux comptes utilisateur. Si vous partagez des éléments Google Workspace, tels que des documents ou des événements, avec l'ensemble de votre domaine Google Workspace, ces éléments ne sont pas partagés avec les comptes de service. Pour en savoir plus, consultez la section Présentation des comptes de service.
Récupérer un Drive partagé qui n'a pas d'administrateur
L'exemple de code suivant montre comment récupérer des Drive partagés qui n'ont plus d'administrateur.
Java
Python
Node.js
PHP
.NET
Empêcher les utilisateurs de télécharger, d'imprimer ou de copier votre fichier
Vous pouvez limiter la façon dont les utilisateurs peuvent télécharger, imprimer et copier des fichiers dans les Drive partagés.
Pour déterminer si l'utilisateur peut modifier les restrictions de téléchargement appliquées par l'administrateur
d'un Drive partagé, cochez le champ booléen capabilities.canChangeDownloadRestriction. Si capabilities.canChangeDownloadRestriction est défini sur true, des restrictions de téléchargement peuvent être appliquées au Drive partagé. Pour en savoir plus, consultez
Comprendre les fonctionnalités des fichiers.
La ressource drives contient une collection de
champs booléens restrictions
utilisés pour indiquer si une action peut être effectuée sur un Drive partagé.
Les restrictions s'appliquent à un Drive partagé ou aux éléments qu'il contient.
Les restrictions peuvent être définies à l'aide de la drives.update méthode.
Pour appliquer des restrictions de téléchargement à un Drive partagé, un administrateur de Drive partagé peut définir
le restrictions.downloadRestriction champ de la drives
ressource à l'aide de l'
DownloadRestriction objet.
Définir le champ booléen restrictedForReaders sur true déclare que le téléchargement et la copie sont limités pour les lecteurs. Définir le champ booléen restrictedForWriters sur true déclare que le téléchargement et la copie sont limités pour les rédacteurs. Notez que si le champ restrictedForWriters est true, le téléchargement et la copie sont également limités pour les lecteurs. De même, définir restrictedForWriters sur true et restrictedForReaders sur false équivaut à définir restrictedForWriters et restrictedForReaders sur true.
Rétrocompatibilité.
Avec l'introduction de l'objet DownloadRestriction, la fonctionnalité du champ booléen
restrictions.copyRequiresWriterPermission
a été mise à jour.
Désormais, définir restrictions.copyRequiresWriterPermission sur true met à jour le
restrictedForReaders champ booléen de l'objet DownloadRestriction sur true pour déclarer que
le téléchargement et la copie sont limités pour les lecteurs.
Définir le champ copyRequiresWriterPermission sur false met à jour les champs restrictedForWriters et restrictedForReaders sur false. Cela signifie que les paramètres de restriction de téléchargement ou de copie sont supprimés pour tous les utilisateurs.
Champs qui contrôlent les fonctionnalités de téléchargement, d'impression et de copie
Le tableau suivant répertorie les champs de ressource drives
qui affectent les fonctionnalités de téléchargement, d'impression et de copie :
| Champ | Description | Version |
|---|---|---|
capabilities.canCopy |
Indique si l'utilisateur actuel peut copier des fichiers dans un Drive partagé. | v2 et v3 |
capabilities.canDownload |
Indique si l'utilisateur actuel peut télécharger des fichiers dans un Drive partagé. | v2 et v3 |
capabilities.canChangeCopyRequiresWriterPermission |
Indique si l'utilisateur actuel peut modifier la restriction copyRequiresWriterPermission d'un Drive partagé. |
v2 et v3 |
capabilities.canResetDriveRestrictions |
Indique si l'utilisateur actuel peut rétablir les restrictions par défaut du Drive partagé. | v2 et v3 |
capabilities.canChangeDownloadRestriction |
Indique si l'utilisateur actuel peut modifier la restriction de téléchargement d'un Drive partagé. | v3 uniquement |
restrictions.copyRequiresWriterPermission |
Indique si les options permettant de copier, d'imprimer ou de télécharger des fichiers dans un Drive partagé sont désactivées pour les lecteurs et les commentateurs. Lorsque la valeur est true, le champ du même nom est défini sur true pour tous les fichiers de ce Drive partagé. |
v2 et v3 |
restrictions.downloadRestriction |
Restrictions de téléchargement appliquées par les administrateurs de Drive partagés. | v3 uniquement |
Limites applicables aux dossiers
Les dossiers des Drive partagés sont soumis à certaines limites de stockage. Pour en savoir plus, consultez Limites des Drive partagés dans Google Drive.
Nombre maximal d'éléments
Le Drive partagé de chaque utilisateur est limité à 500 000 éléments, y compris les fichiers, les dossiers et les raccourcis.
Une fois la limite atteinte, le Drive partagé ne peut plus accepter d'éléments. Pour continuer à recevoir des fichiers, les utilisateurs doivent supprimer définitivement des éléments du Drive partagé. Notez que les éléments de la corbeille sont pris en compte dans la limite, mais pas les éléments supprimés définitivement. Pour en savoir plus, consultez Placer des fichiers et des dossiers dans la corbeille ou les supprimer.
Limite de profondeur des dossiers
Un dossier dans un Drive partagé ne peut pas contenir plus de 100 niveaux de dossiers imbriqués. Cela signifie qu'un dossier enfant ne peut pas être stocké sous un dossier dont la profondeur est supérieure à 99 niveaux. Cette limitation ne s'applique qu'aux dossiers enfants.
Toute tentative d'ajout de plus de 100 niveaux de dossiers renvoie un
teamDriveHierarchyTooDeep
code d'état HTTP.