コンテンツへスキップ

LiveOps API (2.0.0)

概要

  • バージョン: 2.0.0
  • サーバーhttps://store.xsolla.com/api
  • メールでお問い合わせ
  • 連絡先URL: https://xsolla.com/
  • 要求されるTLSバージョン: 1.2

LiveOpsは、プロモーションやパーソナライズされたオファーを通じて、プレイヤーの継続的なエンゲージメントを促進するためのツールキットです。

APIを使用して、以下の機能を管理できます:

  • プロモーション — ーポン、プロモーションコード、割引、ボーナスキャンペーンを作成または管理します。
  • 個人用設定 — 特定の認証済みユーザーに対してのみ、アイテムカタログの表示やプロモーションの適用を行うための条件を指定します。
  • プロモーション制限 — ユーザーごとのプロモーション利用回数制限を設定、およびそれらの制限の定期的なリセットを設定します。
  • 報酬チェーンとバリューポイント — ポイント蓄積に連動した報酬進行(プログレッシブ報酬)を設定します。
  • デイリーチェーン — 定期的なログインを促すための、反復的なデイリー報酬をセットアップします。
  • オファーチェーン — 段階的な価格設定や無料報酬オプションを含む、一連の連続購入オファーを構築します。
  • アップセル — 付加価値の高いアイテムの購入をユーザーに促す販売手法。

APIコール

本APIは以下のグループに分かれています:

  • Admin — キャンペーンやチェーン設定の作成、更新、有効化、削除を行うためのコール。マーチャントまたはプロジェクトの認証情報を使用した基本アクセス認証で認証されます。
  • Client — 認証済みエンドユーザーに代わって、利用可能なプロモーションの取得、有効なチェーンの確認、コードの引き換え、報酬の受け取りなどを行うためのコール。ユーザーJWTで認証されます。
OpenAPI記述をダウンロード
言語
サーバー
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ja/api/liveops/
操作

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

操作

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作
操作
操作

クライアント

操作

クランクライアント

操作

クランの下で報酬チェーンへの貢献度トップ10を獲得するClient-side

リクエスト

現在のユーザーのクランの下にある特定の報酬チェーンのトップ10の貢献者のリストを取得します。ユーザーがクランに属していない場合、コールは空の配列を返します。

セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

プロジェクトID。

例: 44056
reward_chain_idinteger必須

報酬チェーンID。

例: 101
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/user/clan/contributors/101/top \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

クランの報酬チェーンへの貢献者トップ10リスト。

ボディapplication/jsonArray [
contributed_amountinteger

ユーザーが貢献したバリューポイントの量。

例: 100
namestring

ユーザーID。これは認証時にエクソーラに送信されるIDで、ユーザーをエクソーラログインプロジェクトにリンクします。

例: "Rocket"
]
レスポンス
application/json
[ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ]

現在のユーザーのクランを更新するClient-side

リクエスト

ユーザー属性を通じて現在のユーザーのクランを更新します。以前のクランで請求されなかった報酬チェーンのすべての報酬を請求し、応答に返します。クランに所属していたユーザーが、現在はクランに所属していない場合、クランへの所属は取り消されます。ユーザーがクランを変更した場合、クランは変更されます。

セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

プロジェクトID。

デフォルト 44056
curl -i -X PUT \
  'https://store.xsolla.com/api/v2/project/{project_id}/user/clan/update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーのクランが正常に更新されました。

ボディapplication/json
rewardArray of objects
レスポンス
application/json
{ "reward": [ {}, {} ] }
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作