20190721

バージョン: 20190721

本バージョンでリリースされた内容は以下の通りです。

使用実績課金

CG-1736 サービス利用者は、サービスが提供する料金プランの詳細が知りたい
料金プランの詳細が確認できるようになりました。
公開されましたCloudGear サービスストアに表示される、プラン名のリンクをクリックしますと、以下のようなプラン詳細画面が表示できます。
作成されました基本プランとオプションプランを画面上部のリンクから切り替えることができます。
各プランの名が表示された枠にはプランの機能などを列挙して表示します。
こちらはプランの作成・編集の際に設定できます。
スライドボタンをクリックしますと表示されていないプランがご覧になれます。
画面中部のプランの詳細情報では以下の内容を表示します。
- 利用料の概算グラフ
- 料金体系
- 課金間隔
- 基本料金　※基本料金付き従量課金の場合に表示されます
- 最低料金　※最低料金付き従量課金の場合に表示されます
- 固定料金　※完全定額課金の場合に表示されます
- 従量単価　※完全定額課金の場合は表示されません
- 数量　　　※変動単価を選択している場合に表示されます
- 無料試用期間　※トライアル期間を設定している場合に表示されます
- 料金計算方式
- プラン概要
画面下部にはプランの詳細説明が表示されます。
プランの詳細／編集画面からWYSIWYGエディタを使用してHTMLを作成できます。
また設定されなくてもサービスストアのプラン詳細画面は表示できます。
詳細はこちらをご覧ください。
CG-1730 サービス提供者は、使用量をCloudGearに送信したい
使用量に基づく料金プランの作成ができるようになったことに伴い、使用量の送信をお願いいたします。
使用量送信のためのOAuthクライアントを作成します。
詳細はこちらをご覧ください。
こちらで作成されますクライアントIDとクライアントシークレットから、WebAPIに使用するアクセストークンを取得します。
サンプルリクエストURL： https://accounts.cloudgear.services/token
POST /token
　Host： accounts.cloudgear.services
　Content-Type： application/x-www-form-urlencoded
```
CURLサンプルリクエスト
curl https://accounts.cloudgear.services/token \
-X POST \
-d "grant_type=client_credentials" \
-d "client_id=<client_id>" \
-d "client_secret=<client_secret>"
```
取得したアクセストークンを使用して使用量の送信をお願いいたします。
サンプルリクエストURL： https://api.cloudgear.services/v1/services/<service_id>/usage_records
POST /v1/services/<service_id>/usage_records
　Host： api.cloudgear.services
　Authorization： Bearer <access_token>
　Content-Type： application/json
```
CURLサンプルリクエスト
curl https://api.cloudgear.services/v1/services/<service_id>/usage_records \
-X POST \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"subscriptionId": "<subscription_id>", "planId": "<plan_id>", "quantity": <quantity>}'
```
詳細はこちらをご覧ください。
CG-1722 サービス提供者は、料金プランに数量の単元を設定したい
料金プランに課金単元数が設定できるようになりました。
課金単元数は、デフォルトで1が設定されています。
課金単元数を2以上に設定することにより、計算上の課金数量を一定のまとまりで増加させることができます。（端数は次の単元まで切り上げられます。）
課金単元数に10が設定されている場合、
実際に使用された数量(以下、実数量)が75の時、単価 × 数量80(実数量75)が利用料として算出されます。
詳細はこちらをご覧ください。
CG-1721 サービス提供者は、使用量により段階的に単価が変わる料金プランを作成したい
単価のタイプが従来の固定単価に加えて、変動単価が選択できるようになりました。
※段階定額課金は変動単価のみです。
※完全定額課金は選択できません。
- 固定単価は、1数量に対して一律同じ単価を利用料として算出します。
- 変動単価は、数量に応じて単価を変動させることができます。
  上記の画像では数量100までの単価が100円、それ以降の単価を50円として利用料を算出します。
変動単価を選択した場合は、料金計算方式を選択することになります。
- 段階積み上げ方式は、数量を段階別に区分し、それぞれの段階の単価と数量を掛けた段階ごとの利用料を積み上げていく方式です。
  上記の画像を例としますと、
  - 数量が100の場合、￥100 × 100(数量) = ￥10,000が利用料となります。
  - 数量が200の場合、￥100 × 100(数量) + ￥50 × 100(数量) = ￥15,000が利用料となります。
