REST Resource: drives

Ressource: Drive

Darstellung einer geteilten Ablage.

Einige Ressourcenmethoden (z. B. drives.update) erfordern eine driveId. Rufen Sie mit der Methode drives.list die ID für eine geteilte Ablage ab.

JSON-Darstellung
{
  "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
}
Felder
id

string

Nur Ausgabe. Die ID dieser geteilten Ablage, die auch die ID des übergeordneten Ordners dieser geteilten Ablage ist.

name

string

Der Name dieser geteilten Ablage.

colorRgb

string

Die Farbe der geteilten Ablage als hexadezimaler RGB-String. Sie kann nur für eine drive.drives.update-Anfrage festgelegt werden, für die themeId nicht festgelegt ist.

kind

string

Nur Ausgabe. Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "drive#drive".

capabilities

object

Nur Ausgabe. Die Funktionen des aktuellen Nutzers in dieser geteilten Ablage.

capabilities.canAddChildren

boolean

Nur Ausgabe. Legt fest, ob der aktuelle Nutzer Ordner in dieser geteilten Ablage Kinder hinzufügen kann.

capabilities.canComment

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Dateien in dieser geteilten Ablage kommentieren darf.

capabilities.canCopy

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Dateien in dieser geteilten Ablage kopieren darf.

capabilities.canDeleteDrive

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer diese geteilte Ablage löschen darf. Der Versuch, die geteilte Ablage zu löschen, schlägt möglicherweise weiterhin fehl, wenn sich darin Elemente befinden, die nicht aus dem Papierkorb verschoben wurden.

capabilities.canDownload

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Dateien in dieser geteilten Ablage herunterladen kann.

capabilities.canEdit

boolean

Nur Ausgabe. Ob der aktuelle Nutzer Dateien in dieser geteilten Ablage bearbeiten darf

capabilities.canListChildren

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die untergeordneten Ordner in dieser geteilten Ablage auflisten darf.

capabilities.canManageMembers

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer dieser geteilten Ablage Mitglieder hinzufügen, Mitglieder entfernen oder seine Rolle ändern darf.

capabilities.canReadRevisions

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Ressource für Überarbeitungen von Dateien in dieser geteilten Ablage lesen kann.

capabilities.canRename

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Dateien oder Ordner in dieser geteilten Ablage umbenennen darf.

capabilities.canRenameDrive

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer diese geteilte Ablage umbenennen darf.

capabilities.canChangeDriveBackground

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer den Hintergrund dieser geteilten Ablage ändern kann.

capabilities.canShare

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Dateien oder Ordner in dieser geteilten Ablage freigeben kann.

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Einschränkung „copyRequiresWriterPermission“ für diese geteilte Ablage ändern kann.

capabilities.canChangeDomainUsersOnlyRestriction

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Einschränkung „domainUsersOnly“ für diese geteilte Ablage ändern kann.

capabilities.canChangeDriveMembersOnlyRestriction

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Einschränkung „driveMembersOnly“ für diese geteilte Ablage ändern kann.

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Einschränkung „sharingFoldersRequiresOrganizerPermission“ für diese geteilte Ablage ändern kann.

capabilities.canResetDriveRestrictions

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer die Einschränkungen für geteilte Ablagen auf die Standardeinstellungen zurücksetzen kann.

capabilities.canDeleteChildren

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Kinder aus Ordnern in dieser geteilten Ablage löschen kann.

capabilities.canTrashChildren

boolean

Nur Ausgabe. Gibt an, ob der aktuelle Nutzer Kinder aus Ordnern in dieser geteilten Ablage in den Papierkorb verschieben kann.

themeId

string

Die ID des Designs, für das das Hintergrundbild und die Farbe festgelegt werden. Die möglichen driveThemes können aus einer drive.about.get-Antwort abgerufen werden. Wenn nicht in einer drive.drives.create-Anfrage angegeben, wird ein zufälliges Design ausgewählt, aus dem das Hintergrundbild und die Farbe ausgewählt werden. Dieses Feld ist schreibgeschützt. Er kann nur für Anfragen festgelegt werden, für die colorRgb oder backgroundImageFile nicht festgelegt sind.

backgroundImageFile

object

Eine Bilddatei und Zuschneideparameter, für die ein Hintergrundbild für diese geteilte Ablage festgelegt wird. Dieses Feld ist schreibgeschützt. Sie kann nur für drive.drives.update-Anfragen festgelegt werden, für die themeId nicht festgelegt ist. Wenn dieses Flag angegeben ist, müssen alle Felder von backgroundImageFile festgelegt werden.

