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

オプション値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が起動したら、

オプション値 API の基本をダウンロードして解凍します。

curl https://resources.learn.liferay.com/commerce/latest/en/product-management/developer-guide/liferay-c7w9.zip -O

unzip liferay-c7w9.zip

オプション値は、そのオプションに限定されます。オプションを作成していない場合は、オプション API の基本を参照してください。新しいオプション値を作成する際には、オプションの ID 、一意のキー、およびオプション値の名前を指定する必要があります。

cURLスクリプトを使用して、新しいオプション値を追加します。コマンドラインで、 curl フォルダーに移動します。適切なオプション ID をパラメータとして OptionValues_POST_ToOption.sh スクリプトを実行します。

./OptionValues_POST_ToOption.sh 1234

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

{
   "アクション" : {
      "取得" : {
         "メソッド" : "GET"、
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/optionValues/{id}"
      },
      "update" : {
         "method" : "PATCH"、
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/optionValues/{id}"
      }、
      "delete" : {
         "メソッド" : "DELETE"、
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/optionValues/{id}"
      }
   },
   "externalReferenceCode" : "c63216c7-9043-90ab-35b9-6efbe36b47ff",
   "id" : 46709、
   "キー" : "able"、
   "名前" : {
      "en_US" : "Able"
   },
   "優先度" : 0.0
}

オプション値の追加を確認するには、 グローバルメニュー () を開き、 コマース → オプション に移動します。適切なオプションを選択してください。新しいオプション値は「値」セクションに表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
OptionValues_POST_ToOption クラスを実行し、 optionId を適切な値に置き換えます。
```
java -classpath .:* -DoptionId=1234 OptionValues_POST_ToOption
```

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

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}/optionValues" \
	--data-raw '
		{
			"key": "able",
			"name": {
				"en_US": "Able"
			}
		}' \
	--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/${1}/optionValues"`	RESTサービスのエンドポイントを指定します。
`-d "{\"key\": \"able\", \"name\": {\"en_US\": \"Able\"}}"`	投稿するデータを入力します。
`-u "test@liferay.com:learn"`	基本認証の認証情報を入力します。

注記

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

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

Javaクラスを調べます

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

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

	OptionValueResource optionValueResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionValueResource.postOptionIdOptionValue(
			Long.valueOf(System.getProperty("optionId")),
			new OptionValue() {
				{
					key = "able";
					name = new HashMap<String, String>() {
						{
							put("en_US", "Able");
						}
					};
				}
			}));
}

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

行（省略形）	説明
`OptionValueResource.Builder builder = ...`	`Builder` を取得して、 `OptionValueResource` サービスインスタンスを生成します。
`OptionValueResource optionValueResource = builder.authentication(...).build();`	基本認証を使用して、 `OptionValueResource` サービスインスタンスを生成します。
`optionValueResource.postOption(...);`	`optionValueResource.postOptionIdOptionValue` メソッドを呼び出し、データを post に渡します。

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

注記

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

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

重要

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

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

オプションからオプション値を取得する

cURLまたはJavaコマンドを使用して、オプションからすべてのオプション値を一覧表示します。 1234 をオプションの ID に置き換えてください。

OptionValues_GET_FromOption.sh

コマンド：

./OptionValues_GET_FromOption.sh 1234

コード：

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

OptionValues_GET_FromOption.java

コマンド：

java -classpath .:* -DoptionId=1234 OptionValues_GET_FromOption

コード：

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

	OptionValueResource optionValueResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionValueResource.getOptionIdOptionValuesPage(
			Long.valueOf(System.getProperty("optionId")), null,
			Pagination.of(1, 2), null));
}

オプションの OptionValue オブジェクトは JSON 形式でフォーマットされます。

オプション値を取得する

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

ヒント

OptionValues_GET_FromOption.[java|sh] を使用して、オプションに関連付けられているすべてのオプション値のリストを取得し、特に必要なオプション値の id をメモします。

OptionValues_GET_ById.sh

コマンド：

./OptionValues_GET_ById.sh 1234

コード：

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

OptionValues_GET_ById.java

コマンド：

java -classpath .:* -DoptionValueId=1234 OptionValues_GET_ById

コード：

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

	OptionValueResource optionValueResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionValueResource.getOptionValue(
			Long.valueOf(System.getProperty("optionValueId"))));
}

OptionValue フィールドは JSON でリストされています。

オプション値をパッチする

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

OptionValues_PATCH_ById.sh

コマンド：

./OptionValues_PATCH_ById.sh 1234

コード：

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

OptionValues_PATCH_ById.java

コマンド：

java -classpath .:* -DoptionValueId=1234 OptionValues_PATCH_ById

コード：

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

	OptionValueResource optionValueResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionValueResource.patchOptionValue(
		Long.valueOf(System.getProperty("optionValueId")),
		new OptionValue() {
			{
				name = new HashMap<String, String>() {
					{
						put("en_US", "ベイカー");
					}
				};
			}
		});
}

オプション値を削除する

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

OptionValues_DELETE_ById.sh

コマンド：

./OptionValues_DELETE_ById.sh 1234

コード：

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

OptionValues_DELETE_ById.java

コマンド：

java -classpath .:* -DoptionValueId=1234 OptionValues_DELETE_ById

コード：

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

	OptionValueResource optionValueResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionValueResource.deleteOptionValue(
		Long.valueOf(System.getProperty("optionValueId")));
}

API Explorer は OptionValue サービスとスキーマを表示し、各サービスをテストするためのインターフェースを備えています。