Microsoft Graph によって OneNote コンテンツと構造を取得するGet OneNote content and structure with Microsoft Graph

適用対象: OneDrive のコンシューマー ノートブック | Office 365 のエンタープライズ ノートブックApplies to: Consumer notebooks on OneDrive | Enterprise notebooks on Office 365

OneNote のコンテンツと構造を取得するには、ターゲット エンドポイントに GET 要求を送信します。たとえば次のようにします。To get OneNote content and structure, you send a GET request to the target endpoint. For example:

GET ../onenote/pages/{id}

要求が成功すると、Microsoft Graph は 200 HTTP 状態コードと、要求したエンティティまたはコンテンツを返します。If the request is successful, Microsoft Graph returns a 200 HTTP status code and the entities or content that you requested. OneNote のエンティティは、OData バージョン 4.0 仕様に準拠した JSON オブジェクトとして返されます。OneNote entities are returned as JSON objects that conform to the OData version 4.0 specification.

クエリ文字列オプションを使用すると、クエリをフィルターしてパフォーマンスを向上させることができます。By using query string options, you can filter your queries and improve performance.

要求 URI の構築Construct the request URI

要求 URI を構築するには、サービス ルート URL から開始します。To construct the request URI, start with the service root URL:

https://graph.microsoft.com/v1.0/me/onenote


次に、取得するリソースのエンドポイントを追加します (リソース パスについては次のセクションを参照してください)。Then append the endpoint of the resource you want to retrieve. (Resource paths are shown in the next section.)

完全な要求 URI は、次に示す例のいずれかのようになります。Your full request URI will look like one of these examples:

  • https://graph.microsoft.com/v1.0/me/onenote/notebooks/{id}/sections
  • https://graph.microsoft.com/v1.0/me/onenote/notes/pages
  • https://graph.microsoft.com/v1.0/me/onenote/pages?select=title,self

注: サービス ルート URL の詳細についてはリンク先をご覧ください。Note: Learn more about the service root URL.

GET 要求のリソース パスResource paths for GET requests

次のリソース パスを使用して、ページ、セクション、セクション グループ、ノートブック、画像、またはファイル リソースを取得します。Use the following resource paths to get pages, sections, section groups, notebooks, and image or file resources.

ページ コレクションPage collection

すべてのノートブックのページ (メタデータ) を取得する。Get pages (metadata) across all notebooks.

../pages[?filter,orderby,select,expand,top,skip,search,count]


特定のセクションからページ (メタデータ) を取得する。Get pages (metadata) from a specific section.

../sections/{section-id}/pages[?filter,orderby,select,expand,top,skip,search,count,pagelevel]


`search`クエリ文字列オプションは、コンシューマー ノートパソコンでのみ使用できます。The `search` query string option is available for consumer notebooks only.

ページの既定の並べ替え順序は lastModifiedTime desc です。The default sort order for pages is lastModifiedTime desc.

既定のクエリは、親セクションを展開し、セクションの idname、および self プロパティを選択します。The default query expands the parent section and selects the section's id, name, and self properties.

既定では、GET ページ要求に対して上位 20 のエントリのみが返されます。By default, only the top 20 entries are returned for GET pages requests. 上位クエリ文字列オプションを指定しない要求を行った場合、次の 20 エントリを取得するために使用できる @odata.nextLink リンクが応答で返されます。Requests that don't specify a top query string option return an @odata.nextLink link in the response that you can use to get the next 20 entries.

セクションのページ コレクションの場合、pagelevel を使用して、ページのインデント レベルとセクション内でのその順序を返します。For the pages collection in a section, use pagelevel to return the indentation level of pages and their order within the section.

Example

GET ../sections/{section-id}/pages?pagelevel=true

ページ エンティティPage entity

特定のページのメタデータを取得するGet the metadata for a specific page.

../pages/{page-id}[?select,expand,pagelevel]


ページは、parentNotebook プロパティと parentSection プロパティを展開できます。Pages can expand the parentNotebook and parentSection properties.

既定のクエリは、親セクションを展開し、セクションの idname、および self プロパティを選択します。The default query expands the parent section and selects the section's id, name, and self properties.

pagelevel を使用して、ページのインデント レベルと親セクション内でのその順序を返します。Use pagelevel to return the indentation level of the page and its order within its parent section.

Example

GET ../pages/{page-id}?pagelevel=true

ページ プレビューPage preview

