コンテンツへスキップ

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プロパティに渡します。

操作
操作
操作

クライアント

操作

現在のユーザーの報酬チェーンを取得するClient-side

リクエスト

クライアントエンドポイント。現在のユーザー報酬チェーンを取得します。

注意

すべてのプロジェクトには、応答で得られるアイテムの数に制限があります。初期値および最大値は、1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、LIMITOFFSETフィールドを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号(カウントは0から始まります)。

例: offset=0
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーの報酬チェーンが正常に取得されました。

ボディapplication/json
has_moreboolean

ページ数がもっとあることを示す指標として使用されます。

例: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

システム内の報酬チェーンの総数。

例: 10
レスポンス
application/json
{ "has_more": false, "items": [ {}, {} ], "total_items_count": 1 }

現在のユーザーのバリューポイント残高を取得するClient-side

リクエスト

クライアントのエンドポイント。現在のユーザーのバリューポイント残高を取得します。

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

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
reward_chain_idinteger必須

報酬チェーンID。

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

レスポンス

ユーザーのバリューポイント残高が正常に取得されました。

ボディapplication/json
amountinteger

バリューポイントの数量。

descriptionstring or null(value-point-description)

バリューポイントの説明。

image_urlstring(Common_admin-image_url)

画像URL。

例: "https://image.example.com"
is_clanboolean(is_clan)

バリューポイントがクランリワードチェーンで使用されるかどうか。

例: true
long_descriptionstring or null(value-point-long-description)

バリューポイントの長い説明。

namestring(value-point-name)

バリューポイント名。

skustring(value-point-sku)

一意のバリューポイントID。

レスポンス
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

ステップ報酬を請求するClient-side

リクエスト

クライアントのエンドポイント。報酬チェーンから現在のユーザーのステップ報酬を請求します。

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

プロジェクトID。このパラメータは、パブリッシャーアカウントのプロジェクト名の横にあります。

例: 44056
reward_chain_idinteger必須

報酬チェーンID。

例: 101
step_idinteger必須

報酬チェーンのステップID。

例: 120
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

現在のユーザーのステップ報酬を報酬チェーンから取得することに成功しました。

レスポンス
コンテンツなし

クランクライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作