backgroundImageFile.id

string

Die ID einer Bilddatei in Google Drive, die als Hintergrundbild verwendet werden soll.

backgroundImageFile.xCoordinate

number

Die X-Koordinate der oberen linken Ecke des Zuschneidebereichs im Hintergrundbild. Dies ist ein Wert im geschlossenen Bereich von 0 bis 1. Dieser Wert steht für den horizontalen Abstand von der linken Seite des gesamten Bildes zur linken Seite des Zuschneidebereichs geteilt durch die Breite des gesamten Bildes.

backgroundImageFile.yCoordinate

number

Die Y-Koordinate der oberen linken Ecke des Zuschneidebereichs im Hintergrundbild. Dies ist ein Wert im geschlossenen Bereich von 0 bis 1. Dieser Wert entspricht dem vertikalen Abstand von der oberen Seite des Bilds zum oberen Rand des Zuschneidebereichs geteilt durch die Höhe des gesamten Bildes.

backgroundImageFile.width

number

Die Breite des zugeschnittenen Bilds im geschlossenen Bereich von 0 bis 1. Dieser Wert entspricht der Breite des zugeschnittenen Bildes geteilt durch die Breite des gesamten Bildes. Die Höhe wird berechnet, indem ein Seitenverhältnis von 80 bis 9 zwischen Breite und Höhe angewendet wird. Das Bild muss mindestens 1.280 Pixel breit und 144 Pixel hoch sein.

createdTime

string

Nur Ausgabe. Der Zeitpunkt, zu dem die geteilte Ablage erstellt wurde (Datum/Uhrzeit gemäß RFC 3339)

hidden

boolean

Gibt an, ob die geteilte Ablage aus der Standardansicht ausgeblendet wird.

restrictions

object

Eine Reihe von Einschränkungen, die für diese geteilte Ablage oder Elemente in dieser geteilten Ablage gelten. Beim Erstellen einer geteilten Ablage können keine Einschränkungen festgelegt werden. Wenn Sie eine Einschränkung hinzufügen möchten, erstellen Sie zuerst eine geteilte Ablage und fügen Sie dann über drives.update Einschränkungen hinzu.

restrictions.copyRequiresWriterPermission

boolean

Gibt an, ob die Optionen zum Kopieren, Drucken oder Herunterladen von Dateien in dieser geteilten Ablage für Leser und Kommentatoren deaktiviert sein sollen. Wenn diese Einschränkung auf „true“ festgelegt ist, wird das Feld mit ähnlichem Namen für „true“ für alle Dateien in dieser geteilten Ablage überschrieben.

restrictions.domainUsersOnly

boolean

Gibt an, ob der Zugriff auf diese geteilte Ablage und Elemente in dieser geteilten Ablage auf Nutzer der Domain beschränkt ist, zu der diese geteilte Ablage gehört. Diese Einschränkung kann durch andere Freigaberichtlinien überschrieben werden, die außerhalb dieser geteilten Ablage verwaltet werden.

restrictions.driveMembersOnly

boolean

Gibt an, ob der Zugriff auf Elemente in dieser geteilten Ablage auf die Mitglieder beschränkt ist.

restrictions.adminManagedRestrictions

boolean

Gibt an, ob Administratorberechtigungen für diese geteilte Ablage erforderlich sind, um Einschränkungen zu ändern.

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Bei Einstellung auf „true“ können nur Nutzer mit der Rolle „Organisator“ Ordner freigeben. Wenn „false“ festgelegt ist, können Nutzer mit der Rolle „Organisator“ oder „Dateiorganisator“ Ordner freigeben.

orgUnitId

string

Nur Ausgabe. Die Organisationseinheit dieser geteilten Ablage. Dieses Feld wird nur bei drives.list-Antworten ausgefüllt, wenn der Parameter useDomainAdminAccess auf true festgelegt ist.

Methoden

create

Eine geteilte Ablage wird erstellt.

delete

Eine geteilte Ablage, für die der Nutzer ein organizer ist, wird endgültig gelöscht.

get

Die Metadaten einer geteilten Ablage werden nach ID abgerufen.

hide

Blendet eine geteilte Ablage aus der Standardansicht aus.

list

Listet die geteilten Ablagen des Nutzers auf.

unhide

Eine geteilte Ablage wird in der Standardansicht wiederhergestellt.

update

Aktualisiert die Metadaten einer geteilten Ablage.