クーポンプロモーションを作成

または

パブリッシャーアカウントへ

クーポンプロモーションを作成Server-sideAdmin

post/v3/project/{project_id}/admin/coupon

クーポンプロモーションを作成します。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

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

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

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

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

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

property name*

additional property

string

Array of type = string (object) or type = number (object) or type = date (object) [ 1 .. 100 ] items

ユーザー属性を検証するための条件。ユーザー属性が指定されたすべての条件に一致するかどうかに基づいて、プロモーションの可用性を決定します。

Array ([ 1 .. 100 ] items)

One of:

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 - その属性を持っているが、値が条件に指定されたものと一致しないか、属性が欠落しているユーザーには、アイテムは表示されません。

Array of objects or null

Array

quantity	number Default: 1 アイテム数量。
sku	string Default: "elven_shield" アイテムSKU。

Array of objects

プロモーションの有効期間。複数の期間を指定する場合は、date_fromとdate_untilの両方が必須となります。

Array

date_from required	string <date-time> 指定されたプロモーションの開始日。
date_until	string or null <date-time> 指定されたプロモーションの終了日。`null`に設定した場合、プロモーションは無期限となります。単一の有効期間のみが指定されている場合に限り、`null`に設定可能です。

redeem_code_limit

integer or null

Default: 10

コードごとの引き換え回数。

redeem_total_limit

integer or null

Default: 10

クーポンの総数を制限します。

redeem_user_limit

integer or null

Default: 10

一人のユーザーが引き換えできるクーポンの総数を制限します。

Responses

201

クーポンが正常に作成されました。

401

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

422

無効なリクエストです。

Request samples

application/json

{"attribute_conditions": [{"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [{"quantity": 1,
"sku": "com.xsolla.elven_sword_2"
}
],
"external_id": "coupon_external_id",
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [{"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}

Response samples

application/json

{"external_id": "coupon_external_id"
}