コンテンツへスキップ

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つの応答で返されるアイテム数に制限があります。デフォルトおよび最大値は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/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

オファーチェーンのリストが正常に受信されました。

ボディapplication/json
has_moreboolean

これ以上ページがあるかどうかを示します。

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

利用可能なオファーチェーンの総数。

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

IDで現在のユーザーのオファーチェーンを取得するClient-side

リクエスト

現在のユーザーのオファーチェーンをIDで取得します。

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

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

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

レスポンス

ユーザーのオファーチェーンが正常に取得されました。

ボディapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

オファーチェーンの終了日です。nullも可能です。もしdate_endnullの場合、オファーチェーンには期限が設定されません。

例: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

オファーチェーンの開始日。

例: "2020-04-15T18:16:00+05:00"
descriptionstring or null

オファーチェーンの説明。

例: "Major weekly quest"
idinteger

オファーチェーンID。

例: 9
namestring

オファーチェーン名。

例: "Weekly quest"
next_step_numberinteger or null

次回のオファーチェーンステップ番号。オファーチェーンが完了した場合はnull

例: 1
orderinteger(order)

配列順序を定義します。

例: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

オファーチェーンのリセット期間。

stepsArray of objects(client-offer-chain-step-model)
レスポンス
application/json
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2010-04-15T18:16:00+05:00", "description": null, "id": 4, "name": "Offer chain with bundles", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ {}, {} ] }

無料オファーチェーンステップを請求するClient-side

リクエスト

現在のユーザーのオファーチェーンステップの進行を完了させ、関連する報酬を付与します。

注意

このコールは、オファーチェーン内の無料ステップにのみ使用してください。 実際通貨での支払いが必要なステップには、代わりに有料オファーチェーンステップの注文を作成するコールを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

例: 101
step_numberinteger必須

オファーチェーンステップ番号。

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

レスポンス

無料ステップが正常に請求され、報酬が付与されました。

ボディapplication/json
order_idinteger

注文ID。

レスポンス
application/json
{ "order_id": 641 }
操作

クライアント

操作