コンテンツへスキップ
/
属性値を削除

Shop Builder API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/shop-builder/
https://store.xsolla.com/api/

管理者

操作

属性値を作成Server-sideAdmin

リクエスト

属性値を作成します。

注意

すべてのプロジェクトには、応答で得られる属性値に制限があります。初期値および最大値は、1属性あたり20個の値。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
external_idstring必須

属性external ID。

例: attribute_id
ボディapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$必須

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

例: "attribute_value"
valueobject(value-name)必須

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

デフォルト {"de":"Strategie","en":"Strategy"}
例: {"de":"Strategie","en":"Strategy"}
value.​property name*string追加プロパティ
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

レスポンス

属性値は正常に作成されました。

ボディapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

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

例: "attribute_value"
レスポンス
application/json
{
  "external_id": "rpg"
}

属性値を削除Server-sideAdmin

リクエスト

一つの属性値を削除します。

注意

属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
value_external_idstring^[-_\.\d\w]+$必須

属性値のexternal ID。

例: value_id
external_idstring必須

属性external ID。

例: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value/value_id

レスポンス

属性値が正常に削除されました。

レスポンス
コンテンツなし

属性値を更新Server-sideAdmin

リクエスト

属性値を更新します。

セキュリティ
basicAuth
パス
project_idinteger必須

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

例: 44056
value_external_idstring^[-_\.\d\w]+$必須

属性値のexternal ID。

例: value_id
external_idstring必須

属性external ID。

例: attribute_id
ボディapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$必須

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

例: "attribute_value"
valueobject(value-name)必須

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

デフォルト {"de":"Strategie","en":"Strategy"}
例: {"de":"Strategie","en":"Strategy"}
value.​property name*string追加プロパティ
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/admin/attribute/attribute_id/value/value_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

レスポンス

属性値が正常に更新されました。

レスポンス
コンテンツなし

個人用カタログ

ユーザー属性に応じたルールを指定することができるAPIです。 ユーザーが具体的なルールの条件をすべて満たした場合、パーソナライズされたアイテムが表示されます。

パーソナライズされたプロモーションについては、プロモーションセクションを参照してください。

購入前に属性を渡すには、Xsolla Login APIを使うか、Pay Station APIを使ってトークンを生成する際にそれをuser.attributesプロパティに渡します。

操作

管理者

操作

カタログ

操作

カート（クライアント側）

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

このAPIは販売可能なアイテムや特定のアイテムを取得することができます。

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

このAPIを使用すると、クーポンを管理できます。

操作

プロモーションコード

このAPI を使用すると、プロモーションコードを管理できます。

操作

ユニークなカタログオファー

このAPIを使用すると、ユニークなカタログオファーを管理することができます。

操作

ディスカウント

このAPIを使用すると、割引キャンペーンを管理することができます。

操作

ボーナス

このAPIを使用すると、ボーナスプロモーションを管理できます。

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作