Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
個人用カタログ
ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。
パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。
購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/daily_chain/id/101デイリー報酬データが正常に取得されました。
デイリー報酬が繰り返し発生するかどうか。trueの場合、デイリー報酬は終了日後に自動的にリセットされます。次回のstart_dateおよびend_dateのスケジュールは、デイリー報酬ステップの数とstart_dateに設定された初期時間に基づいて決定されます。
ユーザーが報酬をいつ受け取れるかを決定するデイリー報酬のタイプ。
| 列挙型 値 | 説明 |
|---|---|
| calendar_hard | 24時間ごとに次の報酬ステップが解除されます。次のステップ報酬が利用可能になると、受け取られなかった報酬は永久に失われます。 |
| rolling_skippable |
|
| rolling_unskippable |
|
デイリー報酬の終了日。nullにすることも可能です。calendar_hardタイプを設定すると、追加したステップ数に基づいてこの日付が自動的に設定されるため、nullのままにしておいても問題ありません。
アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
これはデイリー報酬で設定されたステップ数です。ここでの各ステップは、デイリー報酬における1日を表します。
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "en": "Daily reward short description" }, "id": 3, "is_enabled": true, "is_recurrent": false, "name": { "en": "Daily reward", "ru": "Ежедневная награда" }, "number_of_steps": 3, "order": 1, "steps": [ { … }, { … }, { … } ], "type": "calendar_hard" }
calendar_hardタイプのデイリー報酬。
デイリー報酬が繰り返し発生するかどうか。trueの場合、デイリー報酬は終了日後に自動的にリセットされます。次回のstart_dateおよびend_dateのスケジュールは、デイリー報酬ステップの数とstart_dateに設定された初期時間に基づいて決定されます。
ユーザーが報酬をいつ受け取れるかを決定するデイリー報酬のタイプ。
| 列挙型 値 | 説明 |
|---|---|
| calendar_hard | 24時間ごとに次の報酬ステップが解除されます。次のステップ報酬が利用可能になると、受け取られなかった報酬は永久に失われます。 |
| rolling_skippable |
|
| rolling_unskippable |
|
アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメントで確認できます。
デイリー報酬ステップの一意識別子。更新時に指定することで、このステップにおけるユーザーの進捗を保持できます。
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
-H 'Content-Type: application/json' \
-d '{
"date_start": "2023-04-15T18:16:00+05:00",
"description": {
"en": "Updated daily reward description"
},
"is_enabled": true,
"name": {
"en": "Updated daily reward",
"ru": "Обновленная ежедневная награда"
},
"order": 4,
"steps": [
{
"items": [
{
"quantity": 1,
"sku": "vg_enabled_shown_in_store_1"
}
],
"step_number": 1
},
{
"items": [
{
"quantity": 1,
"sku": "vg_enabled_shown_in_store_2"
}
],
"step_number": 2
},
{
"items": [
{
"quantity": 1,
"sku": "vg_not_shown_in_store"
}
],
"step_id": 10,
"step_number": 3
},
{
"items": [
{
"quantity": 1,
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
}
],
"step_id": 8,
"step_number": 4
},
{
"items": [
{
"quantity": 1,
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
}
],
"step_number": 5
}
],
"type": "calendar_hard"
}'- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset
- https://store.xsolla.com/api/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/daily_chain/id/101/reset