ページのテキストと画像のプレビュー コンテンツを取得する。Get text and image preview content for a page.

../pages/{page-id}/preview


JSON 応答には、ページに含まれているものを特定するために使用できる、プレビュー コンテンツが含まれています。The JSON response contains the preview content, which you can use to help users identify what's in the page.

{
  "@odata.context":"https://www.onenote.com/api/v1.0/$metadata#Microsoft.OneNote.Api.PagePreview",
  "previewText":"text-snippet",
  "links":{
    "previewImageUrl":{
      "href":"https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png"
    }
  }
}

previewText プロパティには、ページからのテキスト スニペットが含まれています。The previewText property contains a text snippet from the page. Microsoft Graph は、最大 300 文字の完全な文字列を返します。Microsoft Graph returns complete phrases, up to a maximum of 300 characters.

ページにプレビュー UI のビルドに使用できる画像が含まれている場合、previewImageUrl オブジェクトの href プロパティには、パブリックの image resource のリンクが含まれます。If the page has an image that can be used to build a preview UI, the href property in the previewImageUrl object contains a link to a public image resource. このリンクは HTML で使用できます。You can use this link in HTML. それ以外の場合、href は、null 値を返します。Otherwise, href returns null.

Example

<img src="https://www.onenote.com/api/v1.0/resources/{id}/content?publicAuth=true&mimeType=image/png" />

ページ HTML コンテンツPage HTML content

ページの HTML コンテンツを取得する。Get the HTML content of a page.

../pages/{page-id}/content[?includeIDs]

(返される HTML コンテンツの詳細についてはリンク先をご覧ください)(learn more about returned HTML content)


includeIDs=true クエリ文字列オプションを使用して、ページを更新するために使用する生成 ID を取得します。Use the includeIDs=true query string option to get generated IDs used to update the page.

セクション コレクションSection collection

ユーザーが所有するすべてのノートブックから、ネストされたセクション グループのセクションを含む、すべてのセクションを取得する。Get all sections from all notebooks that are owned by the user, including sections in nested section groups.

../sections[?filter,orderby,select,top,skip,expand,count]


特定のセクション グループの直下にあるすべてのセクションを取得する。Get all sections that are directly under a specific section group.

../sectionGroups/{sectiongroup-id}/sections[?filter,orderby,select,top,skip,expand,count]


特定のノートブックの直下にあるすべてのセクションを取得する。Get all sections that are directly under a specific notebook.

../notebooks/{notebook-id}/sections[?filter,orderby,select,top,skip,expand,count]


セクションは、parentNotebook プロパティと parentSectionGroup プロパティを展開できます。Sections can expand the parentNotebook and parentSectionGroup properties.

セクションの既定の並べ替え順序は name asc です。The default sort order for sections is name asc.

既定のクエリは、親ノートブックおよび親セクション グループを展開し、idname、および self プロパティを選択します。The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

セクション エンティティSection entity

特定のセクションを取得します。Get a specific section.

../sections/{section-id}[?select,expand]


セクションは、parentNotebook プロパティと parentSectionGroup プロパティを展開できます。Sections can expand the parentNotebook and parentSectionGroup properties.

既定のクエリは、親ノートブックおよび親セクション グループを展開し、idname、および self プロパティを選択します。The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

SectionGroup コレクションSectionGroup collection

ユーザーが所有するすべてのノートブックから、ネストされたセクション グループを含む、すべてのセクション グループを取得する。Get all section groups from all notebooks that are owned by the user, including nested section groups.

../sectionGroups[?filter,orderby,select,top,skip,expand,count]


特定のノートブックの直下にあるすべてのセクション グループを取得する。Get all section groups that are directly under a specific notebook.

../notebooks/{notebook-id}/sectionGroups[?filter,orderby,select,top,skip,expand,count]


セクション グループは、セクションsectionGroupsparentNotebook、および parentSectionGroup プロパティを展開できます。Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

セクション グループの既定の並べ替え順序は name asc です。The default sort order for section groups is name asc.

既定のクエリは、親ノートブックおよび親セクション グループを展開し、idname、および self プロパティを選択します。The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

SectionGroup エンティティSectionGroup entity

特定のセクション グループを取得します。Get a specific section group.

../sectionGroups/{sectiongroup-id}[?select,expand]


