driveItem: Vorschau

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Mit dieser Aktion können Sie kurzlebige einbettbare URLs für ein Element abrufen, um eine temporäre Vorschau zu rendern.

Wenn Sie langlebige einbettbare Links erhalten möchten, verwenden Sie stattdessen die createLink-API .

Hinweis

Die Vorschauaktion ist derzeit nur in SharePoint und OneDrive for Business verfügbar.

Achtung

Die Vorschau-URL ist für den persönlichen Gebrauch des Anrufers bestimmt und sollte nicht an andere Benutzer weitergegeben werden. Die Vorschau wird im Namen der anrufenden Identität gerendert, und jeder, der auf die URL zugreift, agiert als Aufrufer mit den Berechtigungen des Aufrufers. Dies ist besonders wichtig in Anwendungsberechtigungsszenarien, in denen Ihre App Zugriff auf die Datei hat read-write , Sie aber beabsichtigen, Endbenutzern Zugriff zu gewähren read-only . Ergreifen Sie in solchen Fällen Vorsichtsmaßnahmen wie das Einschränken des DOM-Zugriffs auf Seiteninterna und das Abrufen der Vorschau-URL mithilfe einer Anwendungsidentität mit schreibgeschütztem Zugriff.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Files.Read Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Files.Read.All Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Hinweis

SharePoint Embedded benötigt die FileStorageContainer.Selected Berechtigung für den Zugriff auf den Inhalt des Containers. Diese Berechtigung unterscheidet sich von den zuvor erwähnten. Zusätzlich zu den Microsoft Graph-Berechtigungen muss Ihre App über die erforderlichen Containertypberechtigungen verfügen, um diese API aufzurufen. Weitere Informationen finden Sie unter SharePoint Embedded-Authentifizierung und -Autorisierung.

HTTP-Anforderung

POST /drives/{driveId}/items/{itemId}/preview
POST /groups/{groupId}/drive/items/{itemId}/preview
POST /me/drive/items/{itemId}/preview
POST /sites/{siteId}/drive/items/{itemId}/preview
POST /users/{userId}/drive/items/{itemId}/preview
POST /shares/{shareId}/driveItem/preview

Anforderungstext

Der Text der Anforderung definiert die Eigenschaften der einbettbaren URL, die Ihre Anwendung anfordert. Bei der Anforderung sollte es sich um ein JSON-Objekt mit folgenden Eigenschaften handeln:

Name Typ Beschreibung
Viewer string Optional. Zu verwendende Vorschau-App. onedrive oder office. Wenn null, wird automatisch ein geeigneter Viewer ausgewählt.
Chromlos Boolescher Wert Optional. Wenn true (Standard), enthält die eingebettete Ansicht keine Steuerelemente.
allowEdit Boolescher Wert Optional. If true, kann die Datei über die eingebettete Benutzeroberfläche bearbeitet werden.
Seite Zeichenfolge/Zahl Optional. Seitenzahl des Dokuments, mit dem begonnen werden soll, falls zutreffend. Als Zeichenfolge für zukünftige Anwendungsfälle rund um Dateitypen wie ZIP angegeben.
Zoom number Optional. Zoomfaktor zum Starten, falls zutreffend.

Antwort

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

Die Antwort ist ein JSON-Objekt mit den folgenden Eigenschaften:

Name Typ Beschreibung
getUrl string URL geeignet zum Einbetten mit HTTP GET (iframes usw.)
postUrl string URL geeignet für die Einbettung mittels HTTP POST (Form Post, JS etc.)
postParameters string POST-Parameter, die bei Verwendung von postUrl enthalten sein sollen

Entweder getUrl, postUrl oder beide werden zurückgegeben, abhängig vom aktuellen Stand der Einbettungsunterstützung für die angegebenen Optionen.

postParameters ist eine Zeichenfolge, die als formatiert ist application/x-www-form-urlencoded, und wenn Sie einen POST an die postUrl durchführen, sollte der Inhaltstyp entsprechend festgelegt werden. Zum Beispiel:

POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded

param1=value&param2=another%20value

Anzeigende Benutzer

Hinweis: Dieser Parameter ist veraltet und wird auf dem v1.0-Endpunkt nicht verfügbar gemacht.

Die folgenden Werte sind für den Viewer-Parameter zulässig.

Typwert Beschreibung
(NULL) Wählt eine geeignete App zum Rendern der Datei aus. In den meisten Fällen wird dazu die onedrive Vorschau verwendet, dies kann jedoch je nach Dateityp variieren.
onedrive Verwenden Sie die OneDrive-Vorschau-App, um die Datei zu rendern.
office Verwenden Sie die Webversion von Office, um die Datei zu rendern. Nur gültig für Office-Dokumente.

Chrome vs. Chromlos

Hinweis: Dieser Parameter ist veraltet und wird auf dem v1.0-Endpunkt nicht verfügbar gemacht.

Wenn der chromeless Wert TRUE ist, ist die Vorschau ein bloßes Rendering der Datei. Andernfalls werden möglicherweise zusätzliche Symbolleisten/Schaltflächen für die Interaktion mit dem Dokument/der Ansicht angezeigt.

Anzeigen/Bearbeiten

Hinweis: Dieser Parameter ist veraltet und wird auf dem v1.0-Endpunkt nicht verfügbar gemacht.

Wenn der allowEdit Wert true ist, kann das Dokument durch Benutzerinteraktion mit der eingebetteten Vorschau geändert werden. Diese Funktion ist möglicherweise nicht für alle Vorschau-Apps oder Dateitypen verfügbar.

Seite/Zoom

Die page Optionen "und zoom " sind möglicherweise nicht für alle Vorschau-Apps verfügbar, werden aber angewendet, wenn die Vorschau-App dies unterstützt.

  • Last updated on