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 abrufen möchten, verwenden Sie stattdessen die createLink-API .
Anmerkung: Die Vorschauaktion ist derzeit nur in SharePoint und OneDrive for Business verfügbar.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. 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 |
Anwendung | Files.Read.All | Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
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 |
---|---|---|
Betrachter | string | Optional. Vorschau der zu verwendenden App.
onedrive oder office . Wenn NULL ist, 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¶m2=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-urlencoded
formatiert ist, und wenn ein POST an die postUrl ausgeführt wird, 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¶m2=another%20value
Anzeigende Benutzer
Anmerkung: Dieser Parameter ist veraltet und wird nicht auf dem v1.0-Endpunkt 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 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 Webversion von Office, um die Datei zu rendern. Nur gültig für Office-Dokumente. |
Chrome vs chromeless
Anmerkung: Dieser Parameter ist veraltet und wird nicht auf dem v1.0-Endpunkt verfügbar gemacht.
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
Anmerkung: Dieser Parameter ist veraltet und wird nicht auf dem v1.0-Endpunkt verfügbar gemacht.
Wenn allowEdit
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 jedoch angewendet, wenn die Vorschau-App sie unterstützt.