セクション グループは、セクションsectionGroupsparentNotebook、および parentSectionGroup プロパティを展開できます。Section groups can expand the sections, sectionGroups, parentNotebook, and parentSectionGroup properties.

既定のクエリは、親ノートブックおよび親セクション グループを展開し、idname、および self プロパティを選択します。The default query expands the parent notebook and parent section group and selects their id, name, and self properties.

ノートブック コレクションNotebook collection

ユーザーによって所有されるすべてのノートブックを取得する。Get all the notebooks that are owned by the user.

../notebooks[?filter,orderby,select,top,skip,expand,count]


ノートブックは、セクションおよび sectionGroups プロパティを展開できます。Notebooks can expand the sections and sectionGroups properties.

ノートブックの既定の並べ替え順序は name asc です。The default sort order for notebooks is name asc.

ノートブック エンティティNotebook entity

特定のノートブックを取得します。Get a specific notebook.

../notebooks/{notebook-id}[?select,expand]


ノートブックは、セクションおよび sectionGroups プロパティを展開できます。Notebooks can expand the sections and sectionGroups properties.

画像またはその他のファイル リソースImage or other file resource

特定のリソースのバイナリ データを取得する。Get the binary data of a specific resource.

../resources/{resource-id}/$value


ファイルのリソース URI は、ページの出力 HTML にあります。You can find the file's resource URI in the page's output HTML.

たとえば、img タグには、data-fullres-src 属性に元の画像のエンドポイント、src 属性に最適化された画像のエンドポイントが含まれます。For example, an img tag includes endpoints for the original image in the data-fullres-src attribute and the optimized image in the src attribute.

Example

<img 
    src="https://www.onenote.com/api/v1.0/me/notes/resources/{image-id}/$value"  
    data-src-type="image/png"
    data-fullres-src="https://www.onenote.com/api/v1.0/resources/{image-id}/$value"  
    data-fullres-src-type="image/png" ... />

object タグには、data 属性のファイル リソースのエンドポイントが含まれています。And an object tag includes the endpoint for the file resource in the data attribute.

Example

<object
    data="https://www.onenote.com/api/v1.0/me/notes/resources/{file-id}/$value"
    data-attachment="fileName.pdf" 
    type="application/pdf" ... />

注: リソースのコレクションの取得はサポートされていません。Note: Getting a collection of resources is not supported.

ファイル リソースを取得する場合、Accept コンテンツ タイプを要求に含める必要はありません。When you get a file resource, you don't need to include an Accept content type in the request.

GET 要求の詳細については、Microsoft Graph API REST リファレンスの中の次のリソースを参照してください。For more information about GET requests, see the following resources in the Microsoft Graph API REST reference:

GET 要求の例Example GET requests

OneNote のエンティティおよび検索ページ コンテンツを照会して、必要な情報だけを取得することができます。You can query for OneNote entities and search page content to get just the information you need. 次の例は、Microsoft Graph への GET 要求で、サポートされているクエリ文字列オプションを使用するいくつかの方法を示しています。The following examples show some ways you can use supported query string options in GET requests to Microsoft Graph.

次の点にご注意ください。Remember:

  • GET 要求はすべて、サービス ルート URL で始まります。All GET requests start with the service root URL.

    : https://www.onenote.com/api/v1.0/me/notes および https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/Examples: https://www.onenote.com/api/v1.0/me/notes and https://www.onenote.com/api/v1.0/myOrganization/siteCollections/{id}/sites/{id}/notes/

  • URL クエリ文字列のスペースには %20 エンコードを使用する必要があります。Spaces in the URL query string must use %20 encoding.

    : filter=title%20eq%20'biology'Example: filter=title%20eq%20'biology'

  • プロパティ名と OData 文字列比較では大文字と小文字が区別されます。Property names and OData string comparisons are case-sensitive. 文字列比較には OData tolower 関数を使用することをお勧めします。We recommend using the OData tolower function for string comparisons.

    : filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

search & filtersearch & filter

特定のアプリによって作成された、recipe という用語が含まれるページすべてを取得します (search はコンシューマー ノートブックでのみ使用可能)。Get all pages that contain the term recipe that were created by a specific app (search is available for consumer notebooks only).

[GET] ../pages?search=recipe&filter=createdByAppId eq 'WLID-000000004C12821A'

search & selectsearch & select

