Xsolla-logoXsolla Developers
または
パブリッシャーアカウントへ

ボーナスプロモーションを作成Server-sideAdmin

post/v2/project/{project_id}/admin/promotion/bonus

ボーナスプロモーションを作成します。

プロモーションは、ユーザーによる購入に無料のボーナスアイテムを追加します。 プロモーションは、プロジェクト内のすべての購入、または特定のアイテムを含む購入に適用することができます。

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

Example: 44056
Request Body schema: application/json
required
Array of objects or null

プロモーションを適用するために、購入に含める必要があるアイテムのセット。このパラメータがnullである場合、プロジェクト内のすべての購入にプロモーションが適用されます。

Array
sku
string
Default: "elven_sword"

アイテムSKU。

required
Array of objects or null
Array
quantity
number
Default: 1

アイテム数量。

sku
string
Default: "elven_shield"

アイテムSKU。

required
object

プロモーション名。キーと値のペアを含む必要があります。キーは"^[a-z]{2}-[A-Z]{2}$"フォーマットのロケール、値は文字列です。

property name*
additional property
string
Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)
One of:
[ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
attribute
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$

ユーザー属性コード。

operator
required
string

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

Enum: Description
eq

イコール

ne

ノットイコール

value
required
string <= 255 characters

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

type
required
string

ユーザー属性タイプ。

Value: "string"
can_be_missing
boolean

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

date_end
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

プロモーションが終了する日付。nullにすることができます。 date_endnullの場合、プロモーションは時間無制限となります。

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

プロモーションを開始する日付。

excluded_promotions
Array of integers

このプロモーションを適用する際に除外するプロモーションIDのリスト。
Example:[12, 789]

id
integer

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

object

プロモーションの制限。

per_user
integer or null

別ユーザーでのプロモーション制限。

object or null

制限更新期間。

interval_type = daily (object) or interval_type = 週次 (object) or interval_type = 月次 (object)
One of:

ユーザー制限の日次更新タイプ。

interval_type
required
string

循環更新期間。

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

希望するタイムゾーンでのリミットの更新時刻(時間単位で四捨五入)。

Array of objects or null

Array of objects with conditions that set the price range for applying the promotion.
The promotion applies only to items whose price meets all the conditions in the array. If you pass this array, set the value of the condition object to null.

Array
operator
required
string

プロモーションを適用する価格帯を設定する比較演算子。

Enum: Description
eq

イコール

ge

大なりイコール

gt

より大きい

le

小なりイコール

lt

より小さい

ne

ノットイコール

value
required
string^\d+(\.\d{1,4})?$

プロモーションを適用する価格帯を決定するための値。

Responses
201

プロモーションは正常に作成されました。

401

基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。

422

無効なリクエストです。

Request samples
application/json
{
  • "attribute_conditions": [
    ],
  • "bonus": [
    ],
  • "condition": [
    ],
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "name": {
    }
}
Response samples
application/json
{
  • "promotion_id": 2384756
}