埋め込み可能なファイルプレビュー

[アーティクル]
04/08/2023

このアクションを使用すると、アイテムの埋め込み可能な短い URL を取得できます。

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

アクセス許可

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

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Files.Read、Files.ReadWrite、Files.ReadWrite.All、Sites.ReadWrite.All
委任 (個人用 Microsoft アカウント)	Files.Read、Files.ReadWrite、Files.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 の場合、適切なビューアーが自動的に選択されます。
クロムレス	ブール値	オプション。 (既定値) の場合 `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	文字列	HTTP GET (iframe など) を使用した埋め込みに適した URL
postUrl	文字列	HTTP POST (フォーム投稿、JS など) を使用した埋め込みに適した URL
postParameters	文字列	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

閲覧者

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

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

Chrome と Chromeless

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

表示/編集

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

ページ/ズーム

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

埋め込み可能なファイル プレビュー