driveItem: プレビュー

[アーティクル]
04/21/2024

名前空間: microsoft.graph

このアクションを使用すると、一時的なプレビューをレンダリングするために、アイテムの有効期間が短い埋め込み可能な 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

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
Content-Type	application/json. 必須です。

要求本文

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

名前	型	説明
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	string	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

ページ/ズーム

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