Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

カスタム属性を使用して料金プランを構成する

ここに表示されているのは Apigee Edge のドキュメントです。
Go to the Apigee X のドキュメントに移動します。 info

はじめに

場合によっては、トランザクションカウンタを変数またはカスタム値に基づいて設定する必要があります。たとえば、次のようなことが必要になる場合があります。

API 呼び出しのメッセージで指定された値に基づいて、デベロッパーに可変の金額を請求する。たとえば、API リクエストで送信されたバイト数に基づいて、アプリデベロッパーに課金できます。
複数の API 呼び出しを 1 つのトランザクションにバンドルする。

カスタム属性付きの料金プランを使用すると、API 呼び出しのメッセージでカウンタとして機能する値を特定し、トランザクション数と料金の計算に使用できます。

カスタム属性付きの次の料金プランがサポートされています。

カスタム属性付きの料金表
カスタム属性付きの調整可能な通知

料金プランごとに最大 10 個のカスタム属性を設定できます。

カスタム属性の計算について

カスタム属性の値が料金プランのトランザクション数と料金にどのように反映されるかは、次の表に示すように、課金モデルによって異なります。

課金モデルカスタム属性の計算

定額制とボリュームバンド

課金モデル	カスタム属性の計算
定額制とボリュームバンド	`custom attribute number * rate = charge to developer` 定額制の場合、カスタム属性の数値は、料金を乗算するトランザクション数になります。ボリュームバンドの場合、バンド内のトランザクション数はカスタム属性の数値だけ増加し、デベロッパーはそのトランザクション数に対して課金されます。たとえば、メッセージ内のカスタム属性の値が 10 の場合、デベロッパーには 10 トランザクション分の料金が請求され、現在のバンド数に 10 トランザクションが追加されます。デベロッパーの現在のバンドに残っているトランザクション数が 6 つしかない場合、6 にそのバンドの料金が掛けられます。残りの 4 つは次のバンドに移行し、そのバンドの料金が掛けられます。ボリュームバンドプランで、最後のボリュームバンドに上限があり（「無制限」ではない）、トランザクションがその上限を超えると、次の 2 つのことが起こります。デベロッパーは「超過」分を無料で利用できます。プラン期間がリセットされるまで、デベロッパーアプリは API の呼び出しをブロックされます。プランがリセットされるタイミングについては、定期的な料金が請求され、バンドルプランがリセットされるのはいつですか？をご覧ください。
バンドル	バンドルはトランザクションごとではなくグループごとに課金されるため、次の計算が行われます。 `custom attribute number = amount added to bundle count` たとえば、メッセージ内のカスタム属性の数値が 10 の場合、バンドルで使用されるトランザクション数に 10 が追加されます。デベロッパーの現在のバンドルに残っているトランザクション数が 6 つしかない場合、そのバンドルは上限に達し、次のバンドル数が 4 つ増加します。次のバンドルの料金が請求されます（ある場合）。最後のバンドルに上限があり（「無制限」ではない）、トランザクションがその上限を超えると、次の 2 つのことが起こります。デベロッパーは「超過」分を無料で利用できます。プラン期間がリセットされるまで、デベロッパーアプリは API の呼び出しをブロックされます。プランがリセットされるタイミングについては、定期的な料金が請求され、バンドルプランがリセットされるのはいつですか？をご覧ください。
調整可能な通知	調整可能な通知の場合、次の計算が行われます。 `custom attribute number = amount added to transaction count` たとえば、メッセージ内のカスタム属性の数値が 10 の場合、トランザクションの合計数に 10 が追加されます。

custom attribute number * rate = charge to developer

定額制の場合、カスタム属性の数値は、料金を乗算するトランザクション数になります。ボリュームバンドの場合、バンド内のトランザクション数はカスタム属性の数値だけ増加し、デベロッパーはそのトランザクション数に対して課金されます。たとえば、メッセージ内のカスタム属性の値が 10 の場合、デベロッパーには 10 トランザクション分の料金が請求され、現在のバンド数に 10 トランザクションが追加されます。デベロッパーの現在のバンドに残っているトランザクション数が 6 つしかない場合、6 にそのバンドの料金が掛けられます。残りの 4 つは次のバンドに移行し、そのバンドの料金が掛けられます。