golgi app という用語が含まれるすべてのページの、タイトル、OneNote クライアントのリンク、contentUrl リンクを取得します (search はコンシューマー ノートブックでのみ使用可能)。Get the title, OneNote client links, and contentUrl link for all pages that contain the term golgi app (search is available for consumer notebooks only).

[GET] ../pages?search=golgi app&select=title,links,contentUrl

expandexpand

すべてのノートブックを取得し、そのセクションとセクション グループを展開します。Get all notebooks and expand their sections and section groups.

[GET] ../notebooks?expand=sections,sectionGroups

特定のセクション グループを取得し、そのセクションとセクション グループを展開します。Get a specific section group and expand its sections and section groups.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections,sectionGroups

ページを取得し、その親セクションと親ノートブックを展開します。Get a page and expand its parent section and parent notebook.

[GET] ../pages/{page-id}?expand=parentSection,parentNotebook

expand (複数レベル)expand (multiple levels)

すべてのノートブックを取得してセクションとセクション グループを展開し、各セクション グループのすべてのセクションを展開します。Get all notebooks and expand their sections and section groups, and expand all sections in each section group.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections)

注: 子エンティティの親を展開、または親エンティティの子を展開すると、循環参照が作成されますが、これはサポートされていません。Note: Expanding parents of child entities or expanding children of parent entities creates a circular reference and is not supported.

expand & select (複数レベル)expand & select (multiple levels)

特定のセクション グループの名前と self リンクを取得し、そのすべてのセクションの名前と self リンクを取得します。Get the name and self link for a specific section group, and get the name and self links for all its sections.

[GET] ../sectionGroups/{sectiongroup-id}?expand=sections(select=name,self)&select=name,self

すべてのセクションの名前と self リンクを取得し、各セクションの親ノートブックの名前と作成時刻を取得します。Get the name and self link for all sections, and get the name and created time of each section's parent notebook.

[GET] ../sections?expand=parentNotebook(select=name,createdTime)&select=name,self

すべてのページのタイトルと ID を取得し、親セクションと親ノートブックの名前を取得します。Get the title and ID for all pages, and get the name of the parent section and parent notebook.
[GET] ../pages?select=id,title&expand=parentSection(select=name),parentNotebook(select=name)

expand & levels (複数レベル)expand & levels (multiple levels)

すべてのノートブック、セクション、セクション グループを取得します。Get all notebooks, sections, and section groups.

[GET] ../notebooks?expand=sections,sectionGroups(expand=sections,sectionGroups(levels=max;expand=sections))

filterfilter

2014 年 10 月に作成されたセクションすべてを取得します。Get all sections that were created in October 2014.

[GET] ../sections?filter=createdTime ge 2014-10-01 and createdTime le 2014-10-31

2015 年 1 月 1 日以降に特定のアプリによって作成されたページを取得します。Get the pages that were created by a specific app since January 1, 2015.

[GET] ../pages?filter=createdByAppId eq 'WLID-0000000048118631' and createdTime ge 2015-01-01

filter & expandfilter & expand

特定のノートブックに含まれるすべてのページを取得します。既定では、この API は 20 エントリを戻します。Get all pages in a specific notebook. The API returns 20 entries by default.

[GET] ../pages?filter=parentNotebook/id eq '{notebook-id}'&expand=parentNotebook

学校のノートブックにあるすべてのセクションの名前と pagesUrl リンクを取得します。Get the name and pagesUrl link for all sections from the School notebook. OData の文字列比較は大文字小文字が区別されるので、ベスト プラクティスとして tolower 関数を使用します。OData string comparisons are case-sensitive, so use the tolower function as a best practice.

[GET] ../notebooks?filter=tolower(name) eq 'school'&expand=sections(select=name,pagesUrl)

filter & select & orderbyfilter & select & orderby

セクション名に spring という語が含まれるすべてのセクションの名前と pagesUrl リンクを取得します。セクションを最終変更日で並べ替えます。Get the name and pagesUrl link for all sections that contain the term spring in the section name. Order sections by last modified date.

[GET] ../sections?filter=contains(tolower(name),'spring')&select=name,pagesUrl&orderby=lastModifiedTime desc

orderbyorderby

createdByAppId プロパティ、次に作成時刻を基準に順序を並べ替えて、最初の 20 ページを取得します。既定では、この API は 20 エントリを戻します。Get the first 20 pages ordered by createdByAppId property and then by most recent created time. The API returns 20 entries by default.

[GET] ../pages?orderby=createdByAppId,createdTime desc

