次の方法で共有

サイトのサイト ページ リストにページを作成する

  • [アーティクル]

名前空間: microsoft.graph

サイト内の サイト ページリスト に新しい sitePage を作成 します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Sites.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Sites.ReadWrite.All 注意事項なし。

HTTP 要求

POST /sites/{site-id}/pages

要求ヘッダー

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

要求本文

要求本文で、作成する sitePage リソースの JSON 表現を指定します。

注: :

  1. 要求本文の解析を成功させるには、 @odata.type=#microsoft.graph.sitePage を要求本文に含める必要があります。
  2. サイトページの取得操作からの応答を使用して sitePage を作成する場合は、HTTP ヘッダーをAccept: application/json;odata.metadata=none追加することをお勧めします。 これにより、すべての OData メタデータが応答から削除されます。 すべての OData メタデータを手動で削除することもできます。
  3. Microsoft Graph API を使用して sitePage を作成する場合は、[サポートされている Web パーツ] セクションに記載されている Web パーツのみがサポートされます。 サポートされていない Web パーツを追加しようとすると、エラーまたは例外が発生します。

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

sitePage に追加できる Web パーツには、standardWebParts と textWebPart の 2 種類があります。 次の表に、標準 Web パーツでサポートされている 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
14 タイトル領域 cbe7b0a9-3504-44dd-a3a3-0e5cacd07788

応答

成功した場合、このメソッドは 201 と作成された sitePage オブジェクトを返します。

例

次の例は、新しいページを作成する方法を示しています。

要求

POST /sites/{site-id}/pages
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "name": "test.aspx",
  "title": "test",
  "pageLayout": "article",
  "showComments": true,
  "showRecommendedPages": false,
  "titleArea": {
    "enableGradientEffect": true,
    "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
    "layout": "colorBlock",
    "showAuthor": true,
    "showPublishedDate": false,
    "showTextBlockAboveTitle": false,
    "textAboveTitle": "TEXT ABOVE TITLE",
    "textAlignment": "left",
    "imageSourceType": 2,
    "title": "sample1"
  },
  "canvasLayout": {
    "horizontalSections": [
      {
        "layout": "oneThirdRightColumn",
        "id": "1",
        "emphasis": "none",
        "columns": [
          {
            "id": "1",
            "width": 8,
            "webparts": [
              {
                "id": "6f9230af-2a98-4952-b205-9ede4f9ef548",
                "innerHtml": "<p><b>Hello!</b></p>"
              }
            ]
          },
          {
            "id": "2",
            "width": 4,
            "webparts": [
              {
                "id": "73d07dde-3474-4545-badb-f28ba239e0e1",
                "webPartType": "d1d91016-032f-456d-98a4-721247c305e8",
                "data": {
                  "dataVersion": "1.9",
                  "description": "Show an image on your page",
                  "title": "Image",
                  "properties": {
                    "imageSourceType": 2,
                    "altText": "",
                    "overlayText": "",
                    "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8",
                    "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314",
                    "listid": "bdb41041-eb06-474e-ac29-87093386bb14",
                    "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb",
                    "imgWidth": 4288,
                    "imgHeight": 2848,
                    "fixAspectRatio": false,
                    "captionText": "",
                    "alignment": "Center"
                  },
                  "serverProcessedContent": {
                    "imageSources": [
                      {
                        "key": "imageSource",
                        "value": "/_LAYOUTS/IMAGES/VISUALTEMPLATEIMAGE1.JPG"
                      }
                    ],
                    "customMetadata": [
                      {
                        "key": "imageSource",
                        "value": {
                          "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8",
                          "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314",
                          "listid": "bdb41041-eb06-474e-ac29-87093386bb14",
                          "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb",
                          "width": "4288",
                          "height": "2848"
                        }
                      }
                    ]
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

応答

成功した場合、このメソッドは、作成されたページの応答本文で sitePage を返します。

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

{
    "@odata.type": "microsoft.graph.sitePage",
    "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7",
    "name": "test.aspx",
    "webUrl": "https://contoso.sharepoint.com/SitePages/test.aspx",
    "title": "test",
    "pageLayout": "article",
    "showComments": true,
    "showRecommendedPages": false,
    "createdBy": {
      "user": {
          "displayName": "Rahul Mittal",
          "email": "rahmit@contoso.com"
      }
    },
    "lastModifiedBy": {
      "user": {
          "displayName": "Rahul Mittal",
          "email": "rahmit@contoso.com"
      }
    },
    "publishingState": {
      "level": "checkout",
      "versionId": "0.1",
      "checkedOutBy": {
        "user": {
          "displayName": "Rahul Mittal",
          "email": "rahmit@contoso.com"
        }
      }
    },
    "titleArea": {
        "enableGradientEffect": true,
        "imageWebUrl": "https://cdn.hubblecontent.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg",
        "layout": "colorBlock",
        "showAuthor": true,
        "showPublishedDate": false,
        "showTextBlockAboveTitle": false,
        "textAboveTitle": "TEXT ABOVE TITLE",
        "textAlignment": "left",
        "title": "sample4",
        "imageSourceType": 2
    }
}

注:応答オブジェクトは、わかりやすくするために切り詰められています。 実際の呼び出しでは、既定のプロパティが返されます。