webPart の作成

  • [アーティクル]

名前空間: microsoft.graph

sitePage 内の指定した位置に新しい webPart を作成します。

アクセス許可

この 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

オプションのクエリ パラメーター

名前 説明
index Web パーツを Web パーツのコレクションに挿入する位置

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 textWebPart または standardWebPart の JSON 表現を指定 します。

要求本文の解析を成功させるには、 または @odata.type=#microsoft.graph.standardwebpart を@odata.type=#microsoft.graph.textwebpart要求本文に含める必要があります。

サポートされている Web パーツ

sitePage に追加できる Web パーツには、standardWebPart と textWebPart の 2 種類があります。

standardWebPart の場合、Microsoft Graph APIを使用して更新する場合は、次のみがサポートされます。 サポートされていない Web パーツを追加しようとすると、エラーまたは例外が発生します。

# Web パーツ 型
1 Bing 地図 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 埋め込み 544dd15b-cf3c-441b-96da-004d5a8cea1d

応答

成功した場合、このメソッドは 応答本文で 作成 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."
}