OneNote API

Microsoft の新しいドキュメントサイトをご使用ください。コンシューマーおよびエンタープライズ OneNote API を使った作業が取り上げられています。

**適用対象:**OneNote service

この API をご利用いただき、ありがとうございます。開発者は Microsoft OneNote API を使用すると、さまざまな種類のプラットフォームやデバイスで、Microsoft OneNote に格納されるユーザーの情報を作成および操作するアプリを作成できます。このトピックには、API とドキュメントに対する最新の更新一覧を掲載します。

API やドキュメントに対するご質問やその他のご意見をお持ちの場合は、「OneNote API を初めて使用する」トピックの末尾にリストされているコミュニティにご参加ください。ご意見をいただき、API やドキュメントをさらにお役に立つものにしたいと願っています。

注意

API 変更ログに関する OneNote ページ を購読し、API やドキュメントの最新の変更内容をチェックします。

OneNote ドキュメントと API の変更点

2015 年 9 月

$top クエリ オプションを使用した GET pages 要求で返されるページの最大数が 500 から 100 に変更されました。

2015 年 7 月

OneNote REST API エクスプローラーの 2 つのサンプル アプリをリリースしました。

運用向けに DELETE ページ をリリースしました。

操作方法のトピックのルート サービス URL を更新し、新しい、推奨される /me/notes/ ルートを使用するようにしました。https://www.onenote.com/api/v1.0/me/notes/

2015 年 6 月

ノート シールの使用」トピックを発行しました。

2015 年 5 月

エラー コードの変更と、「エラー コードと警告コード」トピックの更新を行いました。

 削除: 20103、 20104、20105、20114、20116、20118
追加: 20150、20151、20152、20153、20154、20155、20156、20157、20158
変更: 20115 (ノードブック名の無効な文字のセットを変更)

エンティティ名の検証に関連するエラーを処理する場合、これが互換性に影響を及ぼす変更となる可能性があります。次の表に、こうした変更の処理方法を示します。

ご使用のコードにおける置換前のエラー コード

置換後のエラー コード

20105 (SectionNameEmpty)
20116 (NameEmpty)

20152 (EntityNameEmpty)

20104 (SectionNameInvalidChar)

20153 (EntityNameInvalidChar)

20118 (SectionNameInvalidStart)

20154 (EntityNameInvalidStart)

20103 (SectionNameTooLong)
20114 (NotebookNameTooLong)

20155 (EntityNameTooLong)

2015 年 4 月

運用環境に修正プログラムをリリースしました。「ページ コンテンツの更新」トピックを公開しました。

2015 年 2 月

次の API を運用環境にリリース。

  • ページ クエリ

  • フルテキスト検索

  • ページ コンテンツの取得

  • 絶対的な位置要素の作成

記事「OneNote ページの HTML 入出力」および「絶対的な位置要素を使用したページの作成」の公開と「OneNote コンテンツと構造を取得する」の更新。OneNote 開発者ブログ および OneNote API 対話型リファレンス での関連情報の投稿。

2015 年 1 月

GitHubWindows ユニバーサル アプリ サンプルを投稿しました。名刺、レシピ URL、または製品 URL の拡張 API、および expand クエリ文字列オプションのサポートをリリースしました。「取り込んだコンテンツの拡張」および「ノートブック階層内のオブジェクトの取得」 という記事を発行しました。

2014 年 10 月

リファレンス ドキュメントを新しい OneNote API 対話型コンソールに移動しました。

2014 年 7 月

次の追加機能に関するリファレンスを追加しました。

  • OneNote GET セクション

  • OneNote GET セクション/ID

  • OneNote GET セクション グループ

  • OneNote GET セクション グループ/ID

  • OneNote GET ノートブック

  • OneNote GET ノートブック/ID

  • OneNote POST ノートブック

  • OneNote POST ノートブック/ID/セクション

  • OneNote API のエラー コードと警告コード

2014 年 6 月

「OneNote API リファレンス」セクションの形式を改訂しました。

2014 年 4 月 29 日の週、マイナー アップデート

この最初の更新では、PDF ドキュメントを処理するアプリを作成している開発者や、特定のノートブック セクションに移動して情報を取り込もうとしている開発者にとって便利な機能を実現できました。

  • **PDF をイメージとして OneNote ページ上に直接レンダリングできるようになりました。**この更新では、<img data-render-src="name:BlockOfPDFData"/> を追加すると、OneNote API が PDF ページをイメージとしてレンダリングし、それをページ上に挿入します。PDF ファイルをページ上に埋め込む一般的な方法として、<object data-render-src="name:BlockOfPDFData"/> タグを使用することもできます。同じ BlockOfPDFData を両方のタグで参照することも可能です。この更新の前でも、ファイルをページ上に埋め込むことはできましたが、同じ PDF データからイメージをレンダリングすることはできませんでした。詳しくは、OneNote API を使用した PDF ファイルの取り込みと埋め込み の方法に関する記事を参照してください。

  • **特定のセクション内にページを作成できるようになりました。**そのためには、ページの POST 要求に sectionName クエリ パラメーターを含めます。指定した最上位レベルのセクション名が存在しない場合は、API によって自動的に作成されます。この新機能を活用すると、アプリが取り込んだ内容をわかりやすいセクションに格納できるようになります。詳細については、「特定セクション内のページを OneNote API を使用して取り込む」を参照してください。

ドキュメントに以下の変更を加えました。

2014 年 3 月 17 日、初回リリース

OneNote API の最新のハイライトを以下に示します。

  • API バージョン 1.0 が使用できるようになりました。主な REST エンドポイントは、https://www.onenote.com/api/v1.0 です。現在使用できるリソース パスは /pages のみですが、さらに大きな計画が立てられています。

  • 初回リリースでは、この API は新しい OneNote ページの作成方法として、HTML を使ってページを定義する方法をサポートしています。各 OneNote ページに画像やその他の種類の埋め込みバイナリ ファイル (ファイル当たり最大 25MB、全ページ当たり 75MB) を組み込むことができます。この API は、Web ページのスナップショットを作成し、そのページを OneNote ページ上に画像として組み込むことができます。アプリでキャプチャした画像に対して OCR を実行することもできます。

  • アプリが稼働できるようになるには、その前にクライアント ID か、または Windows 8 ストア アプリを作成している場合はパッケージ ID が必要です。完全な情報については、「OneNote API で使用するクライアント ID を取得する」を参照してください。

  • さらに、OneNote API では、アプリのユーザーに Microsoft アカウントが必要です。必ずしも Microsoft のデバイスを使用する必要はありませんが、Microsoft アカウントは必要です。Windows Live Connect SDK の使用方法について詳しくは、「OneNote API のユーザーを認証する」を参照してください。

このドキュメントの初期セットに、次のセクションが含まれています。

  • OneNote API を初めて使用する」。この API について概説し、簡単に使用できることを紹介しています。このセクションには、主なアプリ プラットフォーム向けのチュートリアルも掲載されており、すぐに使ってみることができます。

  • OneNote API を使用して開発する。この API について学習し、この API を使って作業するにつれて行えるようになる事柄についてのコード スニペットと情報があります。

  • Apigee.com の対話型コンソール により、apigee.com で API を試してみることができます。

ドキュメント内に問題がありましたらいつでもご連絡ください。またこれらのドキュメントが必要にかなっているかお知らせください。この API は、アプリの開発を始めたばかりの方と経験豊富な方の両方を対象にしていますので、ぜひご要望をお知らせください。