driveItem: preview

名前空間: microsoft.graph

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

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

注: プレビュー アクション は現在、ユーザーとSharePointでのみOneDrive for Business。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Files.Read、Files.ReadWrite、Files.Read.All、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 オブジェクトである必要があります。

名前	型	説明
page	string/number	省略可能です。 該当する場合、開始するドキュメントのページ番号。 ZIP などのファイルの種類に関する将来の使用例を示す文字列として指定します。
ズーム	number	省略可能。 必要に応じ、ズーム レベルを開始します。

応答

{
    "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 オブジェクトになります。

Name	型	説明
getUrl	string	HTTP GET (iframes など) を使用した埋め込みに適した URL
postUrl	文字列	HTTP POST を使用した埋め込みに適した URL (フォーム投稿、JS など)
postParameters	string	postUrl を使用する場合に含める POST パラメーター

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

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

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

param1=value&param2=another%20value

ページ/ズーム

[ページ] および [ズーム] オプションは、すべてのプレビュー アプリで使用できない場合がありますが、プレビュー アプリでサポートされている場合は適用されます。