driveItem: プレビュー

名前空間: microsoft.graph

重要

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

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

有効期間の長い埋め込み可能なリンクを取得する場合は、代わりに createLink API を 使用します。

手記：プレビュー アクションは現在、SharePoint と OneDrive for Business でのみ使用できます。

この 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

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 の場合、適切なビューアーが自動的に選択されます。
chromeless	ブール値	省略可能。 true (既定値) の場合、埋め込みビューにはコントロールは含まれません。
allowEdit	ブール値	省略可能。 true場合、埋め込み UI からファイルを編集できます。
page	string/number	省略可能。 開始するドキュメントのページ番号 (該当する場合)。 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 (iframe など) を使用した埋め込みに適した URL
postUrl	文字列	HTTP POST (フォーム投稿、JS など) を使用した埋め込みに適した URL
postParameters	string	postUrl を使用している場合に含める POST パラメーター

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

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

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

param1=value&param2=another%20value

閲覧者

手記： このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できません。

viewer パラメーターには、次の値を使用できます。

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

Chrome と chromeless

手記： このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できません。

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

表示/編集

手記： このパラメーターは非推奨であり、v1.0 エンドポイントでは使用できません。

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

ページ/ズーム

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