newsLinkPage を作成する
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
サイトのサイト ページ リストに新しい newsLinkPage を作成します。
この 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 for JSON (マルチパート要求で必要な タイトル プロパティを含む)。 マルチパート要求では、マルチパート/フォーム データが使用されます。boundary=your-boundary コンテンツ タイプ。 必須です。 |
Prefer | include-unknown-enum-members。
Prefer: include-unknown-enum-members 要求ヘッダーを使用して、pageLayoutType で次の値を取得する必要があります。これは、進化可能な列挙型です:newsLink 。 |
要求本文
要求本文で、 newsLinkPage オブジェクトの JSON 表現を指定します。 本文には、要求本文に直接配置される必要なプロパティが含まれている必要があります。ただし、イメージをアップロードしてバナー イメージを設定するには、例に示すようにマルチパート メッセージ形式にする必要があります。 バナー イメージのアップロードには、バイナリ データが含まれるため、マルチパート要求を送信する必要があります。
注:
- 要求本文の解析を成功させるには、
@odata.type=#microsoft.graph.newsLinkPage
を要求本文に含める必要があります。- 現時点では、 bannerImageWebUrl を設定するために、イメージ バイトを直接アップロードする機能が存在します。 これらのバイトはサイト資産ライブラリに自動保存され、保存されたファイルに基づいて bannerImageWebUrl が生成されます。 これを実現するには、マルチパート要求を行い、画像コンテンツを送信するように
@microsoft.graph.bannerImageWebUrlContent
注釈を設定します。 詳細については、例 2 を参照してください。
newsLinkPage を作成するときに、次のプロパティを指定できます。
プロパティ | 型 | 説明 |
---|---|---|
description | String | アイテムの説明テキストです。 最大長の制限は 250 文字です。 省略可能。 baseSitePage から継承されます。 |
newsWebUrl | String | newsLinkPage によって参照されるニュース記事の URL。 外部リンクにすることができます。 必須です。 |
title | String | newsLinkPage のタイトル。 最大長の制限は 110 文字です。 必須です。 baseSitePage から継承されます。 |
応答
成功した場合、このメソッドは応答コード 201 Created
と、応答本文に newsLinkPage オブジェクトを返します。
例
例 1: 必要なプロパティのみを含むニュース リンク ページを作成する
次の例は、必要なプロパティのみを使用して ニュース リンク ページ を作成する方法を示しています。
要求
次の例は要求を示しています。
POST /sites/c1370818-f5e0-4a40-a99b-be4520640642/pages
prefer: include-unknown-enum-members
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.newsLinkPage",
"newsWebUrl":"https://someexternalnewssite.com/2024/11/11/contoso-unveils-first-self-driving-car",
"title": "Contoso Unveils First Self-Driving Car"
}
応答
次の例は応答を示しています。
HTTP/1.1 201 Created
Content-type: application/json
{
"eTag": "\"{6A34958A-6F84-4571-A26E-B2CEB20261EB},3\"",
"id": "6a34958a-6f84-4571-a26e-b2ceb20261eb",
"lastModifiedDateTime": "2023-09-10T18:46:23Z",
"name": "contoso-unveils-first-self-driving-car.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/contoso-unveils-first-self-driving-car.aspx",
"title": "Contoso Unveils First Self-Driving Car",
"pageLayout": "newsLink",
"newsWebUrl": "https://someexternalnewssite.com/2024/11/11/contoso-unveils-first-self-driving-car",
"createdBy": {
"user": {
"displayName": "Jane Doe"
}
},
"lastModifiedBy": {
"user": {
"displayName": "Jane Doe"
}
},
"contentType": {
"id": "0x0101009D1CB255DA76424F860D91F20E6C4118002A50BFCFB7614729B56886FADA02339B000B27C676C81DC54289A1417148759BF3",
"name": "Repost Page"
},
"publishingState": {
"level":"checkout",
"versionId":"0.1",
"checkedOutBy": {
"user": {
"displayName":"Jane Doe",
"email":"JaneDoe@contoso.sharepoint.com"
}
}
}
}
例 2: ニュース リンク ページを作成し、バナー 画像ファイルのコンテンツをアップロードする
次の例は、バナー画像を含む ニュース リンク ページ を作成する方法を示しています。 このプロセスには、マルチパート要求が必要です。
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/sites/c1370818-f5e0-4a40-a99b-be4520640642/pages
Prefer: include-unknown-enum-members
Content-type: multipart/form-data; boundary=MyPartBoundary198374
--MyPartBoundary198374
Content-Disposition: form-data; name="request"
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.newsLinkPage",
"title": "Microsoft Build brings AI tools to the forefront for developers",
"newsWebUrl": "https://someexternalnewssite.com/2024/05/23/microsoft-build-ai-tools-developers",
"description": "You only need two simple letters to accurately convey the major shift in the technology space this year: A and I. Beyond those letters, however, is a complex, evolving and exciting way in which we work, communicate and collaborate.",
"@microsoft.graph.bannerImageWebUrlContent": "name:content"
}
--MyPartBoundary198374
Content-Disposition: form-data; name="content"; filename="b3.jpg"
Content-Type: image/jpeg
... binary image data ...
--MyPartBoundary198374
応答
次の例は応答を示しています。 バナー イメージをアップロードまたは永続化するときにエラーが発生した場合、応答には @microsoft.graph.bannerImageWebUrlContentError
と説明的なエラー メッセージが含まれます。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.newsLinkPage",
"createdDateTime": "2024-06-11T17:31:20Z",
"description": "You only need two simple letters to accurately convey the major shift in the technology space this year: A and I. Beyond those letters, however, is a complex, evolving and exciting way in which we work, communicate and collaborate.",
"eTag": "\"{179210C2-637E-4C61-8491-331D0D4A0C05},2\"",
"id": "179210c2-637e-4c61-8491-331d0d4a0c05",
"lastModifiedDateTime": "2024-06-11T17:31:21Z",
"name": "microsoft-build-ai-tools-developers.aspx",
"webUrl": "https://contoso.sharepoint.com/SitePages/Microsoft-Build-brings-AI-tools-to-the-forefront-for-developers.aspx",
"title": "Microsoft Build brings AI tools to the forefront for developers",
"pageLayout": "newsLink",
"bannerImageWebUrl": "https://contoso.sharepoint.com/_layouts/15/getpreview.ashx?path=/SiteAssets/SitePages/microsoft-build-ai-tools-developers/BannerImage.png",
"newsWebUrl": "https://someexternalnewssite.com/2024/05/23/microsoft-build-ai-tools-developers",
"createdBy": {
"user": {
"displayName": "John Doe",
"email": "jdoe@contoso.com"
}
},
"lastModifiedBy": {
"user": {
"displayName": "John Doe",
"email": "jdoe@contoso.com"
}
},
"publishingState": {
"level": "checkout",
"versionId": "0.1",
"checkedOutBy": {
"user": {
"displayName": "John Doe",
"email": "jdoe@contoso.com"
}
}
}
}