コンテンツへスキップ
/
指定されたグループごとにアイテムリストを取得する

Digital Distribution Hub (1.0.0)

概要

Digital Distribution Hubは、プッシュペイメント技術やEコマースを介して、デジタルとキャッシュベースの決済を結びつけることを目的とした、エクソラの新しいソリューションです。

この参照は、以下の2つエクソラ製品のAPIエンドポイントを組み合わせたものです：ゲーム内ストアと決済ステーション。2つのベースURLがあります：

  • 一般、カタログ、カート、及び注文グループの場合は https://store.xsolla.com/api。
  • 通知グループの場合は、https://ps.xsolla.com。

カタロググループのAPIエンドポイントは認証を必要としません。

カートと注文グループの操作を行うには、ユーザートークンを作成するを介してトークンを生成する必要があります。

注意

この参照は、将来のAPIのデザインを示すものであり、完全に機能するインターフェースではありません。現在は、カタログおよび通知グループのエンドポイントのみを試すことができます。ご意見をお聞かせいただける場合は、techdoc@xsolla.comまでご連絡ください。
OpenAPI記述をダウンロード
index.json
index.yaml
言語
サーバー
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ja/api/digital-distribution-hub/

カート

操作

ゲームキー

操作

仮想アイテム & 通貨

操作

仮想アイテムリストを取得する

リクエスト

カタログを作成するための仮想アイテムリストを取得します。

注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
セキュリティ
AuthForClient
パス
project_idinteger必須

プロジェクトID。

例: 44056
クエリ
limitinteger

ページにある要素数の制限。

例: limit=50
offsetinteger

リストが生成される要素の番号（0からカウントされる）。

例: offset=0
localestring

応答言語。ISO639-1に準拠した2文字の小文字の言語コード。

デフォルト "en"
additional_fields[]Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストで送信した場合、応答に含まれます。利用可能なフィールドmedia_list、order、long_descriptionです。

countrystring

カタログの地域別価格と制限を計算するための国。ISO 3166-1 alpha-2に準拠した2文字の大文字の国コードです。国を明示的に指定しない場合は、ユーザーのIPアドレスに基づいて計算されます。

デフォルト "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/virtual_items?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

仮想アイテムのリストが正常に受信されました。

ボディapplication/json
itemsArray of objects(Catalog_inline_response_200_5_items)
例: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"external_id":"rating_e3364991f92e751689a68b96598a5a5a84010b85","value":"3.9"}]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

ゲームに対応する属性とその値のリスト。

注意。応答のこの部分は、`additional_fields[] = attributes`クエリパラメータを送信した場合にのみ使用できます。
デフォルト []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

例: "attribute_1"
items[].​attributes[].​namestring

属性の名前。

例: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

例: "attribute_value"
items[].​attributes[].​values[].​valuestring

属性の値。

例: "Strategy"
items[].​descriptionstring

アイテム説明。

例: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

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

例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_5_inventory_options)

インベントリアイテムオプションを定義します。

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

消耗品の場合は消耗品のプロパティを、非消耗品の場合はnullを定義します。

items[].​inventory_options.​consumable.​usages_countinteger or null

消耗品の場合は残りの総使用回数、非消耗品の場合はnullとなります。

例: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_5_inventory_options_expiration_period)

期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合はnullを定義します。

items[].​inventory_options.​expiration_period.​typestring

アイテムの有効期限のタイプを定義します。

列挙型"minute""hour""day""week""month""year"
例: "day"
items[].​inventory_options.​expiration_period.​valueinteger

有効期限の値を定義します。

例: 1
items[].​is_freeboolean

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

例: false
items[].​namestring

アイテム名。

例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

アイテム価格。

items[].​price.​amountstring

割引商品価格。

例: "100.99"
items[].​price.​amount_without_discountstring

アイテム価格。

例: "100.99"
items[].​price.​currencystring

デフォルトの購入通貨。ISO 4217ごとの3文字のコード。

例: "USD"
items[].​skustring

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

例: "big_rocket"
items[].​typestring

アイテムのタイプ：virtual_good/virtual_currency/bundle。

例: "virtual_good"
items[].​virtual_item_typestring

仮想アイテムのタイプ。

列挙型"consumable""non_consumable""non_renewing_subscription"
例: "non-consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

仮想価格。

items[].​virtual_prices[].​amountinteger

仮想通貨での割引アイテム価格。

例: 100
items[].​virtual_prices[].​amount_without_discountinteger

アイテム価格。

例: 200
items[].​virtual_prices[].​descriptionstring

