Web Content API
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

REST API を使用した Web コンテンツ構造とテンプレートの管理

ウェブコンテンツ構造とは、ウェブコンテンツ記事に含まれる情報を定義するものです。 構造化することで、ウェブコンテンツの作成と管理が容易になり、同時にコンテンツに必要な情報がすべて含まれていることが保証されます。

構造をWebコンテンツテンプレートに関連付けることができます。 テンプレートは、ページ上でコンテンツフィールドがどのように表示されるかを決定します。 以下の表は、Liferay DXP REST API を構造とテンプレートを使用して利用する際に利用可能なオプションをまとめたものです。

利用可能なオプション利用不可のオプション
構造とテンプレートの情報を収集する構造またはテンプレートを作成する
構造物の権限を置き換える構造またはテンプレートを削除する

構造化コンテンツの管理方法を学ぶために、いくつかの cURL および Java コードサンプルを含む、事前に構築された Liferay DXP Docker イメージを使用します。

環境設定

Liferay DXP の新しいインスタンスを起動するには、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2026.q1.9-lts

http://localhost:8080 に、メールアドレス test@liferay.com とパスワード test を使用して Liferay にサインインします。 プロンプトが表示されたら、パスワードを learn に変更してください。

次に、以下の手順に従ってください。

  1. サンプルプロジェクトをダウンロードして解凍します。

    curl https://resources.learn.liferay.com/examples/liferay-m7b1.zip -O
    
    unzip liferay-m7b1.zip
    
    警告

    これらのスクリプトは基本認証を使用しており、テスト用に設計されています。 Liferay DXPの本番環境では、基本認証を使用しないでください。

サイトIDを特定します

  1. サイトメニュー (Site menu) を開き、 設定 → サイト設定 に移動します。

  2. プラットフォーム セクションで、 サイト構成 をクリックします。

  3. [Site ID]の下でサイト識別子を見つけます。

    サイトIDは、「サイト設定」および「サイト構成」オプションで確認できます。

ウェブコンテンツ構造とテンプレートサンプルの作成

注記

構造やテンプレートは、ユーザーインターフェースを通して手動でのみ作成できます。

基本的な 構造 と、その構造に基づいた基本的な テンプレート を作成します。 このチュートリアルでは、単一のテキスト フィールドを持つ基本的な構造を使用して、 ContentStructure サービスを説明します。

単一のテキストフィールドを使用した基本的なサンプル構造。

Webコンテンツ構造IDを特定します

  1. サイト メニュー (Site menu) を開き、 コンテンツ & データ → Web コンテンツ に移動します。

  2. 構造 タブをクリックします。

  3. 「ID」列に、構造物のIDを記入してください。

利用するサービスを特定する

Web コンテンツを管理するには、Liferay DXP Headless Delivery API の StructuredContent サービスを使用します。 このサービスとすべての異なるHTTPメソッドを特定するには、Liferay API Explorerを使用してください。 詳細については、 REST サービスの利用 を参照してください。

サイトからウェブコンテンツ構造を取得する

ContentStructures_GET_FromSites.sh cURL スクリプトは、既存の構造を一覧表示します。 このスクリプトは、サイトIDを唯一のパラメーターとして、GET HTTPメソッドでContentStructureサービスを使用します。

メソッドサービス終点
得るコンテンツ構造/v1.0/sites//content-structures

ContentStructures_GET_FromSites.sh スクリプトでは、 ${1} パラメータは siteID を参照します。 スクリプトを実行する際は、例にあるサイトID(20125)の代わりに、ご自身のサイトIDを使用してください。

./ContentStructures_GET_FromSites.sh 20125

以下のコードは、スクリプトによって生成されたJSON出力を示しています。 このスクリプトは、サイト内のすべての構造物を返します。 この例では、 id と name で識別される単一の構造を見ることができます。

{
   "アクション" : { },
   "ファセット" : [ ],
   "アイテム" : [ {
      "利用可能な言語" : [ "en-US" ],
      "contentStructureFields" : [ {
      "dataType" : "string",
      "inputControl" : "テキスト"、
      "ラベル" : "テキスト"、
      "ローカライズ可能" : true、
      "複数" : false、
      "名前" : "Text86549034"、
      "nestedContentStructureFields" : [ ]、
      "オプション" : [ ],
      "定義値" : "",
      "繰り返し可能" : false,
      "必須" : false,
      "showLabel" : true
      } ],
      "creator" : {
      "additionalName" : ""、
      "コンテンツタイプ" : "ユーザーアカウント"、
      "家族名" : "ボウマン"、
      "givenName" : "David"、
      "id" : 20129、
      "name" : "David Bowman"
      },
      "dateCreated" : "2021-08-02T13:15:42Z",
      "dateModified" : "2021-08-02T13:16:57Z"、
      "説明" : ""、
      "ID" : 41837、
      "名前" : "単純な構造"、
      "サイト ID" : 20125
   } ],
   "lastPage" : 1,
   "ページ" : 1、
   "ページサイズ" : 20、
   "合計数" : 1
}

この構造には、 dataType セクションの contentStructureFields で説明されている単一の Text フィールドがあります。 構造に要素を追加すると、 contentStructureFields の下に追加のセクションが表示されます。 以下は、Text ("dataType": "string") と Image フィールド ("dataType": "image" ) を含む構造の JSON 出力の一部です。