- すべてのプロモーションリストを取得
プロモーションをアクティブ化にする
プロモーションを停止
プロモーションコードを検証する
コードで引き換え可能なプロモーションを入手する
すべてのプロモーションリストを取得
LiveOps API (2.0.0)
- バージョン： 2.0.0
- サーバー：
https://store.xsolla.com/api - メールでお問い合わせ
- 連絡先URL： https://xsolla.com/
- 要求されるTLSバージョン： 1.2
LiveOpsは、プロモーションやパーソナライズされたオファーを通じて、プレイヤーの継続的なエンゲージメントを促進するためのツールキットです。
APIを使用して、以下の機能を管理できます：
- プロモーション — ーポン、プロモーションコード、割引、ボーナスキャンペーンを作成または管理します。
- 個人用設定 — 特定の認証済みユーザーに対してのみ、アイテムカタログの表示やプロモーションの適用を行うための条件を指定します。
- プロモーション制限 — ユーザーごとのプロモーション利用回数制限を設定、およびそれらの制限の定期的なリセットを設定します。
- 報酬チェーンとバリューポイント — ポイント蓄積に連動した報酬進行（プログレッシブ報酬）を設定します。
- デイリーチェーン — 定期的なログインを促すための、反復的なデイリー報酬をセットアップします。
- オファーチェーン — 段階的な価格設定や無料報酬オプションを含む、一連の連続購入オファーを構築します。
- アップセル — 付加価値の高いアイテムの購入をユーザーに促す販売手法。
本APIは以下のグループに分かれています：
Admin — キャンペーンやチェーン設定の作成、更新、有効化、削除を行うためのコール。マーチャントまたはプロジェクトの認証情報を使用した基本アクセス認証で認証されます。Client — 認証済みエンドユーザーに代わって、利用可能なプロモーションの取得、有効なチェーンの確認、コードの引き換え、報酬の受け取りなどを行うためのコール。ユーザーJWTで認証されます。
OpenAPI記述をダウンロード
言語
サーバー
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ja/api/liveops/
- https://store.xsolla.com/api/v2/project/{project_id}/promotion/code/{code}/verify
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/{project_id}/promotion/code/{code}/verify
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://store.xsolla.com/api/v2/project/44056/promotion/code/WINTER2021/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'レスポンス
application/json
{ "code": "WINTER2023", "rewards": { "bonus": [ … ], "is_selectable": true }, "type": "coupon" }
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v3/project/{project_id}/admin/promotion
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v3/project/44056/admin/promotion?limit=50&offset=0&enabled=0'レスポンス
application/json
{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/redeemable/code/WINTER2021プロモーションは正常に受信されました。
一意のプロモーションID。external_idには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
デフォルト "coupon_external_id"
例: "coupon_external_id"
プロモーションの名前。キーと値のペアを含む必要があります。 キーは"^[a-z]{2}-[A-Z]{2}$"形式のロケール、値は文字列です。
デフォルト {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
例: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
プロモーションの有効期間。複数の期間を指定する場合は、date_fromとdate_untilの両方が必須となります。
クーポンの総数を制限します。
デフォルト 10
例: 10
一人のユーザーが引き換えできるクーポンの総数を制限します。
デフォルト 10
例: 10
レスポンス
application/json
{ "bonus": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }
個人用カタログ
ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。
パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。
購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。
操作