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

アカウントグループAPIの基本

Liferay DXP/Portal 7.4以降

[アプリケーション] メニューからアカウントグループを管理するか、Liferay の REST API を使用できます。アカウントグループの作成と管理を行うには、これらのサービスをご利用ください。

アカウントグループの追加

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

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

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

次に、以下の手順に従います。

アカウントグループ API の基本をダウンロードして解凍します。

curl https://resources.learn.liferay.com/examples/liferay-v2w6.zip -O

unzip liferay-v2w6.zip

cURLスクリプトを使用して、インスタンスに新しいアカウントグループを追加します。コマンドラインで、curlフォルダに移動します。 AccountGroups_POST_ToInstance.sh スクリプトを実行します。
```
./AccountGroups_POST_ToInstance.sh
```
JSONレスポンスには、新しいアカウントグループが追加されたことが示されています。
```
{
   "customFields" : [ ],
   "dateCreated" : "2025-01-29T12:50:22Z",
   "dateModified" : "2025-01-29T12:50:22Z",
   "description" : "",
   "externalReferenceCode" : "2891fd33-3afb-a175-6e7e-2fdd1acb7a32",
   "id" : 37403,
   "name" : "Foo"
}
```
グローバルメニュー () → アプリケーション → アカウントグループ に移動します。新しいアカウントグループが追加されたことを確認してください。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。以下のコマンドでソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
以下のコマンドで AccountGroups_POST_ToInstance.java クラスを実行します。
```
java --add-opens java.base/java.net=ALL-UNNAMED -classpath .:* AccountGroups_POST_ToInstance
```
Java 8 上で古いバージョンの Liferay を使用している場合は、次のコマンドを使用してください。
```
java -classpath .:* AccountGroups_POST_ToInstance
```

重要

Java 8 で古いバージョンの Liferay を使用している場合は、後続のセクションから --add-opens java.base/java.net=ALL-UNNAMED を削除してください。

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/account-groups" \
	--data-raw '
		{
			"name": "Foo"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

ここでは、コマンドの引数を紹介します。

引数	説明
`--header "Content-Type: application/json"`	リクエストボディのフォーマットがJSONであることを示します。
`--request "POST"`	指定されたエンドポイントで起動するHTTPメソッド
`http://localhost:8080/o/headless-admin-user/v1.0/account-groups`	RESTサービスのエンドポイント
`--data-raw '{ "name": "Foo" }`	お客様が掲載を希望するデータ
`--user "test@liferay.com:learn"`	基本的な認証情報

注

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

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

Javaクラスを調べる

AccountGroups_POST_ToInstance.java クラスは、 AccountGroupResource サービスを呼び出すことでアカウントグループを追加します。

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

	AccountGroupResource accountGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	AccountGroup accountGroup = accountGroupResource.postAccountGroup(
		new AccountGroup() {
			{
				name = "Foo";
			}
		});

	System.out.println(accountGroup);
}

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

行（省略形）	説明
`AccountGroupResource.Builder builder = ...`	`Builder` を取得して、 `AccountGroupResource` サービスインスタンスを生成します。
`AccountGroupResource accountGroupResource = builder.authentication(...).build();`	基本認証を指定し、 `AccountGroupResource` サービスインスタンスを生成します。
`AccountGroup accountGroup = accountResource.postAccount(...);`	`accountGroupResource.postAccountGroup` メソッドを呼び出し、データを post に渡します。

プロジェクトには、依存関係としてcom.liferay.headless.admin.user.client.jarファイルが含まれていることに注意してください。すべてのRESTアプリケーションのクライアントJAR依存関係情報は、/o/apiでインストール先のAPIエクスプローラーで確認できます。

注

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

他の例の Java クラスはこれに似ていますが、異なる AccountGroupResource メソッドを呼び出します。

重要

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

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

インスタンスからアカウントグループを取得する