仮想通貨の説明。

例: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring

仮想通貨の画像。

例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

アイテムの価格がデフォルトであるかどうか。

例: true
items[].​virtual_prices[].​namestring

仮想通貨名。

例: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

仮想通貨アイテムSKU。

例: "vc_test"
items[].​virtual_prices[].​typestring

仮想通貨タイプ。

例: "virtual_currency"
レスポンス
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

指定されたグループごとにアイテムリストを取得する

リクエスト

カタログを作成するために、指定されたグループからアイテムリストを取得します。

注意すべてのプロジェクトには、取得できるアイテムの数に制限があります。応答。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
セキュリティ
AuthForClient
パス
project_idinteger必須

プロジェクトID。

例: 44056
external_idstring必須

グループ外部ID。

デフォルト "all"
クエリ
limitinteger

ページにある要素数の制限。

例: limit=50
offsetinteger

リストが生成される要素の番号（0からカウントされる）。

例: offset=0
localestring

応答言語。ISO639-1に準拠した2文字の小文字の言語コード。

デフォルト "en"
additional_fields[]Array of strings

追加フィールドのリスト。これらのフィールドは、リクエストで送信した場合、応答に含まれます。利用可能なフィールドmedia_list、order、long_descriptionです。

countrystring

カタログの地域別価格と制限を計算するための国。ISO 3166-1 alpha-2に準拠した2文字の大文字の国コードです。国を明示的に指定しない場合は、ユーザーのIPアドレスに基づいて計算されます。

デフォルト "US"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/items/virtual_items/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

指定されたグループからのアイテムリストが正常に受信されました。

ボディapplication/json
itemsArray of objects(Catalog_inline_response_200_8_items)
例: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]}]
items[].​attributesArray of objects(Catalog_client-attributes)

ゲームに対応する属性とその値のリスト。

注意。応答のこの部分は、`additional_fields[] = attributes`クエリパラメータを送信した場合にのみ使用できます。
デフォルト []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

例: "attribute_1"
items[].​attributes[].​namestring

属性の名前。

例: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

例: "attribute_value"
items[].​attributes[].​values[].​valuestring

属性の値。

例: "Strategy"
items[].​descriptionstring

アイテム説明。

例: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

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

例: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
例: "accessory"
items[].​groups[].​namestring
例: "Accessory"
items[].​image_urlstring

画像のURL。

例: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

インベントリアイテムオプションを定義します。

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

消耗品の場合は消耗品のプロパティを、非消耗品の場合はnullを定義します。

items[].​inventory_options.​consumable.​usages_countinteger or null

消耗品の場合は残りの総使用回数、非消耗品の場合はnullとなります。

例: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合はnullを定義します。

items[].​inventory_options.​expiration_period.​typestring

アイテムの有効期限のタイプを定義します。

列挙型"minute""hour""day""week""month""year"
例: "day"
items[].​inventory_options.​expiration_period.​valueinteger

有効期限の値を定義します。

例: 1
items[].​is_freestring

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

例: "false"
items[].​namestring

アイテム名。

例: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

アイテム価格。

items[].​price.​amountstring

割引商品価格。

例: "100.99"
items[].​price.​amount_without_discountstring

アイテム価格。

例: "100.99"
items[].​price.​currencystring

デフォルトの購入通貨。ISO 4217ごとの3文字のコード。

例: "USD"
items[].​skustring

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

例: "big_rocket"
items[].​typestring

アイテムのタイプ：consumable/expiration/permanent/lootboxes/physical。

例: "virtual_good"
items[].​virtual_item_typestring

仮想アイテムのタイプ。

列挙型"consumable""non_consumable""non_renewing_subscription"
例: "non_consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_8_virtual_prices)

仮想価格。

items[].​virtual_prices[].​amountinteger

仮想通貨での割引アイテム価格。

例: 100
items[].​virtual_prices[].​amount_without_discountinteger

アイテム価格。

例: 200
items[].​virtual_prices[].​descriptionstring

仮想通貨の説明。

例: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring
例: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

アイテムの価格がデフォルトであるかどうか。

例: true
items[].​virtual_prices[].​namestring

仮想通貨名。

例: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

仮想通貨アイテムSKU。

例: "vc_test"
items[].​virtual_prices[].​typestring

仮想通貨タイプ。

例: "virtual_currency"
レスポンス
application/json
{
  "items": [
    { … },
    { … }
  ]
}

バンドル

操作

ユーザートークン

操作

通知

操作

注文

操作