- ボリューム方式は、課金サイクルの終了時点の課金数量が到達した段階の単価と課金数量を掛けて利用料を算出する方式です。
  上記の画像を例としますと、
  - 数量が100の場合、￥100 × 100(数量) = ￥10,000が利用料となります。
  - 数量が200の場合、￥ 50 × 200(数量) = ￥10,000が利用料となります。
詳細はこちらをご覧ください。
CG-1720 サービス提供者は、多様な料金プランを設定したい
多様な料金プランが設定できるようになりました。
従来の従量課金（完全従量課金）の料金プランに加えて、４つの新料金プランが選択できます。
- 完全従量課金は、課金数量に対して単価を乗算して利用料を算出します。
- 最低料金付き従量課金では、課金数量に対して固定の単価を乗算して利用料を算出します。
- 基本料金付き従量課金では、従量料金に一定の基本料金を加算して利用料を算出します。
- 完全定額課金では、数量に依存しない固定料金を利用料とします。
- 段階定額課金では、特定の数量の範囲を段階として、段階ごとの固定料金を利用料とします。
詳細はこちらをご覧ください。
CG-1719 サービス提供者は、CloudGearからのWebHookイベントをもとに使用量を送信したい
使用量に基づく料金プランの作成ができるようになったことに伴い、使用量の送信を促すWebHookをCloudGearから送信するようにいたしました。
```
{
  "event": "payments",
  "type": "request-usage-record",
  "data": {
    "service_id": 1,	                // サービスID
    "requests": [{
      "subscription_id": "sub_id",	// サブスクリプションID
      "plan_ids": ["plan_1", "plan_2"], // 契約内の使用量タイプのプランID
      "timestamp": 123456789	        // 発行日時（秒）
    }]
  }
}
```
このWebHookは、毎日04:00（JST）を目処に順次送信いたします。
また、通知はサービス単位で行われ、使用量に基づく料金プランを持つ契約が存在しない場合は、発行されません。
詳細はこちらをご覧ください。
この機能追加にあわせて、サービス側で各契約の課金サイクルを管理できるように、課金が発生する開始日時と終了日時を通知するWebHookも新設いたしました。
```
{
  "event": "payments",
  "type": "change-billing-period",
  "data": {
      "subscription_id": "sub_id"	// サブスクリプションID,
      "service_id": 1,	                // サービスID,
      "square_id": "square_id",	        // スクエアID
      "period_start": 123456789,	// 課金サイクル開始日時（秒）,
      "period_end": 987654321	        // 課金サイクル終了日時（秒）
  }
}
```
このWebHookは、以下の条件で送信されます。
- サービスが契約された時
- トライアル期間が終了した時
- 課金サイクルが終了した時
詳細はこちらをご覧ください。
CG-1716 サービス提供者は、サービス定義の使用実績に基づく料金プランを作成したい
課金単位のタイプが従来のユーザー課金に加えて、サービス定義の使用実績に基づく料金プランが作成できるようになりました。
※完全定額課金の料金タイプを除きます。
- 契約内ユーザは、契約中に存在するユーザ数単位で課金する方式です。
  この方式では、課金周期の開始日にその周期分の利用料の請求が行われます。
- サービス定義の使用実績は、課金周期中のログイン回数やアクティブユーザ数、APIコール回数、ストレージ使用量のようなサービス独自の使用実績指標で課金を行います。
  この方式では、サービスからCloudGearに使用実績量の定期的な送信を行う必要があります。
詳細はこちらをご覧ください。

CloudGear ドキュメント

20190721

目次

使用実績課金

使用実績課金

CG-1736 サービス利用者は、サービスが提供する料金プランの詳細が知りたい

CG-1730 サービス提供者は、使用量をCloudGearに送信したい

CG-1722 サービス提供者は、料金プランに数量の単元を設定したい

CG-1721 サービス提供者は、使用量により段階的に単価が変わる料金プランを作成したい

CG-1720 サービス提供者は、多様な料金プランを設定したい

CG-1719 サービス提供者は、CloudGearからのWebHookイベントをもとに使用量を送信したい

CG-1716 サービス提供者は、サービス定義の使用実績に基づく料金プランを作成したい