このページは Cloud Translation API によって翻訳されました。

調整可能な通知プランを構成する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。詳細

はじめに

調整可能な通知プランでは、API プロバイダが通知のターゲット数を調整し、トランザクション数を記録します通知を送信するかどうかとそのタイミングを構成できます。特定の割合（90%、100%、150% など）に達したときに発生します。追加ターゲット数に達した後も取引はブロックされません。

UI を使用した調整可能な通知プランの構成

以下で説明するように、調整可能な通知プランを構成します。

Edge

レートの追加または編集時に Edge UI を使用して調整可能な通知プランを構成する料金プランに [Adjustable Notification] 料金プランを選択し、[Adjustable Notification] セクションで次の情報を構成します。

フィールド	説明	デフォルト
計算頻度	トランザクション数（またはカスタム属性関連のボリューム）を計算する期間。月数（1 ～ 24 か月）を選択します。	1 か月

API プロダクトにカスタム属性を定義した場合は、カスタム評価パラメータを構成して、カスタム属性に基づいてトランザクションカウンタを定義できます。

たとえば、次のことを行う必要があります。

API 呼び出しのメッセージで指定された値に基づいて、デベロッパーに変動額を請求します。
たとえば、API リクエストで送信されたバイト数に基づいてアプリデベロッパーに料金を請求することができます。
複数の API 呼び出しを 1 つのトランザクションにバンドルします。
この場合は、[カスタム評価パラメータを使用する] を選択し、プルダウンリストからカスタム属性を選択します。

詳細については、カスタム属性を使用して料金プランを構成するをご覧ください。

Classic Edge（プライベートクラウド）

Classic Edge UI を使用して調整可能な通知プランを構成するには:

[料金プランタイプ] で [調整可能な通知] を選択します。フィールドをクリックします。
UI を使用した料金プランの作成をご覧ください。をご覧ください。

注: [料金] タブと [フリーミアム] タブは、 [調整可能な通知タイプ] を選択します。調整可能な通知タイプには適用できません。通知を受け取ることができます。
[Renewal Term] フィールドに、プランを適用する月数を設定します。は自動更新されます（デベロッパーがその日付より前に契約を解除した場合を除く）。条件この値を 0 に設定した場合、プランはデベロッパーが終了を選択するまで有効です。
[汎用料金プラン] で [詳細] をクリックします。
[Aggregation Basis] をトランザクションが集計されます1 ～ 24 か月の間で選択してください。この値はデフォルトで 1 になります。あります。
[Apply and Close] をクリックします。
[下書きを保存] をクリックします。
プランを公開するのは、最終的なプランであると確信できる場合のみです。詳しくは、料金プランを公開するをご覧ください。公開日の設定とプランの公開に関する情報を確認できます

料金プランを公開した後、変更できるのは終了日のみです。料金は削除できません公開後にプランを作成できますが、料金プランを期限切れにして将来の料金に差し替えることができます。詳しくは、公開されているレートを期限切れにする計画。

API を使用した調整可能な通知プランの構成

ratePlanDetails プロパティで調整可能な通知プランの詳細を指定する POST リクエストのリクエスト本文に /organizations/{org_name}/monetization-packages/{package_id}/rate-plans。

調整可能な通知プランを指定するには、リクエスト本文の ratePlanDetails:

プロパティ	値
`type`	`USAGE_TARGET` に設定します。
`meteringType`	`DEV_SPECIFIC` に設定します。
`duration`	次の期間とともに、集計の基準となる期間を設定します。 `durationType`。調整可能な通知料金プランの場合は、整数に設定します 1 ～ 24 の範囲で設定できます
`durationType`	次の期間とともに、集計の基準となる期間を設定します。 `durationType`。調整可能な通知料金プランの場合は、この値を設定します `MONTH` に送信します。

リソースを指定するときに設定できる構成プロパティについては、調整可能な通知プランの詳細については、料金プランの詳細をご覧ください。構成設定をご覧ください。

たとえば、次の例では、集約ベースで調整可能な通知プランを定義しています。 1 か月に設定されています。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

目標値の設定 API を使用するアプリデベロッパーごとのトランザクション数

調整可能な通知料金プランに同意したアプリデベロッパーごとに、以下を行う必要があります。トランザクションのターゲット数を設定します通知を送信するかどうかとそのタイミングを構成できます目標の数値のパーセンテージ（90%、100%、150% など）に到達した時点に基づいて決定されます。ターゲット数に達した後、それ以降の取引はブロックされません。

アプリデベロッパーが取引を承認した場合、そのデベロッパーのトランザクションのターゲット数を設定できます。値は後で更新できます。

料金プランを受け入れるときにトランザクションのターゲット数を設定する

料金プランを受け入れるときに、トランザクションのターゲット数を設定するには、 POST リクエストのリクエスト本文の quotaTarget プロパティを /organizations/{org_name}/developers/{developer_id}/developer-rateplans リソース。 quotaTarget を正の整数に設定するか、アプリの通知を無効にするには 0 を設定します開発者です。指定しない場合、quotaTarget はデフォルトで 0 になります。

たとえば、次のリクエストでは、トランザクションの目標数を 4, 000 に設定しています。デベロッパーが調整可能な通知プランに同意した場合。

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

承諾済みの料金プランを更新するときに、トランザクションのターゲット数を設定する

トランザクションのターゲット数を設定するには、受け入れた料金プランを更新し、 POST リクエストのリクエスト本文の quotaTarget プロパティを /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} リソースです。quotaTarget を正の整数に設定します。無効にするには 0 をいくつか用意されています指定しない場合、quotaTarget はデフォルトで 0 になります。

リクエストを承認すると、レスポンスで {developer_rateplan_id} が返されます。公開料金プランです

例:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

または、デベロッパーレートの {developer-rateplan-id} を取得することもできます。 GET リクエストを /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, ここで、{developer_id} はデベロッパーのメールアドレスです。詳しくは詳しくは、承認されているすべての料金プランを必要ありません。

例:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}

次のリクエストでは、トランザクションのターゲット数を 4,000 に更新します。

$ curl -H "Content-Type:application/json"-X PUT -d \
{ 
   &quot;id&quot;: "b1c600b8-f871-496d-8173-12b9950d6ab1",
   &quot;developer&quot;:{
     "id":"dev@mycompany.com"
   },
   &quot;ratePlan&quot;:{
     &quot;id&quot;:&quot;p1_adjustable-notification-plan&quot;
   },
   "startDate": "2016-04-15 00:00:00",

   "quotaTarget": 4000,
   "suppressWarning":false
}分です。\
&quot;https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1&quot;
-u email:password