search & filter & topsearch & filter & top

cell division という語句を含む、2015 年 1 月 1 日以降に作成されたページで新しいものを 5 つ取得します。Get the five newest pages created since January 1, 2015 that contain the phrase cell division. 既定ではこの API は 20 エントリを返します。最大では 100 エントリを返します。The API returns 20 entries by default with a maximum of 100. ページの既定の並べ替え順序は lastModifiedTime desc です (search は、コンシューマー ノートブックでのみ使用可能)。The default sort order for pages is lastModifiedTime desc (search is available for consumer notebooks only).

[GET] ../pages?search="cell division"&filter=createdTime ge 2015-01-01&top=5

search & filter & top & skipsearch & filter & top & skip

結果セット内の次の 5 ページを取得します (search は、コンシューマー ノートブックでのみ使用可能)。Get the next five pages in the result set (search is available for consumer notebooks only).

[GET] ../pages?search=biology&filter=createdTime ge 2015-01-01&top=5&skip=5

それから次の 5 ページを取得します (search は、コンシューマー ノートブックでのみ使用可能)。And the next five (search is available for consumer notebooks only).

[GET] ../pages?search=biology&filter=createdTime ge 2015-01-01&top=5&skip=10

注: searchfilter がどちらも同じ要求に適用される場合、結果には両方の条件に一致するエンティティのみが含まれます。Note: If both search and filter are applied to the same request, the results include only those entities that match both criteria.

selectselect

ユーザーのノートブック内にあるすべてのセクションの名前、作成時刻、self リンクを取得します。Get the name, created time, and self link for all sections in the user's notebooks.

[GET] ../sections?select=name,createdTime,self

特定のページのタイトル、作成時刻、OneNote クライアント リンクを取得します。Get the title, created time, and OneNote client links for a specific page.

[GET] ../pages/{page-id}?select=title,createdTime,links

select & expand & filter (複数レベル)select & expand & filter (multiple levels)

ユーザーの既定ノートブックにあるすべてのセクションの名前と pagesUrl リンクを取得します。Get the name and pagesUrl link for all sections in the user's default notebook.

[GET] ../notebooks?select=name&expand=sections(select=name,pagesUrl)&filter=isDefault eq true

top & select & orderbytop & select & orderby

最初の 50 ページのタイトルと self リンクを取得します。タイトルのアルファベット順に並べられます。既定ではこの API は 20 エントリを返します。最大では 100 エントリを返します。ページの既定の並べ替え順序は lastModifiedTime desc です。Get the title and self link for the first 50 pages, ordered alphabetically by title. The API returns 20 entries by default with a maximum of 100. The default sort order for pages is lastModifiedTime desc.

[GET] ../pages?top=50&select=title,self&orderby=title

skip & top & select & orderbyskip & top & select & orderby

51 ページ目から 100 ページ目までを取得します。既定ではこの API は 20 エントリを返します。最大では 100 エントリを返します。Get pages 51 to 100. The API returns 20 entries by default with a maximum of 100.

[GET] ../pages?skip=50&top=50&select=title,self&orderby=title

