driveItem: VorschaudriveItem: preview

Namespace: microsoft.graphNamespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported. Um zu ermitteln, ob eine API in v 1.0 verfügbar ist, verwenden Sie die Versions Auswahl.To determine whether an API is available in v1.0, use the Version selector.

Mit dieser Aktion können Sie kurzzeitige integrierbare URLs für ein Element abrufen, um eine temporäre Vorschau zu rendern.This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview.

Wenn Sie langlebige integrierbare Links erhalten möchten, verwenden Sie stattdessen die CreateLink -API.If you want to obtain long-lived embeddable links, use the createLink API instead.

Hinweis: Die Vorschau Aktion ist derzeit nur in SharePoint und OneDrive für Unternehmen verfügbar.Note: The preview action is currently only available on SharePoint and OneDrive for Business.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Nicht unterstütztNot supported.
AnwendungApplication Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

HTTP-AnforderungHTTP request

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

AnforderungstextRequest body

Der Text der Anforderung definiert die Eigenschaften der Einbettungs-URL, die von der Anwendung angefordert wird.The body of the request defines properties of the embeddable URL your application is requesting. Bei der Anforderung sollte es sich um ein JSON-Objekt mit folgenden Eigenschaften handeln:The request should be a JSON object with the following properties.

NameName TypType BeschreibungDescription
Viewerviewer stringstring Optional.Optional. Vorschau der zu verwendenden app.Preview app to use. onedrive oder office.onedrive or office. Bei Null wird automatisch ein geeigneter Viewer ausgewählt.If null, a suitable viewer will be chosen automatically.
Chromelesschromeless booleanboolean Optional.Optional. Wenn true (Standard), enthält die eingebettete Ansicht keine Steuerelemente.If true (default), the embedded view will not include any controls.
allowEditallowEdit booleanboolean Optional.Optional. Wenn true die Datei von der eingebetteten Benutzeroberfläche bearbeitet werden kann.If true, the file can be edited from the embedded UI.
Seitepage Zeichenfolge/Zahlstring/number Optional.Optional. Seitenzahl des zu beginnenden Dokuments, falls zutreffend.Page number of document to start at, if applicable. Als Zeichenfolge für zukünftige Anwendungsfälle um Dateitypen wie ZIP angegeben.Specified as string for future use cases around file types such as ZIP.
Zoomzoom numbernumber Optional.Optional. Vergrößerungsstufe, wenn zutreffend, um zu beginnen.Zoom level to start at, if applicable.

AntwortResponse

{
    "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, das die folgenden Eigenschaften enthält:The response will be a JSON object containing the following properties:

NameName TypType BeschreibungDescription
getURLgetUrl Zeichenfolgestring URL, die für das Einbetten mit HTTP Get geeignet ist (IFrames usw.)URL suitable for embedding using HTTP GET (iframes, etc.)
postUrlpostUrl Zeichenfolgestring URL, die für das Einbetten mit HTTP-Post geeignet ist (Formular Beitrag, JS, usw.)URL suitable for embedding using HTTP POST (form post, JS, etc.)
postparameterpostParameters Zeichenfolgestring Post-Parameter einschließen, wenn mit haltunglPOST parameters to include if using postUrl

Je nach aktuellem Status der Einbettungs Unterstützung für die angegebenen Optionen wird möglicherweise entweder getURL, Posel oder beides zurückgegeben.Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options.

postparameters ist eine Zeichenfolge, die als formatiert ist application/x-www-form-urlencoded , und wenn ein Beitrag in der Haltungs Ausführung ausgeführt wird, sollte der Inhaltstyp entsprechend festgelegt werden.postParameters is a string formatted as application/x-www-form-urlencoded, and if performing a POST to the postUrl the content-type should be set accordingly. Zum Beispiel:For example:

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

param1=value&param2=another%20value

Anzeigende BenutzerViewers

Hinweis: Dieser Parameter ist veraltet und wird nicht auf dem v 1.0-Endpunkt zur Verfügung gestellt.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Die folgenden Werte sind für den Viewer -Parameter zulässig.The following values are allowed for the viewer parameter.

TypwertType value BeschreibungDescription
NULL(null) Wählt eine geeignete App zum Rendern der Datei aus.Chooses an appropriate app for rendering the file. In den meisten Fällen wird die onedrive Vorschau verwendet, kann jedoch je nach Dateityp variieren.In most cases this will use the onedrive previewer, but may vary by file type.
onedrive Verwenden Sie die OneDrive-Vorschau-APP, um die Datei zu rendern.Use the OneDrive previewer app to render the file.
office Verwenden Sie die Office-Webversion, um die Datei zu rendern.Use the web version of Office to render the file. Gilt nur für Office-Dokumente.Only valid for Office documents.

Chrome vs ChromChrome vs chromeless

Hinweis: Dieser Parameter ist veraltet und wird nicht auf dem v 1.0-Endpunkt zur Verfügung gestellt.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Wenn chromeless true ist, ist die Vorschau eine bloße Darstellung der Datei.If chromeless is true, the preview will be a bare rendering of the file. Andernfalls können zusätzliche Symbolleisten/Schaltflächen für die Interaktion mit dem Dokument/der Ansicht angezeigt werden.Otherwise, there may be additional toolbars/buttons displayed for interacting with the document/view.

Anzeigen/bearbeitenView/edit

Hinweis: Dieser Parameter ist veraltet und wird nicht auf dem v 1.0-Endpunkt zur Verfügung gestellt.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Wenn allowEdit true ist, kann das Dokument durch Benutzerinteraktion mit der eingebetteten Vorschau geändert werden.If allowEdit is true, the document can be modified by user interaction with the embedded preview. Diese Funktion steht möglicherweise nicht für alle Vorschau-Apps oder Dateitypen zur Verfügung.This capability may not be available for all preview apps or file types.

Seite/ZoomPage/zoom

Die page Optionen "und" sind zoom möglicherweise nicht für alle Vorschau-apps verfügbar, werden jedoch angewendet, wenn Sie von der Vorschau-App unterstützt werden.The page and zoom options might not be available for all preview apps, but will be applied if the preview app supports it.