ボリュームバンドプランで、最後のボリュームバンドに上限があり（「無制限」ではない）、トランザクションがその上限を超えると、次の 2 つのことが起こります。

デベロッパーは「超過」分を無料で利用できます。
プラン期間がリセットされるまで、デベロッパーアプリは API の呼び出しをブロックされます。
プランがリセットされるタイミングについては、定期的な料金が請求され、バンドルプランがリセットされるのはいつですか？をご覧ください。

バンドル

バンドルはトランザクションごとではなくグループごとに課金されるため、次の計算が行われます。

custom attribute number = amount added to bundle count

たとえば、メッセージ内のカスタム属性の数値が 10 の場合、バンドルで使用されるトランザクション数に 10 が追加されます。デベロッパーの現在のバンドルに残っているトランザクション数が 6 つしかない場合、そのバンドルは上限に達し、次のバンドル数が 4 つ増加します。次のバンドルの料金が請求されます（ある場合）。

最後のバンドルに上限があり（「無制限」ではない）、トランザクションがその上限を超えると、次の 2 つのことが起こります。

デベロッパーは「超過」分を無料で利用できます。
プラン期間がリセットされるまで、デベロッパーアプリは API の呼び出しをブロックされます。
プランがリセットされるタイミングについては、定期的な料金が請求され、バンドルプランがリセットされるのはいつですか？をご覧ください。

調整可能な通知

調整可能な通知の場合、次の計算が行われます。

custom attribute number = amount added to transaction count

たとえば、メッセージ内のカスタム属性の数値が 10 の場合、トランザクションの合計数に 10 が追加されます。

料金プランでカスタム属性の値を取得する場所

トランザクション記録ポリシー（API プロダクトバンドル）は、収益化に対して、メッセージ内のカスタム属性の属性値を探す場所を指示します。カスタム属性は、API プロダクトバンドルのトランザクション記録ポリシーの [Custom Attributes] セクションで定義します。

次に、カスタム属性が定義されたトランザクション記録ポリシーを含む API プロダクトバンドルを作成したら、料金プランでそのカスタム属性を選択できます。

フローの概要は次のとおりです。

API プロダクトを追加するときにカスタム属性を定義します。
プロダクトを含む API プロダクトバンドルを作成します。
API プロダクトバンドルのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。
料金プランを作成し、API プロダクトバンドルに料金表または調整可能な通知タイプを指定し、カスタム評価パラメータを指定します。

次の図は、トランザクション記録ポリシーで定義されたカスタム属性と料金表プランの構成の関係を示しています。カスタム属性付きの調整可能な通知の料金プランの関係も同様ですが、ボリュームの値は適用されません。

メッセージでカスタム属性値を生成する方法

トランザクション記録ポリシーでは、レスポンスヘッダー、レスポンス本文、レスポンス内の事前定義されたフロー変数など、いくつかの場所でカスタム属性の属性値を探すことができます。（リクエストは使用できません。トランザクションは、成功レスポンスを受け取るまで正式なものではないためです）。次の例では、数値を含むレスポンスヘッダー をメッセージに追加する方法を示します。どちらの場合も、変数と組み合わせて Assign Message ポリシーを使用します。

リクエストペイロードサイズをレスポンスヘッダーに追加する

各メッセージリクエストには、リクエストペイロードのバイト数を含む client.received.content.length 変数があります。Assign Message ポリシーを Proxy Endpoint レスポンスに接続することで、長さの値を含むmessageSize というレスポンスヘッダーを生成できます。

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

アプリのカスタム属性値をヘッダーに追加する

同様に、アプリのカスタム属性の値を含むヘッダーを生成できます。たとえば、次のように、各デベロッパーアプリにappratingというカスタム属性を含める場合を考えてみましょう。

