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で認証されます。
リクエスト
ボーナスプロモーションを削除します。削除されたプロモーション：
- プロジェクトで設定されたプロモーションのリストから消えます。
- アイテムカタログとカートに適用されなくなります。
削除後、プロモーションを復元することはできません。
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- 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/111425/bonusボーナスプロモーションが正常に受信されました。
ユーザー属性を検証するための条件。 ユーザー属性が指定されたすべての条件に一致するかどうかに基づいて、プロモーションの可用性を決定します。
プロモーションを適用するために、購入に含める必要があるアイテムのセット。このパラメータがnullである場合、プロジェクト内のすべての購入にプロモーションが適用されます。
このプロモーションを適用する際に除外するプロモーションIDのリスト。
Example：[12, 789]
プロモーションの名前。キーと値のペアを含む必要があります。 キーは"^[a-z]{2}-[A-Z]{2}$"形式のロケール、値は文字列です。
プロモーションを適用する価格帯を設定する条件を持つオブジェクトの配列。
プロモーションは、価格が配列内のすべての条件を満たすアイテムにのみ適用されます。この配列を渡す場合は、条件オブジェクトの値をnullに設定します。
{ "bonus": [ { … }, { … }, { … } ], "condition": [ { … }, { … } ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": { … }, "recurrent_schedule": { … } }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { … }, { … } ], "promotion_periods": [ { … } ] }
ユーザー属性を検証するための条件。 ユーザー属性が指定されたすべての条件に一致するかどうかに基づいて、プロモーションの可用性を決定します。
プロモーションを適用するために、購入に含める必要があるアイテムのセット。このパラメータがnullである場合、プロジェクト内のすべての購入にプロモーションが適用されます。
このプロモーションを適用する際に除外するプロモーションIDのリスト。
Example：[12, 789]
プロモーション名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。
プロモーションを適用する価格帯を設定する条件を持つオブジェクトの配列。
プロモーションは、価格が配列内のすべての条件を満たすアイテムにのみ適用されます。この配列を渡す場合は、条件オブジェクトの値をnullに設定します。
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [
{
"quantity": 50000,
"sku": "com.xsolla.mp_credits"
}
],
"condition": [
{
"sku": "com.xsolla.year_1_season_pass"
}
],
"name": {
"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'個人用カタログ
ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。
パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。
購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。