報酬チェーンを作成する

Xsolla Developers

または

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

報酬チェーンを作成するServer-sideAdmin

post/v2/project/{project_id}/admin/reward_chain

報酬チェーンを作成します。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

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

Example: 44056

Request Body schema: application/json

One of:

報酬チェーン。

required

(two-letter (object or null)) or (five-letter (object or null))

アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字の言語コード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメンテーションで確認できます。

One of:

2文字の小文字の言語コード。

ar	string or null アラビア語
bg	string or null ブルガリア語
cn	string or null 中国語（簡体字）
cs	string or null チェコ語
de	string or null ドイツ語
en	string or null 英語
es	string or null スペイン語（スペイン）
fr	string or null フランス語
he	string or null ヘブライ語
id	string or null インドネシア語
it	string or null イタリア語
ja	string or null 日本語
km	string or null クメール語
ko	string or null 韓国語
lo	string or null ラオス語
my	string or null ビルマ語
ne	string or null ネパール語
ph	string or null フィリピン語
pl	string or null ポーランド語
pt	string or null ポルトガル語
ro	string or null ルーマニア語
ru	string or null ロシア語
th	string or null タイ語
tr	string or null トルコ語
tw	string or null 中国語（繁体字）
vi	string or null ベトナム語

required

object

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

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

date_start

required

string <date-time>

報酬チェーンの開始日。

required

Array of objects

Array

required

(two-letter (object or null)) or (five-letter (object or null))

One of:

2文字の小文字の言語コード。

ar	string or null アラビア語
bg	string or null ブルガリア語
cn	string or null 中国語（簡体字）
cs	string or null チェコ語
de	string or null ドイツ語
en	string or null 英語
es	string or null スペイン語（スペイン）
fr	string or null フランス語
he	string or null ヘブライ語
id	string or null インドネシア語
it	string or null イタリア語
ja	string or null 日本語
km	string or null クメール語
ko	string or null 韓国語
lo	string or null ラオス語
my	string or null ビルマ語
ne	string or null ネパール語
ph	string or null フィリピン語
pl	string or null ポーランド語
pt	string or null ポルトガル語
ro	string or null ルーマニア語
ru	string or null ロシア語
th	string or null タイ語
tr	string or null トルコ語
tw	string or null 中国語（繁体字）
vi	string or null ベトナム語

required

object

amount

required

integer

バリューポイントでのステップ価格。

required

Array of objects

Array

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

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

quantity

required

integer

アイテム数量。

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

image_url

string or null

画像URL。

is_enabled

required

boolean

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

date_end

string or null <date-time>

報酬チェープロモーションが終了する日付。「null」も可能です。date_endがnullの場合、報酬チェーンは時間制限がありません。

(two-letter (object or null)) or (five-letter (object or null))

アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：enとen-US）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメンテーションで確認できます。

One of:

2文字の小文字の言語コード。

ar	string or null アラビア語
bg	string or null ブルガリア語
cn	string or null 中国語（簡体字）
cs	string or null チェコ語
de	string or null ドイツ語
en	string or null 英語
es	string or null スペイン語（スペイン）
fr	string or null フランス語
he	string or null ヘブライ語
id	string or null インドネシア語
it	string or null イタリア語
ja	string or null 日本語
km	string or null クメール語
ko	string or null 韓国語
lo	string or null ラオス語
my	string or null ビルマ語
ne	string or null ネパール語
ph	string or null フィリピン語
pl	string or null ポーランド語
pt	string or null ポルトガル語
ro	string or null ルーマニア語
ru	string or null ロシア語
th	string or null タイ語
tr	string or null トルコ語
tw	string or null 中国語（繁体字）
vi	string or null ベトナム語

image_url

string or null

画像URL。

is_always_visible

boolean

Default: true

報酬チェーンがすべてのユーザーに表示されるかどうか：

trueの場合、ユーザーの認証ステータスや属性に関係なく常にチェーンが表示されます。
falseの場合、適切な報酬チェーンが見つからない場合にのみチェーンが表示されます。例えば、ユーザーが認証されていない場合や、その属性がパーソナライズされたチェーンと一致しない場合などです。

パーソナライズされた報酬チェーンのコンテキストでのみ適用され、attribute_conditions配列が渡されない場合に使用されます。

(two-letter (object or null)) or (five-letter (object or null))

アイテムの詳細な説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：en）または5文字のロケールコード（例：en-US）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント（例：enとen-US）が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、ドキュメンテーションで確認できます。

Any of:

2文字の小文字の言語コード。

ar	string or null アラビア語
bg	string or null ブルガリア語
cn	string or null 中国語（簡体字）
cs	string or null チェコ語
de	string or null ドイツ語
en	string or null 英語
es	string or null スペイン語（スペイン）
fr	string or null フランス語
he	string or null ヘブライ語
id	string or null インドネシア語
it	string or null イタリア語
ja	string or null 日本語
km	string or null クメール語
ko	string or null 韓国語
lo	string or null ラオス語
my	string or null ビルマ語
ne	string or null ネパール語
ph	string or null フィリピン語
pl	string or null ポーランド語
pt	string or null ポルトガル語
ro	string or null ルーマニア語
ru	string or null ロシア語
th	string or null タイ語
tr	string or null トルコ語
tw	string or null 中国語（繁体字）
vi	string or null ベトナム語

order

integer

配列順序を定義します。

(interval_type = 週次 (object or null)) or (interval_type = 月次 (object or null))

報酬チェーンのリセット期間。

One of:

報酬チェーンの週次更新タイプ。

interval_type required	string 報酬チェーンの反復なリセットの頻度。 Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... 希望するタイムゾーンで報酬チェーンがリセットされる時間（時間数に丸める）。例えば、報酬チェーンのリセットの設定時間は、クアラルンプールのタイムゾーン (GMT+8) の 01:00 です。この場合、`time`パラメータの値は`01:00:00+08:00`となります。
day_of_week required	integer [ 1 .. 7 ] 報酬チェーンがリセットされる曜日。`1`は月曜日、`7`は日曜日。

Responses

201

報酬チェーンが正常に作成されました。

401

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

422

無効なリクエストです。

Request samples

application/json

{"clan_type": "guild",
"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "First step of the reward chain"
},
"price": {"amount": 10
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_1"
},
{"quantity": 1,
"sku": "com.xsolla.item_2"
}
]
},
{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "Second step of the reward chain"
},
"price": {"amount": 15
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_3"
},
{"quantity": 1,
"sku": "com.xsolla.item_4"
}
]
}
],
"value_point": {"sku": "com.xsolla.clan_value_point_1"
}
}

Response samples

application/json

{"reward_chain_id": 10
}