以下のcURLコマンドまたはJavaコマンドを実行することで、アカウントグループの一覧を表示できます。

AccountGroups_GET_FromInstance.sh

コマンド：

./AccountGroups_GET_FromInstance.sh

コード：

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

AccountGroups_GET_FromInstance.java

コマンド:

java --add-opens java.base/java.net=ALL-UNNAMED -classpath .:* AccountGroups_GET_FromInstance

コード:

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

	AccountGroupResource accountGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		accountGroupResource.getAccountGroupsPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスの AccountGroup オブジェクトが JSON に表示されます。

アカウントグループのフィルタリング、ページネーション、およびソート

このAPIは、アカウントグループのフィルタリング、ページネーション、およびソートを行うためのパラメータも受け付けます。詳細については、 getAccountGroupsPage メソッドを参照してください。クエリで次の AccountGroup フィールドを使用すると、結果をフィルタリングおよびソートできます。

Liferay DXP 2025.Q1+/Portal GA132+customFields
dateCreated
dateModified
name

フィルタークエリ	説明
`name eq 'Foo'`	アカウントグループ名は ‘Foo' と等しくなければなりません
`customFields/orgSize eq '100.0'`	`という名前のカスタムフィールド orgSize` は 100 に等しい

ソートクエリ	説明
`dateModified:desc`	`dateModified` で降順に並べ替え
`name:desc`	`名前` で降順に並べ替え

注

スペースを含まないカスタムフィールドのみ使用できます。

詳細については、 APIクエリパラメータをお読みください。

アカウントグループを取得する

以下のcURLまたはJavaコマンドを使用して、特定のアカウントグループを取得します。 1234をあなたのアカウントグループのIDに置き換えてください。

ヒント

インスタンスのAccountGroupのIDを取得するには、Accounts_GET_FromInstance.[java|sh]を使用します。

AccountGroups_GET_ById.sh

コマンド：

./AccountGroups_GET_ById.sh 1234

コード：

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

AccountGroups_GET_ById.java

コマンド：

java --add-opens java.base/java.net=ALL-UNNAMED -classpath .:* -DaccountGroupId=1234 AccountGroups_GET_ById

コード：

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

	AccountGroupResource accountGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		accountGroupResource.getAccountGroup(
			Long.valueOf(System.getProperty("accountGroupId"))));
}

AccountGroup フィールドは JSON に表示されます。

アカウントグループを設定する

以下のcURLコマンドとJavaコマンドを使用して、既存のアカウントグループを完全に上書きします。 1234 をアカウントグループの ID に置き換えてください。

AccountGroups_PUT_ById.sh

コマンド：

./AccountGroups_PUT_ById.sh 1234

コード：

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

AccountGroups_PUT_ById.java

コマンド：

java --add-opens java.base/java.net=ALL-UNNAMED -classpath .:* -DaccountGroupId=1234 AccountGroups_PUT_ById

コード：

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

	AccountGroupResource accountGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	AccountGroup accountGroup = accountGroupResource.putAccountGroup(
		Long.valueOf(System.getProperty("accountGroupId")),
		new AccountGroup() {
			{
				name = "Bar";
			}
		});

	System.out.println(accountGroup);
}

アカウントグループを削除する

以下のcURLコマンドとJavaコマンドを使用して、既存のアカウントグループを削除します。 1234 をアカウントグループの ID に置き換えてください。

AccountGroups_DELETE_ById.sh

コマンド:

./AccountGroups_DELETE_ById.sh 1234

コード：

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

AccountGroups_DELETE_ById.java

コマンド

java --add-opens java.base/java.net=ALL-UNNAMED -classpath .:* -DaccountGroupId=1234 AccountGroups_DELETE_ById

コード:

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

	AccountGroupResource accountGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	accountGroupResource.deleteAccountGroup(
		Long.valueOf(System.getProperty("accountGroupId")));
}

API Explorer にはすべての アカウント サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

Capability: