仮想通貨を作成

Xsolla Developers

または

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

仮想通貨を作成Server-sideAdmin

post/v2/project/{project_id}/admin/items/virtual_currency

仮想通貨を作成します。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

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

Example: 44056

Request Body schema: application/json

sku

required

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

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

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 ベトナム語

Array of objects <= 20 items

属性のリスト。

注意。アイテムの属性は20個以上指定することはできません。制限を超えようとすると、エラーが発生します。

Array (<= 20 items)

external_id

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

一意の属性ID。external_idには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。

required

Array of objects

注意。各属性に6つ以上の値を作成することはできません。制限を超えようとすると、エラーが発生します。

Array

required

object

Default: {"de":"Strategie","en":"Strategy"}

値名がローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

property name*

additional property

string

external_id

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

属性の一意の値ID。external_idには、英小文字、ダッシュ、およびアンダースコアのみが含まれます。

object

Default: {"de":"Genre","en":"Genre"}

属性用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

アイテムの属性と値を含むJSONオブジェクト。属性により、アイテムを使用するために必要なプレイヤーのレベルなど、より詳細な情報をアイテムに追加することができます。属性はゲームの内部ロジックを豊かにし、専用の「取得」メソッドやウェブフックからアクセスできます。

(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 ベトナム語

Array of objects

Default: []

アイテムが所属するグループ。

Array

external_id

string

object

Default: {"en":"Horror"}

アイテム名。キーと値のペアを含める必要があり、キーは "^[a-z]" 書式のロケール{2}で、値は文字列です。

property name*

additional property

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

trueの場合で、アイテムは無料です。

is_hard

boolean

is_show_in_store

boolean

object

アイテム制限。

per_item

integer or null

グローバルアイテム制限。

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... 希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。

(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 ベトナム語

Array of objects

スクリーンショット、ゲームプレイ動画などのアイテム追加アセット。

Array

type	string メディアタイプ：`image`/`video`。 Enum: "image" "video"
url	string リソースファイル。

order

integer

配列順序を定義します。

Array of objects or null

アイテム販売期間。

Array

date_from	string <date-time> 指定されたアイテムの販売開始日。
date_until	string or null <date-time> 指定されたアイテムが販売できなくなる日付。`null`を指定することもできます。

object

release_date required	string or null <date-time>
is_enabled required	boolean
description	string or null

Array of objects

Array

amount required	number > 0 金額。
currency required	string 商品価格の通貨。3文字のコードISO4217 規格詳細については、ドキュメントを参照してください。エクソーラでサポートされている通貨。
country_iso	string or null この価格が利用可能な国。ISO 3166-1 alpha 2に基づく2文字コード。
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false 価格が有効になりました。
sku	string 一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。

Responses

201

仮想アイテムは正常に作成されました。

422

無効なリクエストです。

Request samples

application/json

{"attributes": [{"external_id": "material",
"name": {"en-US": "Material"
},
"values": [{"external_id": "gold",
"value": {"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": ["gold"
],
"is_enabled": true,
"is_free": false,
"limits": {"per_item": 10000,
"per_user": 5
},
"name": {"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [{"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "com.xsolla.coin_1"
}

Response samples

application/json

{"sku": "com.xsolla.item_1"
}