REST Resource: drives

Ressource: Drive

Représentation d'un Drive partagé.

Certaines méthodes de ressources (telles que drives.update) nécessitent un driveId. Utilisez la méthode drives.list pour récupérer l'ID d'un Drive partagé.

Représentation JSON 
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdTime": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
Champs
id

string

Uniquement en sortie. ID de ce Drive partagé, qui correspond également à l'ID du dossier racine de ce Drive partagé.
name

string

Nom de ce Drive partagé.
colorRgb

string

Couleur de ce Drive partagé sous forme de chaîne hexadécimale RVB. Elle ne peut être définie que sur une requête drive.drives.update qui ne définit pas themeId.
kind

string

Uniquement en sortie. Identifie le type de ressource. Valeur: chaîne fixe "drive#drive".
capabilities

object

Uniquement en sortie. Autorisations de l'utilisateur actuel sur ce Drive partagé.
capabilities.canAddChildren

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut ajouter des enfants aux dossiers de ce Drive partagé.
capabilities.canComment

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut commenter les fichiers de ce Drive partagé.
capabilities.canCopy

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut copier des fichiers dans ce Drive partagé.
capabilities.canDeleteDrive

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut supprimer ce Drive partagé. Toute tentative de suppression du Drive partagé peut échouer s'il contient des éléments qui ne se trouvent pas dans la corbeille.
capabilities.canDownload

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut télécharger des fichiers dans ce Drive partagé.
capabilities.canEdit

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier les fichiers de ce Drive partagé
capabilities.canListChildren

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut lister les enfants de dossiers dans ce Drive partagé.
capabilities.canManageMembers

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut ajouter des membres à ce Drive partagé, les supprimer ou modifier leur rôle.
capabilities.canReadRevisions

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut lire la ressource des révisions des fichiers de ce Drive partagé.
capabilities.canRename

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut renommer les fichiers ou les dossiers de ce Drive partagé.
capabilities.canRenameDrive

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut renommer ce Drive partagé.
capabilities.canChangeDriveBackground

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier l'arrière-plan de ce Drive partagé.
capabilities.canShare

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut partager des fichiers ou des dossiers dans ce Drive partagé.
capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier la restriction copyRequiresWriterPermission de ce Drive partagé.
capabilities.canChangeDomainUsersOnlyRestriction

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier la restriction domainUsersOnly de ce Drive partagé.
capabilities.canChangeDriveMembersOnlyRestriction

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier la restriction driveMembersOnly de ce Drive partagé.
capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut modifier la restriction sharingFoldersRequiresOrganizerPermission de ce Drive partagé.
capabilities.canResetDriveRestrictions

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut rétablir les paramètres par défaut des restrictions des Drive partagés.
capabilities.canDeleteChildren

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut supprimer des enfants des dossiers de ce Drive partagé.
capabilities.canTrashChildren

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut supprimer les enfants des dossiers de ce Drive partagé.
themeId

string

ID du thème à partir duquel l'image de fond et la couleur seront définies. L'ensemble des driveThemes possibles peut être récupéré à partir d'une réponse drive.about.get. Lorsqu'il n'est pas spécifié dans une requête drive.drives.create, un thème aléatoire est choisi à partir duquel l'image et la couleur de fond sont définies. Il s'agit d'un champ en écriture seule ; il ne peut être défini que pour les requêtes qui ne définissent pas colorRgb ni backgroundImageFile.
backgroundImageFile

object

Fichier image et paramètres de recadrage à partir desquels une image de fond pour ce Drive partagé est définie. Il s'agit d'un champ en écriture seule ; il ne peut être défini que pour les requêtes drive.drives.update qui ne définissent pas themeId. Si spécifié, tous les champs de l'élément backgroundImageFile doivent être définis.
backgroundImageFile.id

string

ID d'un fichier image dans Google Drive à utiliser pour l'image de fond.
backgroundImageFile.xCoordinate

number

Coordonnée X de l'angle supérieur gauche de la zone de recadrage dans l'image de fond. Cette valeur se situe dans la plage fermée, comprise entre 0 et 1. Cette valeur représente la distance horizontale entre le côté gauche de l'image entière et le côté gauche de la zone de recadrage, divisée par la largeur de l'image entière.
backgroundImageFile.yCoordinate

number

Coordonnée Y de l'angle supérieur gauche de la zone de recadrage dans l'image de fond. Cette valeur se situe dans la plage fermée, comprise entre 0 et 1. Cette valeur représente la distance verticale entre le bord supérieur de l'image entière et le bord supérieur de la zone de recadrage, divisée par la hauteur de l'image entière.
backgroundImageFile.width

number

Largeur de l'image recadrée dans la plage fermée de 0 à 1. Cette valeur représente la largeur de l'image recadrée divisée par la largeur de l'image entière. La hauteur est calculée en appliquant un rapport largeur/hauteur de 80:9. L'image obtenue doit faire au moins 1 280 pixels de large et 144 pixels de haut.
createdTime

string

Uniquement en sortie. Heure à laquelle le Drive partagé a été créé (date et heure RFC 3339).
hidden

boolean

Indique si le Drive partagé est masqué dans l'affichage par défaut.
restrictions

object

Ensemble de restrictions qui s'appliquent à ce Drive partagé ou aux éléments qu'il contient. Notez que vous ne pouvez pas définir de restrictions lors de la création d'un Drive partagé. Pour ajouter une restriction, commencez par créer un Drive partagé, puis utilisez drives.update pour ajouter des restrictions.
restrictions.copyRequiresWriterPermission

boolean

Indique si les options permettant de copier, d'imprimer et de télécharger des fichiers dans ce Drive partagé doivent être désactivées pour les lecteurs et les commentateurs. Lorsque cette restriction est définie sur true, elle remplace le champ portant un nom similaire par true pour tous les fichiers de ce Drive partagé.
restrictions.domainUsersOnly

boolean

Permet de restreindre l'accès à ce Drive partagé et aux éléments qu'il contient aux utilisateurs du domaine auquel il appartient. Cette restriction peut être remplacée par d'autres règles de partage contrôlées en dehors de ce Drive partagé.
restrictions.driveMembersOnly

boolean

Détermine si l'accès aux éléments de ce Drive partagé est réservé à ses membres.
restrictions.adminManagedRestrictions

boolean

Indique si des droits d'administrateur sur ce Drive partagé sont nécessaires pour modifier les restrictions.
restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Si la valeur est "true", seuls les utilisateurs disposant du rôle d'organisateur peuvent partager des dossiers. Si la valeur est "false", les utilisateurs disposant du rôle d'organisateur ou d'organisateur de fichiers peuvent partager des dossiers.
orgUnitId

string

Uniquement en sortie. Unité organisationnelle de ce Drive partagé. Ce champ n'est renseigné dans les réponses drives.list que lorsque le paramètre useDomainAdminAccess est défini sur true.

Méthodes

create

 crée un Drive partagé ;

delete

 Supprime définitivement un Drive partagé dont l'utilisateur est un organizer.

get

 Récupère les métadonnées d'un Drive partagé par ID.

hide

 Masque un Drive partagé dans la vue par défaut.

list

Liste les Drive partagés de l'utilisateur.

unhide

 Restaure un Drive partagé à la vue par défaut.

update

 Met à jour les métadonnées d'un Drive partagé.