大网数据广告活动
Microsoft Graph 接口

使用 OneNote API 的最佳做法

· 52CE 我爱测

基于 Microsoft Q&A 和 Twitter 上常见问题的解答,发现有关在 Microsoft Graph 中使用 OneNote API 的建议。

本文提供了有关使用 Microsoft Graph 中的 OneNote API 的建议。 这些建议基于 Microsoft Q&A 和 Twitter 上常见问题的解答。

使用 $select 选择所需的最小属性集

查询资源(例如,笔记本中的分区)时,会发出类似于以下内容的请求。

GET ~/notebooks/{id}/sections

这将检索分区的所有属性。 然而,你可能并不需要所有属性。 可以使用 $select 查询参数只返回所需属性,如下面的示例中所示。

GET ~/notebooks/{id}/sections?$select=id,displayName

同样的方法适用于其他 OneNote API。

使用 $expand 而不是进行多个 API 调用

假定你要在分层视图中检索用户的所有笔记本、分区和分区组。 可以通过执行以下操作来实现:

  • 调用 GET ~/notebooks 以获取笔记本的列表。

  • 对于每个检索的笔记本,调用 GET ~/notebooks/{notebookId}/sections 以检索分区的列表。

  • 对于每个检索的笔记本,调用 GET ~/notebooks/{notebookId}/sectionGroups 以检索分区组的列表。

  • (可选)以递归方式遍历分区组。

虽然此方法有效(同时有一些到服务的额外顺序往返),但更好的方法是使用 $expand 查询参数。

GET ~/notebooks?$expand=sections,sectionGroups($expand=sections)

这将在一个网络往返中产生同样的结果,而且性能更佳。

获取用户的所有页面时,分别对每个分区执行此操作

当 Microsoft Graph 公开一个终结点来检索所有页面时,这并不是获取用户可以访问的所有页面的最佳方式。 如果用户拥有的分区过多,可能会导致超时或性能降低。 最好遍历每个分区,从而分别获取每个分区的页面。

例如,不使用此调用(此 API 已分页,因此无法一次获取所有页面):

GET ~/pages

最好多次使用以下调用(特别是在你不需要所有分区的情况下):

GET ~/sections/{id}/pages

获取页面元数据时,请覆盖默认的 lastModifiedDateTime 排序。 当不必按 lastModifiedDateTime 对页面进行排序时,获取页面的速度更快。 为此,可以按任何其他属性进行排序;例如:

GET ~/sections/{id}/pages?$select=id,title,createdDateTime&$orderby=createdDateTime

历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 jewan-microsoft)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / Microsoft Graph 中文文档历史快照
适用范围
历史中文快照 2023-02-03;详见原文产品版本;文档日期 未标明
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。