sitePage の更新

[アーティクル]
03/15/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

sitePage オブジェクトのプロパティを更新します。

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

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

アクセス許可

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

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

HTTP 要求

PATCH /sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage

要求ヘッダー

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

要求本文

注: : 要求本文の解析が正常に行われるようにするには、を @odata.type=#microsoft.graph.sitePage 要求本文に含める必要があります。

要求本文で、更新すべきプロパティの値のみを指定します。要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

これらのフィールドは、更新要求で使用されます。

プロパティ	型	説明
description	String	サイトページの説明。省略可能です。
thumbnailWebUrl	String	サイトページのサムネイル画像の URL。省略可能です。
title	String	サイトページのタイトル。オプション。
showComments	ブール型	ページの下部にコメントを表示するかどうかを決定するブール値。省略可能です。
showRecommendedPages	ブール型	ページの下部に推奨ページを表示するかどうかを決定するブール値。省略可能です。
promotionKind	PagePromotionType	SharePoint ページのプロモーションの種類。省略可能です。ページの昇格のみをサポートします (例: から `page` )。`newsPost` 降格はサポートされていません。
titleArea	titleArea	サイトページのタイトル領域。省略可能です。
canvasLayout	canvasLayout	水平セクションや垂直セクションなど、ページ内のコンテンツのレイアウト。ページレイアウト全体のコンテンツを指定する必要があります。更新関数は部分的な更新をサポートしていません。省略可能。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された sitePage オブジェクトを返します。

例

要求

次の例は要求を示しています。

HTTP
JavaScript

PATCH https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "title": "sample",
  "showComments": true,
  "showRecommendedPages": false
}


const options = {
	authProvider,
};

const client = Client.init(options);

const sitePage = {
  '@odata.type': '#microsoft.graph.sitePage',
  title: 'sample',
  showComments: true,
  showRecommendedPages: false
};

await client.api('/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage')
	.version('beta')
	.update(sitePage);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.sitePage",
  "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7",
  "name": "sample.aspx",
  "webUrl": "https://contoso.sharepoint.com/SitePages/sample.aspx",
  "title": "sample",
  "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": "draft",
    "versionId": "0.1"
  },
  "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": "sample",
    "imageSourceType": 2
  }
}

次の方法で共有