创建 Web 部件

项目
07/16/2024

命名空间：microsoft.graph

在 sitePage 中的指定位置创建新的 Web 部件。

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Sites.ReadWrite.All	不可用。
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	Sites.ReadWrite.All	不可用。

HTTP 请求

POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/verticalSection/webparts
POST /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontal-section-id}/columns/{horizontal-section-column-id}/webparts

可选的查询参数

Name	说明
index	Web 部件应插入到 Web 部件集合中的位置

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供 textWebPart 或 standardWebPart 的 JSON 表示形式。

若要确保成功分析请求正文， @odata.type=#microsoft.graph.textwebpart 请求正文中必须包含或 @odata.type=#microsoft.graph.standardwebpart 。

支持的 Web 部件

有两种类型的 Web 部件可以添加到 sitePage： standardWebPart 和 textWebPart。

对于 standardWebPart，使用 Microsoft Graph API 进行更新时，仅支持以下各项。尝试添加不受支持的 Web 部件将导致失败或异常。

#	Web 部件	类型
1	必应地图	`e377ea37-9047-43b9-8cdb-a761be2f8e09`
2	按钮	`0f087d7f-520e-42b7-89c0-496aaf979d58`
3	行动号召	`df8e44e7-edd5-46d5-90da-aca1539313b8`
4	分	`2161a1c6-db61-4731-b97c-3cdb303f7cbb`
5	文档嵌入	`b7dd04e1-19ce-4b24-9132-b60a1c2b910d`
6	图像	`d1d91016-032f-456d-98a4-721247c305e8`
7	映像库	`af8be689-990e-492a-81f7-ba3e4cd3ed9c`
8	链接预览	`6410b3b6-d440-4663-8744-378976dc041e`
9	组织结构图	`e84a8ca2-f63c-4fb9-bc0b-d8eef5ccb22b`
10	人员	`7f718435-ee4d-431c-bdbf-9c4ff326f46e`
11	快速链接	`c70391ea-0b10-4ee9-b2b4-006d3fcad0cd`
12	间隔	`8654b779-4886-46d4-8ffb-b5ed960ee986`
13	Youtube Embed	`544dd15b-cf3c-441b-96da-004d5a8cea1d`
14	标题区域	`cbe7b0a9-3504-44dd-a3a3-0e5cacd07788`

响应

如果成功，此方法在 201 响应正文中返回和创建的 webPart 对象。

示例

请求

以下示例演示如何创建新的 Web 部件。

POST /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202//microsoft.graph.sitePage/canvasLayout/verticalSection/webparts
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.textWebPart",
  "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat."
}

响应

如果成功，此方法在创建的 webPart 的响应正文中返回 webPart。

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.textWebPart",
  "id": "51053496-e6f3-4161-94ac-07bdf4d92226",
  "innerHtml": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus blandit pellentesque ipsum tempor porta. Phasellus tincidunt et ipsum nec iaculis. Sed eu arcu tristique, congue erat a, consequat lorem. Suspendisse ac ullamcorper elit. Sed ultricies, risus sed hendrerit dictum, nunc massa ornare velit, a pharetra dolor urna quis lorem. Maecenas eget pellentesque purus, nec ultricies risus. Donec rhoncus lorem at euismod varius. Donec auctor sed mi vitae pharetra. Aenean id tempor mauris. Donec dui nulla, semper ut elit id, mattis commodo arcu. Aliquam erat volutpat."
}

通过