Verify API Key ポリシー（収益化に必要）を使用すると、この値は verifyapikey.{policy_name}.apprating という変数に保存されます。Proxy Endpoint レスポンスに接続された Assign Message ポリシーを使用すると、アプリの apprating 値を含む apprating というヘッダーを生成できます。

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

料金プランを設定する

上記のカスタム属性の設定以外に、料金プランは通常と同じ方法で設定されます（カスタム属性のない料金プランの場合）。ただし、次の要件を満たす必要があります。

警告: カスタム属性付きの料金プランを設定するための要件:

メッセージ内のカスタム属性の値を次のように指定します。
- 正の整数または小数（小数点以下 4 桁まで）。負の値は使用できません。
- 文字列型。他のデータ型はサポートされていません。ヘッダー値は常に文字列ですが、フロー変数は文字列として指定する必要があります。
API パッケージを作成する前に、API プロダクトのトランザクション記録ポリシーでカスタム属性を指定します。（トランザクションポリシーのカスタム属性を指定する方法については、トランザクション記録ポリシーを作成するをご覧ください）。
プロダクトに少なくとも 1 つのリソースが定義されていることを確認します。**
API パッケージには 1 つ以上の API プロダクトを含めることができます。
カスタム属性名 VOLUME は予約されています。カスタム属性名として使用しないでください。

UI を使用してカスタム属性付きの料金表プランを構成する

次のセクションで説明するように、Edge UI または Classic Edge UI を使用して、カスタム属性付きの料金表プランを構成します。

エッジ

Edge UI を使用してカスタム属性付きの料金表プランを構成するには:

API プロダクトを追加するときにカスタム属性を定義します。
プロダクトを含む API プロダクトバンドルを作成します。API プロダクトバンドルを作成するをご覧ください。
API プロダクトバンドルのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。詳細については、このトピックの概要とトランザクション記録ポリシーを作成するをご覧ください。
API プロダクトバンドルに料金プランを作成し、 カスタム評価パラメータ を指定します。

詳細については、UI を使用して料金表プランの詳細を構成するをご覧ください。

Classic Edge（Private Cloud）

Classic Edge UI を使用してカスタム属性付きの料金表プランを作成する手順は次のとおりです。

API プロダクトのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。詳細については、このトピックの概要とトランザクション記録ポリシーを作成するをご覧ください。API パッケージに含める API プロダクトごとにこれを行います。
API プロダクトとトランザクション記録ポリシーを目的どおりに構成したら、プロダクトを含む API パッケージを作成します。API パッケージを作成するをご覧ください。
API パッケージの料金プランを作成し、料金プランのタイプとして [料金表カスタム属性付き] を選択します。
[料金表] リンクをクリックします。[料金表] ウィンドウが開きます。
[Custom Attribute] プルダウンメニューでカスタム属性を選択します。メニューには、トランザクション記録ポリシーでプロダクト用に作成されたカスタム属性が表示されます。デベロッパーには、各トランザクション内の選択したカスタム属性の値に基づいて課金されます。
（属性値 * 料金 = デベロッパーへの請求額）
必要に応じて、料金表プランの詳細を指定するの説明に沿って、フリーミアムプランを設定します。
料金表プランの詳細を指定するの説明に沿って、課金モデルを設定します。ただし、カスタム属性付きの料金表の料金プランタイプの場合、課金モデルは選択したカスタム属性に基づきます。たとえば、課金モデルとして定額制を選択した場合、デベロッパーには、トランザクションごとの固定料金ではなく、各トランザクションで送信されるバイト数などのカスタム属性に基づいて固定料金が請求されます。詳細については、計算をご覧ください。
[Save Draft] をクリックします。
プランが最終版であることが確実な場合にのみ、プランを公開してください。公開日を設定してプランを公開する方法については、料金プランを公開するをご覧ください。

詳細については、 UI を使用して料金表プランの詳細を指定するをご覧ください。

UI を使用してカスタム属性付きの調整可能な通知プランを構成する

カスタム属性付きの調整可能な通知プランを構成する方法は次のとおりです。

エッジ

Edge UI を使用してカスタム属性付きの料金表プランを構成するには:

