コンテンツへスキップ
/
カタログフィルタルールを取得

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記述をダウンロード
index.json
index.yaml
言語
サーバー
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
rule_idnumber必須

ルールID。

例: 1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/user/attribute/rule/1

レスポンス

削除に成功しました。

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

カタログフィルタルールを取得Server-sideAdmin

リクエスト

ユーザー属性に適用される特定のルールを取得します。

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

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

例: 44056
rule_idnumber必須

ルールID。

例: 1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/user/attribute/rule/1

レスポンス

ルールは正常に受信されました。

ボディapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] items必須

ユーザー属性を検証するための条件。 ユーザー属性が指定されたすべての条件に一致するかどうかに基づいて、カタログ内のアイテムの可用性を決定します。

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$

ユーザー属性コード。

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

ユーザー属性に属性がない場合でも条件を満たすことを示します。trueを渡すと、この属性を持たないユーザーにもアイテムを表示します。属性は持っているが、値が条件で指定されたものと一致しないユーザーには、アイテムは表示されません。false - その属性を持っているが、値が条件に指定されたものと一致しないか、属性が欠落しているユーザーには、アイテムは表示されません。

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)

条件によって実行される操作のタイプ。string属性タイプの場合。

列挙型 値説明
eq

イコール

ne

ノットイコール

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)

ユーザー属性タイプ。

値"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characters

ユーザー属性値の比較対象となる条件値。ライプは属性タイプに依存します。

is_enabledboolean必須

ルールが有効な場合。

is_satisfied_for_unauthboolean

アイテムを無許可のユーザーに表示するかどうか。「true」の場合、カタログ表示ルールに関係なく、アイテムは権限のないユーザーに表示されます。デフォルトでは「false」です。

itemsArray of objects必須
items[].​bundle_typestring

バンドルタイプ。アイテムタイプがバンドルの場合に返されます。

列挙型"standard""virtual_currency_package"
items[].​item_idnumber

アイテムID。

items[].​namestring

アイテム名。

items[].​skustring

アイテムSKU。

items[].​typestring

アイテムのタイプ。

列挙型"virtual_good""virtual_currency""bundle""physical_good""unit"
namestring必須

ルールの読みやすい名前。パブリッシャーアカウントでルールを表示するために使用します。

rule_idnumber必須

ルールID。

レスポンス
application/json
{
  "attribute_conditions": [
    { … }
  ],
  "is_enabled": true,
  "is_satisfied_for_unauth": true,
  "items": [
    { … }
  ],
  "name": "Ork race armor rule",
  "rule_id": 1
}

カタログフィルタルールを修正Server-sideAdmin

リクエスト

ユーザー属性に適用される特定のルールを更新します。指定されていないプロパティには、現在の値が使用されます。

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

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

例: 44056
rule_idnumber必須

ルールID。

例: 1
ボディapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] items

ユーザー属性を検証するための条件。 ユーザー属性が指定されたすべての条件に一致するかどうかに基づいて、カタログ内のアイテムの可用性を決定します。

is_enabledboolean

ルールが有効な場合。

is_satisfied_for_unauthboolean

アイテムを無許可のユーザーに表示するかどうか。「true」の場合、カタログ表示ルールに関係なく、アイテムは権限のないユーザーに表示されます。デフォルトでは「false」です。

itemsArray of objects[ 1 .. 100 ] items
namestring[ 1 .. 255 ] characters^\S

ルールの読みやすい名前。パブリッシャーアカウントでルールを表示するために使用します。

curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/liveops/v2/project/44056/admin/user/attribute/rule/1 \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": false
  }'

レスポンス

更新に成功しました。

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

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作