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

オプションAPIの基本

オプションテンプレートは、アプリケーションメニューまたはREST APIを使用して管理できます。 headless-commerce-admin-catalog サービスを呼び出して、オプションを作成・管理します。

オプションの追加

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に変更してください。

Liferayが起動したら、

  1. Option API Basicsをダウンロードして解凍してください。

    curl https://resources.learn.liferay.com/examples/liferay-d3g5.zip -O
    
    unzip liferay-d3g5.zip
    
  2. オプションはインスタンスにスコープされ、各オプションは一意のkeyを指定する必要があります。

    cURLスクリプトを使用して新しいオプションを追加します。コマンドラインで、 curlフォルダに移動します。 Options_POST_ToInstance.shスクリプトを実行します。

    ./Options_POST_ToInstance.sh
    

    JSONレスポンスには、新しいオプションが追加されたことが示されています。

    {
       "actions" : {
          "get" : {
             "method" : "GET",
             "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
          },
          "update" : {
             "method" : "PATCH",
             "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
          },
          "delete" : {
             "method" : "DELETE",
             "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
          }
       },
       "description" : { },
       "externalReferenceCode" : "f73e12cd-feae-9e78-5921-6b65f6b993f6",
       "facetable" : false,
       "fieldType" : "select",
       "id" : 46438,
       "key" : "foo",
       "name" : {
          "en_US" : "Foo"
       },
       "required" : false,
       "skuContributor" : false
    }
    
  3. オプションの追加を確認するには、グローバルメニュー(Applications Menu icon)を開き、コマース→オプションに移動します。新しいオプションが表示されます。

    新しいオプションが追加されたことを確認してください。

  4. または、Javaクライアントを使用してRESTサービスを呼び出します。 javaフォルダに移動し、ソースファイルをコンパイルします。

    javac -classpath .:* *.java
    
  5. Options_POST_ToInstanceクラスを実行します。

    java -classpath .:* Options_POST_ToInstance
    

オプションを作成する際に利用できるオプションフィールドの種類は以下のとおりです。

項目タイプAPI値
テキストボックス"fieldType": "text"
プルダウン"fieldType": "select"
ラジオボタン"fieldType": "radio"
複数選択"fieldType": "checkbox_multiple"
日付"fieldType": "date"
数値"fieldType": "numeric"
ブール値"fieldType": "checkbox"

cURLコマンドを調べてみましょう