API プロダクトを追加するときにカスタム属性を定義します。
プロダクトを含む API プロダクトバンドルを作成します。API プロダクトバンドルを作成するをご覧ください。
API プロダクトバンドルのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。詳細については、このトピックの概要とトランザクション記録ポリシーを作成するをご覧ください。
API プロダクトバンドルに料金プランを作成し、 カスタム評価パラメータ を指定します。

詳細については、UI を使用して調整可能な通知プランを構成するをご覧ください。

Classic Edge（Private Cloud）

Classic Edge UI を使用してカスタム属性付きの料金表プランを構成するには:

API プロダクトのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。詳細については、このトピックの概要とトランザクション記録ポリシーを作成するをご覧ください。API パッケージに含める API プロダクトごとにこれを行います。
API プロダクトとトランザクション記録ポリシーを目的どおりに構成したら、プロダクトを含む API パッケージを作成します。API パッケージを作成するをご覧ください。
API パッケージの料金プランを作成し、料金プランのタイプとして [Adjustable Notification with Custom Attribute] を選択します。
[詳細] リンクをクリックします。[調整可能な通知] ウィンドウが開きます。
[Custom Attribute] プルダウンメニューでカスタム属性を選択します。メニューには、トランザクション記録ポリシーでプロダクト用に作成されたカスタム属性が表示されます。デベロッパーのトランザクションの合計数は、各トランザクション内の選択したカスタム属性の値に基づいて計算されます。
[Aggregation Basis] を、トランザクションのボリュームが集計される期間に設定します。1 ～ 24 か月の数値を選択します。この値のデフォルトは 1 か月です。
[Apply and Close] をクリックします。
[Save Draft] をクリックします。
プランが最終版であることが確実な場合にのみ、プランを公開してください。公開日を設定してプランを公開する方法については、料金プランを公開するをご覧ください。

詳細については、 UI を使用して調整可能な通知プランの詳細を指定するをご覧ください。

API を使用してカスタム属性付きの料金プランの詳細を指定する

次の前提条件の手順を行います。

API プロダクトのトランザクション記録ポリシーで、料金プランの定義に使用するカスタム属性を追加します。詳細については、このトピックの概要とトランザクション記録ポリシーを作成するをご覧ください。API パッケージに含める API プロダクトごとにこれを行います。
API プロダクトとトランザクション記録ポリシーを目的どおりに構成したら、プロダクトを含む API パッケージを作成します。API パッケージを作成するをご覧ください。

次に、API を使用して料金プランを作成します。

料金プランを作成するときに、カスタム属性付きの料金プランの詳細を指定します。詳細は、/organizations/{org_name}/monetization-packages/{package_id}/rate-plans の呼び出しのリクエスト本文の ratePlanDetails プロパティで指定します。詳細では、カスタム属性の名前を識別する評価パラメータ値を指定します。指定した時間間隔でカスタム属性を集計する評価パラメータ値を指定することもできます。

料金プランの詳細オプションの完全なリストについては、料金プランの詳細構成設定をご覧ください。

たとえば、次の例では、messageSize という名前のカスタム属性に基づいて、カスタム属性付きの料金表プランを作成します（太字の項目を参照）。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

次の例では、 messageSizeという名前のカスタム属性に基づいて、カスタム属性付きの調整可能な通知の料金プランを作成します（太字の項目を参照）。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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

カスタム属性を使用して料金プランを構成する

はじめに

カスタム属性の計算について

料金プランで カスタム属性の値を取得する場所

メッセージでカスタム属性値を生成する方法

リクエスト ペイロード サイズをレスポンス ヘッダーに追加する

アプリのカスタム属性値をヘッダーに追加する

料金プランを設定する

UI を使用してカスタム属性付きの料金表プランを構成する

エッジ

Classic Edge（Private Cloud）

UI を使用してカスタム属性付きの調整可能な通知プランを構成する

エッジ

Classic Edge（Private Cloud）

API を使用してカスタム属性付きの料金プランの詳細を指定する

料金プランでカスタム属性の値を取得する場所

リクエストペイロードサイズをレスポンスヘッダーに追加する