Einbettbare Dateivorschau

Artikel
04/08/2023

Mit dieser Aktion können Sie kurzlebige einbettbare URLs für ein Element abrufen.

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

Berechtigungen

Eine der folgenden Berechtigungen ist erforderlich, um diese API aufzurufen. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Files.Read, Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Files.Read, Files.ReadWrite, Files.ReadWrite.All
Anwendung	N/V

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 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. Vorschau der zu verwendenden App. `onedrive` oder `office`. Bei NULL wird automatisch ein geeigneter Viewer ausgewählt.
Chromlos	Boolescher Wert	Optional. Wenn `true` (Standard) ist, enthält die eingebettete Ansicht keine Steuerelemente.
Allowedit	Boolescher Wert	Optional. Gibt `true`an, dass die Datei über die eingebettete Benutzeroberfläche bearbeitet werden kann.
Seite	Zeichenfolge/Zahl	Optional. Seitenzahl des Dokuments, bei dem begonnen werden soll, falls zutreffend. Wird als Zeichenfolge für zukünftige Anwendungsfälle für Dateitypen wie ZIP angegeben.
Zoom	number	Optional. Zoomfaktor, der ggf. beginnen soll.

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, das die folgenden Eigenschaften enthält:

Name	Typ	Beschreibung
Geturl	string	URL, die für die Einbettung mit HTTP GET (iframes usw.) geeignet ist
postUrl	string	URL, die für die Einbettung mit HTTP POST (Formularpost, JS usw.) geeignet ist
postParameters	string	EINzufügende POST-Parameter bei Verwendung von postUrl

Je nach aktuellem Status der Einbettungsunterstützung für die angegebenen Optionen können entweder getUrl, postUrl oder beide zurückgegeben werden.

postParameters ist eine Zeichenfolge, die als application/x-www-form-urlencodedformatiert ist, und wenn ein POST an die postUrl ausgeführt wird, sollte der Inhaltstyp entsprechend festgelegt werden. Beispiel:

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

param1=value&param2=another%20value

Anzeigende Benutzer

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

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

Chrome im Vergleich zu Chromeless

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

Anzeigen/Bearbeiten

Wenn "Bearbeiten" 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 Optionen "Seite" und "Zoom" sind möglicherweise nicht für alle Vorschau-Apps verfügbar, werden jedoch angewendet, wenn die Vorschau-App sie unterstützt.

Freigeben über