注: 既定のエントリ数を取得する pages に対する GET 要求 (つまり、top 式を指定しない要求) は、応答で次の 20 エントリを取得するために使用できる @odata.nextLink リンクを戻します。Note: GET requests for pages that retrieve the default number of entries (that is, they don't specify a top expression) return an @odata.nextLink link in the response that you can use to get the next 20 entries.

サポートされている OData クエリ文字列オプションSupported OData query string options

Microsoft Graph に GET 要求を送信する場合、OData クエリ文字列オプションを使用してクエリをカスタマイズして、必要な情報だけを取得できます。When sending GET requests to Microsoft Graph, you can use OData query string options to customize your query and get just the information you need. このオプションを使用することにより、サービスへの呼び出し回数が減り、応答ペイロードのサイズが小さくなるので、パフォーマンスも向上します。They can also improve performance by reducing the number of calls to the service and the size of the response payload.

注: この記事の例では読みやすくするために、URL クエリ文字列内のスペースで必要な %20 パーセント エンコードを使用していません: filter=isDefault%20eq%20trueNote: For readability, the examples in this article don't use the %20 percent-encoding required for spaces in the URL query string: filter=isDefault%20eq%20true

クエリ オプションQuery option 例と説明Example and description
countcount

count=true

コレクション内のエンティティのカウントです。この値は、応答の @odata.count プロパティで戻ります。The count of entities in the collection. The value is returned in the @odata.count property in the response.

expandexpand

expand=sections,sectionGroups

応答でインラインを返すナビゲーション プロパティ。expand 式には次のプロパティがサポートされています。The navigation properties to return inline in the response. The following properties are supported for expand expressions:
- ページ: parentNotebookparentSection- Pages: parentNotebook, parentSection
- セクション: parentNotebookparentSectionGroup- Sections: parentNotebook, parentSectionGroup
- セクション グループ: sectionssectionGroupsparentNotebookparentSectionGroup- Section groups: sections, sectionGroups, parentNotebook, parentSectionGroup
- ノートブック: sectionssectionGroups- Notebooks: sections, sectionGroups

既定では、ページの GET 要求は parentSection を展開し、セクションの idnameself の各プロパティを選択します。セクションとセクションのグループの既定の GET 要求は parentNotebookparentSectionGroup の両方を展開し、親の idnameself の各プロパティを選択します。By default, GET requests for pages expands parentSection and select the section's id, name, and self properties. Default GET requests for sections and section groups expand both parentNotebook and parentSectionGroup, and select the parents' id, name, and self properties.

1 つのエンティティまたはコレクションに使用できます。Can be used for a single entity or a collection.
コンマを使用して複数のプロパティを区切ります。Separate multiple properties with commas.
プロパティ名では、大文字と小文字を区別します。Property names are case-sensitive.

filterfilter

filter=isDefault eq true

結果セットの入力に含めるかどうかを決めるブール式。サポートされている OData 演算子と関数:A Boolean expression for whether to include an entry in the result set. Supports the following OData operators and functions:
- 比較演算子: eqnegtgeltle- Comparison operators: eq, ne, gt, ge, lt, le
- 論理演算子: andornot- Logical operators: and, or, not
- 文字列関数: containsendswithstartswithlengthindexofsubstringtolowertouppertrimconcat- String functions: contains, endswith, startswith, length, indexof, substring, tolower, toupper, trim, concat

プロパティ名と OData 文字列比較では大文字と小文字が区別されます。Property names and OData string comparisons are case-sensitive. 文字列比較には OData tolower 関数を使用することをお勧めします。We recommend using the OData tolower function for string comparisons.

: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

orderbyorderby

orderby=title,createdTime desc

並べ替え基準を示すプロパティです。オプションで、asc (既定) または desc 並べ替え順序を指定します。要求対象コレクション内のエンティティの任意のプロパティで並べ替えが可能です。The properties to sort by, with an optional asc (default) or desc sort order. You can sort by any property of the entity in the requested collection.

ノートブック、セクション グループ、セクションの既定の並べ替え順序は name asc で、ページの場合には lastModifiedTime desc (最新の変更ページが先頭になります)。The default sort order for notebooks, section groups, and sections is name asc, and for pages is lastModifiedTime desc (last modified page first).

複数のプロパティはコンマで区切り、任意の順序で一覧表示します。Separate multiple properties with commas, and list them in the order that you want them applied. プロパティ名では、大文字と小文字を区別します。Property names are case-sensitive.

searchsearch

search=cell div

コンシューマー ノートパソコンでのみ使用可能。Available for consumer notebooks only.

ページ タイトル、ページ本文、画像の代替テキスト、画像の OCR テキストで検索する用語または語句です。既定では、検索クエリは関連度で並べ替えて結果を返します。The term or phrase to search for in the page title, page body, image alt text, and image OCR text. By default, search queries return results sorted by relevance.

OneNote は、Bing のフルテキスト検索を使用して、語句の検索、語形変化、スペルの曖昧さ、関連性とランキング、単語分割、複数の言語、他のフルテキスト検索機能をサポートします。OneNote uses Bing full-text search to support phrase search, stemming, spelling forgiveness, relevance and ranking, word breaking, multiple languages, and other full-text search features. 検索文字列では、大文字と小文字が区別されません。Search strings are case-insensitive.

ユーザーが所有しているノートブック内のページにのみ適用されます。Applies only to pages in notebooks owned by the user. インデックス付けされたコンテンツは非公開であり、所有者のみがアクセスできます。Indexed content is private and can only be accessed by the owner. パスワードで保護されたページにはインデックスは付けられません。Password-protected pages are not indexed. pages エンドポイントにのみ適用されます。Applies only to the pages endpoint.

selectselect

select=id,title

返すプロパティThe properties to return. 1 つのエンティティまたはコレクションに使用できます。Can be used for a single entity or for a collection. コンマを使用して複数のプロパティを区切ります。Separate multiple properties with commas. プロパティ名では、大文字と小文字を区別します。Property names are case-sensitive.

skipskip

skip=10

結果セットでスキップするエントリの数。通常、結果のページングに使用されます。The number of entries to skip in the result set. Typically used for paging results.

toptop

top=50

結果セット内で返すエントリ数で、最大数は 100 です。既定値は 20 です。The number of entries to return in the result set, up to a maximum of 100. The default value is 20.

Microsoft Graph にも、親セクション内でページのレベルと順序を取得する pagelevel クエリ文字列オプションが用意されています。Microsoft Graph also provides the pagelevel query string option you can use to get the level and order of pages within the parent section. 特定のセクションのページのクエリ、または特定のページのクエリにのみ適用されます。Applies only to queries for pages in a specific section or queries for a specific page.

Examples

  • GET ../sections/{section-id}/pages?pagelevel=true
  • GET ../pages/{page-id}?pagelevel=true

サポートされている OData 演算子と関数Supported OData operators and functions

Microsoft Graph は、フィルター式で次の OData 演算子および関数をサポートしています。Microsoft Graph supports the following OData operators and functions in filter expressions. OData 式を使用する場合には、次の点に注意してください。When using OData expressions, remember:

  • URL クエリ文字列のスペースは %20 エンコードで置換する必要があります。Spaces in the URL query string must be replaced with the %20 encoding.

    例: filter=isDefault%20eq%20trueExample: filter=isDefault%20eq%20true

  • プロパティ名と OData 文字列比較では大文字と小文字が区別されます。Property names and OData string comparisons are case-sensitive. 文字列比較には OData tolower 関数を使用することをお勧めします。We recommend using the OData tolower function for string comparisons.

    例: filter=tolower(name) eq 'spring'Example: filter=tolower(name) eq 'spring'

比較演算子Comparison operator Example
eqeq
(等しい)(equal to)
createdByAppId eq '{app-id}'
nene
(等しくない)(not equal to)
userRole ne 'Owner'
gtgt
(より大きい)(greater than)
createdTime gt 2014-02-23
gege
(以上)(greater than or equal to)
lastModifiedTime ge 2014-05-05T07:00:00Z
ltlt
(より小さい)(less than)
createdTime lt 2014-02-23
lele
(以下)(less than or equal to)
lastModifiedTime le 2014-02-23

論理演算子Logical operator Example
andand createdTime le 2014-01-30 and createdTime gt 2014-01-23
oror createdByAppId eq '{app-id}' or createdByAppId eq '{app-id}'
notnot not contains(tolower(title),'school')

| String 関数String function | Example | |------|------| | containscontains | `contains(tolower(title),'spring')` | | endswithendswith | `endswith(tolower(title),'spring')` | | startswithstartswith | `startswith(tolower(title),'spring')` | | lengthlength | `length(title) eq 19` | | indexofindexof | `indexof(tolower(title),'spring') eq 1` | | substringsubstring | `substring(tolower(title),1) eq 'spring'` | | tolowertolower | `tolower(title) eq 'spring'` | | touppertoupper | `toupper(title) eq 'SPRING'` | | trimtrim | `trim(tolower(title)) eq 'spring'` | | concatconcat | `concat(title,'- by MyRecipesApp') eq 'Carrot Cake Recipe - by MyRecipesApp'` |

OneNote エンティティのプロパティOneNote entity properties

filterselectexpand、および orderby クエリ式には、OneNote エンティティのプロパティを含めることができます。The filter, select, expand, and orderby query expressions can include properties of OneNote entities.

Example

../sections?filter=createdTime ge 2015-01-01&select=name,pagesUrl&orderby=lastModifiedTime desc

クエリ式のプロパティ名は大文字小文字を区別します。Property names are case-sensitive in query expressions.

プロパティとプロパティの種類の一覧については、Microsoft Graph API REST リファレンスの中の次のリソースを参照してください。For the list of properties and property types, see the following resources in the Microsoft Graph API REST reference:

expand クエリ文字列オプションは、以下のナビゲーション プロパティとともに使用できます。The expand query string option can be used with the following navigation properties:

  • ページ: parentNotebookparentSectionPages: parentNotebook, parentSection
  • セクション: parentNotebookparentSectionGroupSections: parentNotebook, parentSectionGroup
  • セクション グループ: sectionssectionGroupsparentNotebookparentSectionGroupSection groups: sections, sectionGroups, parentNotebook, parentSectionGroup
  • ノートブック: sectionssectionGroupsNotebooks: sections, sectionGroups

要求および GET 要求の応答に関する情報Request and response information for GET requests

要求データRequest data 説明Description
プロトコルProtocol すべての要求は SSL/TLS HTTPS プロトコルを使用します。All requests use the SSL/TLS HTTPS protocol.
承認ヘッダーAuthorization header

Bearer {token}{token} は、登録済みアプリの有効な OAuth 2.0 アクセス トークンです。Bearer {token}, where {token} is a valid OAuth 2.0 access token for your registered app.

これがないか、無効の場合、401 ステータス コードで要求は失敗します。「認証とアクセス許可」を参照してください。If missing or invalid, the request fails with a 401 status code. See Authentication and permissions.

Accept ヘッダーAccept header

OneNote エンティティとエンティティ セットの場合、application/jsonapplication/json for OneNote entities and entity sets

ページ コンテンツの場合、text/htmltext/html for page content


応答データResponse data 説明Description
成功コードSuccess code 200 HTTP ステータス コード。A 200 HTTP status code.
応答本文Response body JSON 形式のエンティティまたはエンティティ セット、ページ HTML、またはファイル リソースのバイナリ データの OData 表現。An OData representation of the entity or entity set in JSON format, the page HTML, or file resource binary data.
エラーErrors 要求が失敗すると、API は応答本文の @api.diagnostics オブジェクトにエラーを返します。If the request fails, the API returns errors in the @api.diagnostics object in the response body.
X-CorrelationId ヘッダーX-CorrelationId header 要求を一意に識別する GUID。Microsoft サポートと問題のトラブルシューティングを行う際に、この値を Date ヘッダーの値とともに使用できます。A GUID that uniquely identifies the request. You can use this value along with the value of the Date header when working with Microsoft support to troubleshoot issues.

Microsoft Graph のノート サービスのルート URL の構築Constructing the Microsoft Graph notes service root URL

Microsoft Graph ノートのルート URL は、Microsoft Graph ノートへのすべての呼び出しで次の形式を使用します。The Microsoft Graph notes root URL uses the following format for all calls to Microsoft Graph notes:

https://graph.microsoft.com/{version}/me/onenote/

URL の version セグメントは、使用する Microsoft Graph のバージョンを示しています。The version segment in the URL represents the version of Microsoft Graph that you want to use. 安定した運用コードには v1.0 を使用します。Use v1.0 for stable production code. 開発中の機能を試すには beta を使用します。Use beta to try out a feature that's in development. ベータ版の機能は変更される可能性があるため、運用コードでは使用しないでください。Features and functionality in beta may change, so you shouldn't use it in your production code.

現在のユーザーがアクセスできる OneNote コンテンツには me を使用します (所有と共有)。Use me for OneNote content that the current user can access (owned and shared). 指定されたユーザー (URL 内) が現在のユーザーと共有している OneNote コンテンツには users/{id} を使用します。Use users/{id} for OneNote content that the specified user (in the URL) has shared with the current user. ユーザー ID を取得するには Microsoft Graph を使用します。Use Microsoft Graph to get user IDs.

GET 要求のアクセス許可Permissions for GET requests

OneNote のコンテンツまたは構造を取得するには、適切なアクセス許可を要求する必要があります。To get OneNote content or structure, you'll need to request appropriate permissions.

次のスコープは、Microsoft Graph に対する GET 要求を許可します。The following scopes allow GET requests to Microsoft Graph. アプリの動作に必要な最低限のアクセス許可を選択してください。Choose the lowest level of permissions that your app needs to do its work.

次から選択します。Choose from:

  • Notes.readNotes.read
  • Notes.ReadWriteNotes.ReadWrite
  • Notes.ReadWrite.AllNotes.ReadWrite.All

アクセス許可の範囲とその動作方法の詳細については、「Microsoft Graph のアクセス許可のリファレンス」を参照してください。For more information about permission scopes and how they work, see Microsoft Graph permissions reference.

関連項目See also