Options_POST_ToInstance.shスクリプトは、cURL コマンドを使用して REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" \
	--data-raw '
		{
			"fieldType": "select",
			"key": "foo",
			"name": {
				"en_US": "Foo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

コマンドの引数は以下のとおりです。

引数説明
-H "Content-Type: application/json"リクエストボディの形式をJSONに設定します。
-X POST指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options"RESTサービスのエンドポイントを指定します。
-d "{\"fieldType\": \"select\", \"key\": \"foo\", \"name\": {\"en_US\": \"Foo\"}}"投稿するデータを入力します。
-u "test@liferay.com:learn"基本認証の認証情報を入力します。
注記

ここでは、デモンストレーション目的で基本認証を使用しています。本番環境では、 OAuth2を介してユーザーを認証する必要があります。 OAuth2 を使用した React アプリケーションのサンプルについては、「OAuth2 を使用してユーザーを認証する」を参照してください。

他のcURLコマンドも同様のJSON引数を使用します。

Javaクラスを調べます

Options_POST_ToInstance.javaクラスは、 OptionResourceサービスを呼び出すことでオプションを追加します。

public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.postOption(
			new Option() {
				{
					fieldType = Option.FieldType.SELECT;
					key = "foo";
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
				}
			}));
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

行(省略形)説明
OptionResource.Builder builder = ...OptionResource サービスインスタンスを生成するための Builder を取得します。
OptionResource optionResource = builder.authentication(...).build();基本認証を使用し、OptionResourceサービスインスタンスを生成します。
optionResource.postOption(...);optionResource.postOptionメソッドを呼び出し、投稿するデータを渡します。

このプロジェクトには、 com.liferay.headless.commerce.admin.catalog.client.jarファイルが依存関係として含まれています。すべての REST アプリケーションのクライアント JAR 依存関係情報は、インストール先の/o/api (例: http://localhost:8080/o/api) にある API Explorer で確認できます。

注記

mainメソッドのコメントは、クラスの実行方法を示しています。

残りのJavaサンプルクラスは、それぞれ異なるOptionResourceメソッドを呼び出します。

重要

サービスの詳細については、 OptionResourceを参照してください。

以下は、cURLとJavaを使用して他のOption RESTサービスを呼び出す例です。

インスタンスからオプションを取得する

cURLまたはJavaコマンドを使用して、Liferayインスタンス内のすべてのオプションを一覧表示します。

Options_GET_FromInstance.sh

コマンド:

./Options_GET_FromInstance.sh

コード:

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" \
	--user "test@liferay.com:learn"

Options_GET_FromInstance.java

コマンド:

java -classpath .:* Options_GET_FromInstance

コード:

public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.getOptionsPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスのOptionオブジェクトはJSON形式でフォーマットされます。

フィルタリング、ページネーション、検索、および並べ替えオプション

このAPIは、オプションのフィルタリング、ページネーション、検索、ソートを行うためのパラメータも受け付けます。詳細については、 getOptionsPageメソッドを参照してください。クエリで以下のOptionフィールドを使用すると、結果をフィルタリング、検索、および並べ替えることができます。

  • フィールドタイプ
  • 鍵
  • 名前
フィルタークエリ説明
name eq 'Able'オプション名はAbleと同じでなければなりません。
fieldType eq 'select'オプションタイプを必ず選択しなければなりません。
ソートクエリ説明
key:descキーで降順に並べ替えます。
name:desc名前で降順に並べ替えます。

詳細については、 APIクエリパラメータを参照してください。

オプションを取得する

cURLまたはJavaのgetコマンドを使用して、特定のオプションを取得します。 1234オプションのIDに置き換えてください。

ヒント

Options_GET_FromInstance.[java|sh]を使用してすべてのオプションのリストを取得し、特に必要なオプションのidをメモしてください。

Options_GET_ById.sh

コマンド:

./Options_GET_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--user "test@liferay.com:learn"

Options_GET_ById.java

コマンド:

java -classpath .:* -DoptionId=1234 Options_GET_ById

コード:

public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.getOption(
			Long.valueOf(System.getProperty("optionId"))));
}

Option項目はJSON形式で表示されます。

オプションをパッチする

cURLとJavaのpatchコマンドを使用して、既存のオプションを更新します。 1234 、お使いのオプションのIDに置き換えてください。

Options_PATCH_ById.sh

コマンド:

./Options_PATCH_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--data-raw '
		{
			"fieldType": "radio",
			"key": "bar",
			"name": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

Options_PATCH_ById.java

コマンド:

java -classpath .:* -DoptionId=1234 Options_PATCH_ById

コード:

public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionResource.patchOption(
		Long.valueOf(System.getProperty("optionId")),
		new Option() {
			{
				fieldType = Option.FieldType.RADIO;
				key = "bar";
				name = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

オプションを削除する

cURLとJavaのdeleteコマンドを使用して、既存のオプションを削除します。 1234 、お使いのオプションのIDに置き換えてください。

Options_DELETE_ById.sh

コマンド:

./Options_DELETE_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

Options_DELETE_ById.java

コマンド

java -classpath .:* -DoptionId=1234 Options_DELETE_ById

コード:

public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionResource.deleteOption(
		Long.valueOf(System.getProperty("optionId")));
}

APIエクスプローラーには、 Optionサービスとスキーマが表示され、各サービスをテストするためのインターフェースが備わっています。