REST Resource: drives

Ressource: Drive

Représentation 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é. 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 de cette valeur. Valeur: chaîne fixe "drive#drive".

capabilities

object

Uniquement en sortie. Fonctionnalités dont dispose 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. Si l'utilisateur actuel peut ajouter des commentaires aux fichiers de ce Drive partagé.

capabilities.canCopy

boolean

Uniquement en sortie. 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 si elle contient des éléments non supprimés.

capabilities.canDownload

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut télécharger les fichiers de ce Drive partagé.

capabilities.canEdit

boolean

Uniquement en sortie. Autoriser ou non l'utilisateur actuel à modifier les fichiers de ce Drive partagé

capabilities.canListChildren

boolean

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

capabilities.canManageMembers

boolean

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

capabilities.canReadRevisions

boolean

Uniquement en sortie. Indique si l'utilisateur actuel peut lire la ressource de révision 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 valeurs par défaut des restrictions du Drive partagé.

capabilities.canDeleteChildren

boolean

Uniquement en sortie. Si l'utilisateur actuel peut supprimer des enfants des dossiers de ce Drive partagé.

capabilities.canTrashChildren

boolean

Uniquement en sortie. Si l'utilisateur actuel peut placer les enfants dans les 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 de fond et la couleur sont définies. Ce champ en écriture seule ne peut être défini que pour les requêtes qui ne définissent pas colorRgb ni backgroundImageFile.

backgroundImageFile

object

Un fichier image et des paramètres de recadrage avec lesquels une image de fond est définie pour ce Drive partagé. Ce champ en écriture seule ne peut être défini que sur des requêtes drive.drives.update qui ne définissent pas de themeId. Si spécifié, tous les champs de backgroundImageFile doivent être définis.

backgroundImageFile.id

string

ID d'un fichier image Google Drive à utiliser comme image d'arrière-plan.

backgroundImageFile.xCoordinate

number

Coordonnée X de l'angle supérieur gauche de la zone recadrée dans l'image de fond. Il s'agit d'une valeur comprise entre 0 et 1. Cette valeur représente la distance horizontale du côté gauche de l'image entière par rapport au côté gauche de la zone de recadrage, divisée par la largeur de l'image.

backgroundImageFile.yCoordinate

number

Coordonnée Y de l'angle supérieur gauche de la zone recadrée dans l'image de fond. Il s'agit d'une valeur comprise entre 0 et 1. Cette valeur représente la distance verticale entre le bord supérieur de l'image entière et le haut de la zone de recadrage, divisé par la hauteur de toute l'image.

backgroundImageFile.width

number

Largeur de l'image recadrée dans la plage fermée (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 mesurer au moins 1 280 pixels de large sur 144 pixels de haut.

createdTime

string

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

hidden

boolean

Indique si le Drive partagé est masqué dans la vue par défaut.

restrictions

object

Ensemble de restrictions qui s'appliquent à ce Drive partagé ou aux éléments qu'il contient.

restrictions.copyRequiresWriterPermission

boolean

Indique si les options de copie, d'impression et de téléchargement des fichiers de 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 le même nom par true pour tout fichier de ce Drive partagé.

restrictions.domainUsersOnly

boolean

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

restrictions.driveMembersOnly

boolean

Indique si l'accès aux éléments de ce Drive partagé est limité à ses membres.

restrictions.adminManagedRestrictions

boolean

Indique si les droits d'administrateur de ce Drive partagé sont requis 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 définie sur "false", les utilisateurs disposant du rôle d'organisateur ou du rôle d'organisateur de fichiers peuvent partager des dossiers.

orgUnitId

string

Uniquement en sortie. Unité organisationnelle de ce Drive partagé. Ce champ n'est renseigné que dans les réponses drives.list 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 organisateur.

get

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

hide

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

list

Liste les Drive partagés de l'utilisateur.

unhide

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

update

Met à jour la métadate d'un Drive partagé.