コンテンツへスキップ

LiveOps API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps APIは、プレイヤーエンゲージメントを高めるためのエンドポイントを提供します。

OpenAPI記述をダウンロード
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/liveops/
https://store.xsolla.com/api/
操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

個人用カタログ

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

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

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

操作
操作
操作

アイテムからバリューポイントを削除するServer-sideAdmin

リクエスト

すべてのアイテムからバリューポイント報酬を削除します。

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

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

例: 44056
value_point_skustring必須

バリューポイントSKU。

例: value_point_3
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/items/value_point_3/value_points/rewards

レスポンス

アイテムのバリューポイント報酬は正常に削除されました。

ボディ
レスポンス
コンテンツなし

バリューポイントを持つアイテムのリストを取得するServer-sideAdmin

リクエスト

管理用に、プロジェクト内のバリューポイントを持つすべてのアイテムリストを取得します。

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

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

例: 44056
value_point_skustring必須

バリューポイントSKU。

例: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/items/value_point_3/value_points/rewards

レスポンス

アイテムリストとそのバリューポイント報酬が正常に受け取られました。

ボディapplication/json
itemsArray of objects(admin-item-value-point-reward)
レスポンス
application/json
{ "items": [ {}, {} ] }

アイテムのバリューポイントを部分的に更新するServer-sideAdmin

リクエスト

SKUに基づいて、1つまたは複数のアイテムのバリューポイント数を部分的に更新します。

バリューポイント更新の原則:

  • アイテムがまだバリューポイントを持っていない場合、amountフィールドにゼロ以外の値を送信すると、バリューポイントが作成されます。
  • アイテムがすでにバリューポイントを持っている場合、amountフィールドに 0 以外の値を送信すると、バリューポイントが更新されます。
  • amountが0に設定された場合、そのアイテムの既存のバリューポイントは削除されます。

PUTメソッド(アイテムにバリューポイントを設定する)とは異なり、このPATCHメソッドは、プロジェクト内のアイテムの既存のバリューポイントをすべて上書きするのではなく、指定されたアイテムのみを更新します。

1 つのリクエストで最大100アイテムまで更新できます。重複するアイテム SKU を同じリクエストに含めることはできません。

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

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

例: 44056
value_point_skustring必須

バリューポイントSKU。

例: value_point_3
ボディapplication/jsonArray [
amountinteger>= 0必須

バリューポイントの量。

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$必須

一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。

例: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

レスポンス

アイテムのバリューポイント報酬が正常に更新されました。

ボディ
レスポンス
コンテンツなし

クライアント

操作

クランクライアント

操作
操作

クライアント

操作
操作

クライアント

操作
操作

クライアント

操作