driveItem: preview

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

この操作により、一時的なプレビューをレンダリングするために、アイテムの有効期間の短い埋め込み可能な URL を取得できます。

有効期間が長い埋め込みリンクを取得したい場合は、代わりに createLink API を使用してください。

注:

現在、プレビュー操作は SharePoint および OneDrive for Business でのみ使用できます。

注意

プレビュー URL は呼び出し元自身が使用するためのものであり、他のユーザーと共有しないでください。 プレビューは呼び出し元の ID に代わってレンダリングされ、URL にアクセスするすべてのユーザーが呼び出し元のアクセス許可を持つ呼び出し元として機能します。 これは、アプリがファイルへのアクセス read-write を持っているが、エンド ユーザーに read-only アクセス権を提供する場合に特に重要です。 このような場合は、DOM アクセスをページ内部に制限したり、読み取り専用アクセス権を持つアプリケーション ID を使用してプレビュー URL を取得したりするなどの予防措置を講じてください。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Files.Read Files.Read.All, Files.ReadWrite, Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Files.Read.All Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All

注:

SharePoint Embedded では、コンテナーのコンテンツにアクセスするための FileStorageContainer.Selected アクセス許可が必要です。 このアクセス許可は、前述のアクセス許可とは異なります。 Microsoft Graph のアクセス許可に加えて、アプリにはこの API を呼び出すために必要な コンテナーの種類のアクセス許可 が必要です。 詳細については、「 SharePoint Embedded の認証と承認」を参照してください。

HTTP 要求

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

要求本文

要求の本文は、アプリケーションが要求する埋め込み可能 URL のプロパティを定義します。 要求は、次のプロパティを含む JSON オブジェクトである必要があります。

名前 型 説明
閲覧者 string 省略可能。 使用するアプリをプレビューします。 onedrive または office。 null の場合、適切なビューアーが自動的に選択されます。
クロームレス ブール値 省略可能。 true (既定) の場合、埋め込みビューにはコントロールは含まれません。
allowEdit ブール値 省略可能。 trueの場合は、埋め込み UI からファイルを編集できます。
page 文字列/数値 省略可能。 該当する場合、開始するドキュメントのページ数。 ZIP などのファイルの種類に関する将来のユース ケースの文字列として指定されます。
ズーム 番号 省略可能。 該当する場合に開始するズーム レベル。

応答

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

応答は、次のプロパティが含まれる JSON オブジェクトになります。

名前 型 説明
getUrl string HTTP GET を使用した埋め込みに適した URL (iframe など)
postUrl string HTTP POSTを利用した埋め込みに適したURL (form post、JSなど)
postParameters string postUrl を使用する場合に含める POST パラメーター

指定したオプションに対する埋め込みサポートの現在の状態によっては、getUrl、postUrl、またはその両方が返される場合があります。

postParameters は application/x-www-form-urlencoded 形式の文字列であり、postUrl への POST を実行する場合は、それに応じて content-type を設定する必要があります。 例:

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

param1=value&param2=another%20value

閲覧者

メモ: このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できなくなります。

ビューアー パラメーターでは、次の値を指定できます。

種類の値 説明
(null) ファイルのレンダリングに適したアプリを選択します。 ほとんどの場合、 onedrive プレビューアーが使用されますが、ファイルの種類によって異なる場合があります。
onedrive OneDrive プレビューアー アプリを使用してファイルをレンダリングします。
office Web バージョンの Office を使用してファイルをレンダリングします。 Office ドキュメントに対してのみ有効です。

クロムとクロムレス

メモ: このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できなくなります。

chromeless が true の場合、プレビューはファイルの最小限のレンダリングになります。 それ以外の場合は、ドキュメント/ビューを操作するための追加のツールバー/ボタンが表示されることがあります。

表示/編集

メモ: このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できなくなります。

allowEdit が true の場合、埋め込みプレビューを操作するユーザー操作によってドキュメントを変更できます。 この機能は、すべてのプレビュー アプリまたはファイルの種類で使用できるとは限りません。

ページ/ズーム

pageとzoomのオプションはすべてのプレビュー アプリで使用できるわけではありませんが、プレビュー アプリでサポートされている場合は適用されます。

  • Last updated on