コンテンツへスキップ
/
指定したユーザーのプロモーション制限を設定する

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記述をダウンロード
index.json
index.yaml
言語
サーバー
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プロパティに渡します。

操作

管理

操作

指定したユーザーのプロモーション制限を増やすServer-sideAdmin

リクエスト

指定されたユーザーが適用される制限内でプロモーションを使用できる残りの回数を増やします。

User limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：

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

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

例: 44056
promotion_idinteger必須

プロモーションID。プロジェクト内での一意のプロモーション識別子。

例: 111425
ボディapplication/json
availableinteger(User-limit_available)>= 1必須

適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。

userobject(User-limit_user)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必須

ユーザーexternal ID。

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

ユーザーのプロモーション制限が正常に受信されました。

ボディapplication/json
per_userobject
レスポンス
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

指定したユーザーのプロモーション制限を設定するServer-sideAdmin

リクエスト

プロモーションの増減後に適用される制限の中で、指定したユーザーが利用できる回数を設定します。

User limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：

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

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

例: 44056
promotion_idinteger必須

プロモーションID。プロジェクト内での一意のプロモーション識別子。

例: 111425
ボディapplication/json
availableinteger(User-limit_available_flexible)>= 0必須

適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。

userobject(User-limit_user)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$必須

ユーザーexternal ID。

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

ユーザーのプロモーション制限が正常に受信されました。

ボディapplication/json
per_userobject
レスポンス
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

ユーザー向けプロモーション制限を更新するServer-sideAdmin

リクエスト

ユーザーがこのプロモーションを再度使用できるように、プロモーション制限を更新します。userパラメータがnullである場合、このコールはすべてのユーザーのこの制限を更新します。

User limit API を使用すると、ユーザーがプロモーションを使用できる回数を制限できます。ユーザー制限自体を構成するには、目的のプロモーションタイプの管理セクションに移動します：

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

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

例: 44056
promotion_idinteger必須

プロモーションID。プロジェクト内での一意のプロモーション識別子。

例: 111425
ボディapplication/json
userobject or null(User-limit_user_flexible)必須
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

ユーザーexternal ID。

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

レスポンス

プロモーション制限が正常に更新されました。

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

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作