キャンペーンを作成

Xsolla Developers

または

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

キャンペーンを作成Server-sideAdmin

post/merchants/{merchant_id}/coupon_promotions

新しいクーポンキャンペーンを作成します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

マーチャントID。

Request Body schema: application/json

campaign_code

required

string

キャンペーンの名前。

project_id

required

integer

プロジェクトID。

required

object

ローカライズしたキャンペーン名を含むオブジェクト。

ar	string アラビア語。
bg	string ブルガリア語。
cn	string 中国語（簡体字）。
cs	string チェコ語。
de	string ドイツ語。
en	string 英語。
es	string スペイン語。
fr	string フランス語。
he	string ヘブライ語。
it	string イタリア語。
ja	string 日本語。
ko	string 韓国語。
pl	string ポーランド語。
pt	string ポルトガル語。
ro	string ルーマニア語。
ru	string ロシア語。
th	string タイ語。
tr	string トルコ語。
tw	string 中国語（繁体字）。
vi	string ベトナム語。

campaign_redeems_count_for_user

integer

キャンペーン内で、ユーザーごとに交換できるクーポンの最大数。nullが渡されたら、交換数に制限はありません。

expiration_date

string <datetime>

ISO8601に準拠した「YYYY-MM-DD’T’HH:MM:SS」形式のキャンペーンの有効期限。

redeems_count

integer

クーポンの最大交換数。nullが渡されると、交換数に制限はありません。

redeems_count_for_user

integer

ユーザーごとに交換できるクーポンの最大数。nullが渡されたら、交換数に制限はありません。

object

報酬でサブスクリプションパラメータを含むオブジェクト。

plan_id required	integer サブスクリプションプラン ID。
product_id required	integer サブスクリプション製品 ID。
trial_period required	integer 試用期間（日数）。

virtual_currency_amount

number <float>

報酬の仮想通貨額。

object

報酬の仮想アイテムパラメーターの配列。

sku required	string 仮想アイテムSKU。
quantity required	integer 仮想アイテム数量。

Responses

201

Created (作成済み)。

Request samples

application/json

{"campaign_code": "sample_campaign",
"campaign_names": {"en": "Campaign Name",
"ru": "Название кампании"
},
"campaign_redeems_count_for_user": 1,
"expiration_date": "2019-12-31",
"project_id": 12345,
"redeems_count": 10,
"redeems_count_for_user": 1,
"subscription_coupon": {"plan_id": 123,
"product_id": 456,
"trial_period": 30
},
"virtual_currency_amount": 200
}

Response samples

application/json

{"id": 9134
}