コンテンツへスキップ
/
現在のユーザーのオファーチェーンを取得する

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/

管理者

操作

個人用カタログ

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

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

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

操作

管理者

操作

カタログ

操作

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

操作

カート（サーバー側）

操作

決済（クライアント側）

操作

決済（サーバー側）

操作

注文

操作

無料アイテム

操作

ウェブフック

操作

先行予約

操作

マーチャント

操作

カタログ

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

操作

共通地域

操作

カタログ

操作

資格

操作

管理者

操作

通常

操作

クーポン

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

操作

プロモーションコード

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

操作

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

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

操作

ディスカウント

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

操作

ボーナス

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

操作

管理者

操作

カタログ

操作

仮想決済

操作

管理

操作

管理者

操作

クライアント

操作

クランクライアント

操作

管理者

操作

クライアント

操作

現在のユーザーのオファーチェーンを取得するClient-side

リクエスト

現在のユーザーのオファーチェーンを取得します。

注意

すべてのプロジェクトには、1つの応答で返されるアイテム数に制限があります。デフォルトおよび最大値は1応答50アイテムです。より多くのデータを取得するには、ページネーションのためにlimitとoffsetクエリパラメータを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
クエリ
limitinteger>= 1

ページでの要素数の制限。

例: limit=50
offsetinteger>= 0

リストが生成される要素番号（カウントは0から始まります）。

例: offset=0
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

オファーチェーンのリストが正常に受信されました。

ボディapplication/json
has_moreboolean

これ以上ページがあるかどうかを示します。

例: true
itemsArray of objects(client-offer-chain-model)
total_items_countinteger

利用可能なオファーチェーンの総数。

例: 10
レスポンス
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "total_items_count": 3
}

IDで現在のユーザーのオファーチェーンを取得するClient-side

リクエスト

現在のユーザーのオファーチェーンをIDで取得します。

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

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

例: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/offer_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

ユーザーのオファーチェーンが正常に取得されました。

ボディapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

オファーチェーンの終了日です。nullも可能です。もしdate_endがnullの場合、オファーチェーンには期限が設定されません。

例: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

オファーチェーンの開始日。

例: "2020-04-15T18:16:00+05:00"
descriptionstring or null

オファーチェーンの説明。

例: "Major weekly quest"
idinteger

オファーチェーンID。

例: 9
namestring

オファーチェーン名。

例: "Weekly quest"
next_step_numberinteger or null

次回のオファーチェーンステップ番号。オファーチェーンが完了した場合はnull。

例: 1
orderinteger(order)

配列順序を定義します。

例: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

オファーチェーンのリセット期間。

stepsArray of objects(client-offer-chain-step-model)
レスポンス
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2010-04-15T18:16:00+05:00",
  "description": null,
  "id": 4,
  "name": "Offer chain with bundles",
  "next_step_number": 1,
  "order": 1,
  "recurrent_schedule": null,
  "steps": [
    { … },
    { … }
  ]
}

無料オファーチェーンステップを請求するClient-side

リクエスト

現在のユーザーのオファーチェーンステップの進行を完了させ、関連する報酬を付与します。

注意

このコールは、オファーチェーン内の無料ステップにのみ使用してください。 実際通貨での支払いが必要なステップには、代わりに有料オファーチェーンステップの注文を作成するコールを使用してください。
セキュリティ
XsollaLoginUserJWT
パス
project_idinteger必須

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

例: 44056
offer_chain_idinteger必須

オファーチェーンID。

例: 101
step_numberinteger必須

オファーチェーンステップ番号。

例: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ja/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

レスポンス

無料ステップが正常に請求され、報酬が付与されました。

ボディapplication/json
order_idinteger

注文ID。

レスポンス
application/json
{
  "order_id": 641
}

管理者

操作

クライアント

操作

管理者

操作

クライアント

操作

管理者

操作