コンテンツへスキップ
/
キャンペーンを作成

Subscriptions API (2.0)

概要

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

このAPIリファレンスでは、サブスクリプション、クーポン、およびプロモーションを管理するためのエンドポイントについて説明します。 サブスクリプションの詳細については、製品ガイドおよび用語集を参照してください。

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

トークン

操作

プラン

操作

製品

操作

Subscription management

操作

決済

操作

プロモーション

操作

クーポン

操作

キャンペーンを作成

リクエスト

新しいクーポンキャンペーンを作成します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

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

マーチャントID。

ボディapplication/json必須
campaign_codestring必須

キャンペーンの名前。

campaign_namesobject必須

ローカライズしたキャンペーン名を含むオブジェクト。

campaign_names.​arstring

アラビア語。

campaign_names.​bgstring

ブルガリア語。

campaign_names.​cnstring

中国語（簡体字）。

campaign_names.​csstring

チェコ語。

campaign_names.​destring

ドイツ語。

campaign_names.​enstring

英語。

campaign_names.​esstring

スペイン語。

campaign_names.​frstring

フランス語。

campaign_names.​hestring

ヘブライ語。

campaign_names.​itstring

イタリア語。

campaign_names.​jastring

日本語。

campaign_names.​kostring

韓国語。

campaign_names.​plstring

ポーランド語。

campaign_names.​ptstring

ポルトガル語。

campaign_names.​rostring

ルーマニア語。

campaign_names.​rustring

ロシア語。

campaign_names.​thstring

タイ語。

campaign_names.​trstring

トルコ語。

campaign_names.​twstring

中国語（繁体字）。

campaign_names.​vistring

ベトナム語。

campaign_redeems_count_for_userinteger

キャンペーン内で、ユーザーごとに交換できるクーポンの最大数。nullが渡されたら、交換数に制限はありません。

expiration_datestring(datetime)

ISO8601に準拠した「YYYY-MM-DD’T’HH:MM:SS」形式のキャンペーンの有効期限。

project_idinteger必須

プロジェクトID。

redeems_countinteger

クーポンの最大交換数。nullが渡されると、交換数に制限はありません。

redeems_count_for_userinteger

ユーザーごとに交換できるクーポンの最大数。nullが渡されたら、交換数に制限はありません。

subscription_couponobject

Object containing subscription parameters in a reward.

virtual_currency_amountnumber(float)

報酬の仮想通貨額。

virtual_itemsobject

報酬の仮想アイテムパラメーターの配列。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

レスポンス

Created (作成済み)。

ボディapplication/json
idinteger
例: 9134
レスポンス
application/json
{
  "id": 9134
}

キャンペーンにクーポンを追加

リクエスト

クーポン キャンペーンにクーポン コードを追加します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

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

マーチャントID。

campaign_idinteger必須

キャンペーンID。

ボディapplication/json必須
coupon_codestring必須

クーポンコード。

例: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

レスポンス

No Content (コンテンツなし) 。

プロモーションにキャンペーンを追加

リクエスト

特定のプロモーションにクーポン キャンペーンを添付します。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

ボディapplication/json必須
campaignsArray of integers必須

キャンペーンIDの配列。

例: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

レスポンス

No Content (コンテンツなし) 。

Subscription management

操作