OneNote API div タグを使用してキャプチャからデータを抽出する
適用対象 OneDrive のコンシューマー ノートブック | Microsoft 365 のエンタープライズ ノートブック
OneNote API を使用して、画像から名刺データを抽出したり、URL からレシピや製品データを抽出したりします。
抽出の属性
データを抽出して変換するには、ソース コンテンツ、抽出方法、フォールバック動作を指定する div を 作成ページ または 更新ページ 要求に含めるだけです。 API は、抽出されたデータを読みやすい形式でページにレンダリングします。
<div
data-render-src="image-or-url"
data-render-method="extraction-method"
data-render-fallback="fallback-action">
</div>
data-render-src
コンテンツ ソース。 名刺の画像、または数多くの人気レシピや製品の Web サイトの絶対 URL にできます。 必須。
URL を指定するときに最適な結果を得るために、ソースの Web ページの HTML で定義された正規 URL を使用してください (定義されている場合)。 たとえば、正規 URL はソースの Web ページで次のように定義されます。
<link rel="canonical" href="www.domainname.com/page/123/size12/type987" />
data-render-method
実行する抽出メソッド。 必須。
| 値 | 説明 |
|---|---|
| extract.businesscard | 名刺の抽出。 |
| extract.recipe | レシピの抽出。 |
| extract.product | 製品リストの抽出。 |
| extract | 不明な種類の抽出。 |
最適の結果を得るために、コンテンツの種類 (extract.businesscard、extract.recipe、または extract.product) を指定してください (種類がわかっている場合)。 種類が不明の場合は、extract メソッドを使用してください。OneNote API が種類の自動検出を試行します。
data-render-fallback
抽出できない場合のフォールバック動作です。 省略すると、既定の render になります。
| 値 | 説明 |
|---|---|
| render | レシピまたは製品の Web ページのソース画像またはスナップショットを表示します。 |
| なし | 何も起こりません。 このオプションは、抽出コンテンツに加えて、名刺または Web ページのスナップショットをページに必ず含める場合に役立ちます。 例に示すように、要求には個別の img 要素を含めてください。 |
名刺の抽出
OneNote API は、個人または会社の名刺の画像に基づいて、次の連絡先情報の検索および表示を試行します。
- 名前
- タイトル
- 組織
- 電話および FAX 番号
- 郵送先および実際の住所
- 電子メール アドレス
- Web サイト
ページには、抽出された連絡先情報が含まれる vCard (.VCF ファイル) も組み込まれます。 この vCard は、ページの HTML コンテンツを取得するときに連絡先情報を入手するのに便利な方法です。
名刺抽出の一般的なシナリオ
名刺情報を抽出して、名刺の画像を表示する
extract.businesscard メソッドと none フォールバックを指定します。 また、画像を参照する img 属性を含む src 要素も送信します。 API ではコンテンツを抽出できない場合は、名刺の画像のみが表示されます。
<div
data-render-src="name:scanned-card-image"
data-render-method="extract.businesscard"
data-render-fallback="none">
</div>
<img src="name:scanned-card-image" />
名刺情報を抽出する。抽出に失敗した場合のみ名刺の画像を表示する
extract.businesscard メソッドを指定して、既定の render フォールバックを使用します。 API ではコンテンツを抽出できない場合は、その代わりに名刺の画像が表示されます。
<div
data-render-src="name:scanned-card-image"
data-render-method="extract.businesscard">
</div>
名刺の抽出では、画像はマルチパートの要求の名前付きパートとして送信されます。 要求で画像を送信する例については、「画像とファイルの追加」を参照してください。
レシピの抽出
OneNote API は、レシピの URL に基づいて、次の情報の検索および表示を試行します。
- 完成品画像
- 評価
- 材料
- 手順
- 準備、調理、および合計の時間
- 分量
この API は、Allrecipes.com、FoodNetwork.com、および SeriousEats.com など、数多くの人気サイトのレシピ用に最適化されています。
レシピ抽出の一般的なシナリオ
レシピ情報を抽出して、レシピの Web ページのスナップショットも表示する
extract.recipe メソッドと none フォールバックを指定します。 また、レシピの URL に設定した img 属性を含む data-render-src 要素も送信します。 API ではコンテンツを抽出できない場合は、レシピの Web ページのスナップショットのみが表示されます。
おそらく、このシナリオが最も多くの情報を提供することになります。Web ページには、お客様のレビューや提案などの追加情報が含まれている場合があるためです。
<div
data-render-src="https://allrecipes.com/recipe/guacamole/"
data-render-method="extract.recipe"
data-render-fallback="none">
</div>
<img data-render-src="https://allrecipes.com/recipe/guacamole/" />
レシピ情報を抽出する。抽出に失敗した場合のみレシピの Web ページのスナップショットも表示する
extract.recipe メソッドを指定して、既定の render フォールバックを使用します。 API ではコンテンツを抽出できない場合は、その代わりにレシピの Web ページのスナップショットが表示されます。
<div
data-render-src="https://www.foodnetwork.com/recipes/alton-brown/creme-brulee-recipe.html"
data-render-method="extract.recipe">
</div>
レシピ情報を抽出し、そのレシピへのリンクも表示する
extract.recipe メソッドと none フォールバックを指定します。 レシピの URL に設定された a 属性を含む src 要素も送信します (または、ページに追加するその他の情報を送信することもできます)。 API ではコンテンツを抽出できない場合は、レシピのリンクのみが表示されます。
<div
data-render-src="https://www.seriouseats.com/recipes/2014/09/diy-spicy-kimchi-beef-instant-noodles-recipe.html"
data-render-method="extract.recipe"
data-render-fallback="none">
</div>
<a href="https://www.seriouseats.com/recipes/2014/09/diy-spicy-kimchi-beef-instant-noodles-recipe.html">Recipe URL</a>
製品リストの抽出
- タイトル
- 評価
- 主要画像
- 説明
- 機能
- 仕様
この API は、Amazon.com や HomeDepot.com など、数多くの人気サイトの製品用に最適化されています。
レシピ抽出の一般的なシナリオ
製品情報を抽出して、製品の Web のスナップショットも表示する
extract.product メソッドと none フォールバックを指定します。 また、製品の URL に設定した img 属性を含む data-render-src 要素も送信します。 API ではコンテンツを抽出できない場合は、製品の Web ページのスナップショットのみが表示されます。
おそらく、このシナリオが最も多くの情報を提供することになります。Web ページには、お客様のレビューや提案などの追加情報が含まれている場合があるためです。
<div
data-render-src="https://www.amazon.com/Microsoft-Band-Small/dp/B00P2T2WVO"
data-render-method="extract.product"
data-render-fallback="none">
</div>
<img data-render-src="https://www.amazon.com/Microsoft-Band-Small/dp/B00P2T2WVO" />
製品情報を抽出する。抽出に失敗した場合のみ製品の Web ページのスナップショットも表示する
extract.product メソッドを指定して、既定の render フォールバックを使用します。 API ではコンテンツを抽出できない場合は、その代わりに製品の Web ページのスナップショットが表示されます。
<div
data-render-src="https://www.sears.com/craftsman-19hp-42-8221-turn-tight-174-hydrostatic-yard-tractor/p-07120381000P"
data-render-method="extract.product">
</div>
製品情報を抽出し、その製品へのリンクも表示する
extract.product メソッドと none フォールバックを指定します。 製品の URL に設定された a 属性を含む src 要素も送信します (または、ページに追加するその他の情報を送信することもできます)。 API ではコンテンツを抽出できない場合は、ページのリンクのみが表示されます。
<div
data-render-src="https://www.homedepot.com/p/Active-Ventilation-5-Watt-Solar-Powered-Exhaust-Attic-Fan-RBSF-8-WT/204203001"
data-render-method="extract.product"
data-render-fallback="none">
</div>
<a href="https://www.homedepot.com/p/Active-Ventilation-5-Watt-Solar-Powered-Exhaust-Attic-Fan-RBSF-8-WT/204203001">Product URL</a>
コンテンツの不明な種類の抽出
送信するコンテンツの種類 (名刺、レシピ、製品) がわからない場合、修飾されていない extract メソッドを使用して、OneNote API が対象種類を自動検出するようにできます。 この方法は、目的のアプリが各種のキャプチャを送信する場合に使用できます。
注:
送信するコンテンツの種類がわかっている場合は、extract.businesscard、extract.recipe、または extract.product メソッドを使用してください。 これにより、最適な抽出結果が得られるようになることがあります。
不明な抽出の一般的なシナリオ
画像または URL を送信して、抽出に失敗した場合は指定された画像または Web ページのスナップショットを表示する
API が自動的にコンテンツの種類を検出するように extract メソッドを指定して、既定の render フォールバックを使用します。 API ではコンテンツを抽出できない場合は、その代わりに指定された画像または Web ページのスナップショットが表示されます。
<div
data-render-src="some image or url"
data-render-method="extract">
</div>
応答情報
| 応答データ | 説明 |
|---|---|
| 成功コード | 成功した POST 要求に対しては 201 HTTP ステータス コード、成功した PATCH 要求に対しては 204 HTTP ステータス コードが戻ります。 |
| エラー | Microsoft Graph から返されることのある OneNote エラーに関する詳細については、「Microsoft Graph の OneNote API のエラー コード」を参照してください。 |
アクセス許可
OneNote ページを作成または更新するには、適切なアクセス許可を要求する必要があります。 アプリの動作に必要な最低限のアクセス許可を選択してください。
POST ページのアクセス許可
- Notes.Create
- Notes.ReadWrite
- Notes.ReadWrite.All
PATCH ページのアクセス許可
- Notes.ReadWrite
- Notes.ReadWrite.All
アクセス許可の範囲とその動作方法の詳細については、「Microsoft Graph のアクセス許可のリファレンス」を参照してください。