<ph type="x-smartling-placeholder"></ph>
現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細
はじめに
収益分配プランでは、API プロバイダがデベロッパーと収益の一定の割合を 各トランザクションから得られた収益（トランザクションの総額または正味価格に基づく）。日時 収益分配プランを作成するには、収益分配モデルを指定します。モデルは固定することも、 価格基準（たとえば、総収益と純収益のどちらに基づくか） 。トランザクション記録ポリシーを作成するときに、トランザクションの総額または正味価格を設定します。
固定共有モデルでは、収益の一定割合をデベロッパーに分配します。 トランザクションの総額または正味価格に基づいて、各トランザクションから生成されます。 柔軟な共有モデルにより、一定の割合で収益をデベロッパーに分配します。「 収益分配率は、一定期間に発生した収益によって決まります。Pod の 収益分配の計算は、トランザクションによって生成された収益額によって異なる場合があります。
以下を使用して、収益分配プランの詳細を UI
以下の手順に沿って、収益分配プランを設定します。
Edge
作成または編集時に Edge UI を使用して収益分配プランを構成する 料金プランを選択する場合は、料金プランのタイプとして [収益分配] または [レート表と収益分配] を選択し、[収益分配] セクションで次の情報を構成します。
| フィールド | 説明 |
| 計算モデル | 次のいずれかの料金タイプを選択します。
|
| 計算頻度 | トランザクション数（またはカスタム属性関連のボリューム）を計算する期間。月数（1 ～ 24 か月）を選択します。 |
| モデルの共有 | 次のいずれかの収益分配モデルを選択します。
|
| 固定収益分配 | 固定共有モデルの場合、収益分配の計算に使用する割合を指定します。10 進数を入力してください（小数点以下は 4 桁まで）。たとえば、「80.5555」と入力すると、収益分配は 80.5555% になります。つまり、API プロバイダは、トランザクションごとに請求される金額の 80.5555% をデベロッパーに支払います。 |
| 収益分配帯 | フレキシブル共有モデルの場合、1 つ以上のトランザクション収益の範囲（それぞれの範囲を「収益分配帯」と呼びます）。各収益分配率には収益分配率を割り当てることができます。トランザクションは集計データで集計され、トランザクションの合計収益と収益分配帯が計算されます。各トランザクションに適用される収益分配率は、収益分配帯によって異なります。 最初の帯域の上限を指定します（たとえば、「1,000」まで）。下限は 0 より大きい値に設定されています。バンドを追加するには、[+ 新規] をクリックします。最後のバンドの上限を空白のままにして、総収益がこのレベルを超えた後のすべてのトランザクションを指定します。 たとえば、[収益範囲] セクションで 2 つの収益帯（0 ～ 1, 000 超と 1, 000 以上）を指定した場合、0 ～ 1,000 を超える収益帯には 80.5555、1, 000 以上の収益帯には 90.5 と入力します。また、通貨は米ドルであると想定します。この場合、収益が 1,000 ドル以下の取引の場合、収益分配は取引価格の 80.5555% になり、1,000 ドルを超える取引の場合は取引価格の 90.5% になります。 |
Classic Edge（プライベート クラウド）
Classic Edge UI を使用して収益分配プランを構成するには:
- 料金プランの作成の手順に沿って操作します。
- [料金プランのタイプ] プルダウンで [収益分配] を選択して、収益モデルを構成します。
- 選択した API パッケージに複数の API プロダクトが含まれている場合は、次のいずれかのオプションを選択します。
注: API パッケージに単一の API プロダクトが含まれている場合は、この手順をスキップできます。
- プロダクト固有のプラン: 各 API プロダクトの料金プランの詳細を構成します。
- Generic Plan for All Products: すべての API プロダクトの料金プランの詳細を構成します。
- 汎用料金プランまたは各 API プロダクト固有の料金プランの [収益分配] をクリックします。
注: API プロダクト固有のプランを構成する場合は、収益分配プランを構成する必要があります。 API プロダクトごとに個別に設定できます。
[収益分配] ウィンドウが開きます。
- 次のいずれかの共有モデルを選択します。
<ph type="x-smartling-placeholder">
- </ph>
- Fixed（固定）: このモデルでは、API プロバイダがデベロッパーに一定割合の 各トランザクションから得られた収益（ あります。
- 柔軟性: このモデルでは、API プロバイダがデベロッパーと変数を共有します。 収益の一部になります収益分配率は一定の期間で得られた収益で決まる できます。収益分配率の計算で使用される割合は、 トランザクションによって発生した収益の割合です。
固定共有モデルの場合:
固定共有モデルを選択した場合は、[Pricing] に次の情報を入力します。 セクションに表示されます。
フィールド 説明 オペレーター（または組織） 組織の名前。このフィールドは、演算子（または Organization）フィールド値。
国 組織の活動を行っている国。このフィールドは 組織プロファイルの国フィールドの値。
通貨 「ベース」またはお支払いに使用する通貨です。このフィールドはプリセットされています 組織プロファイルの [通貨] フィールドの値を使用します。
料金タイプ 収益分配の基礎。[総額] または [純額] を選択します。[総額]を選択すると 収益分配は、トランザクションの総価格の割合に基づきます。もし [純額] を選択すると、 あります。注: トランザクション記録ポリシーを作成するときに、トランザクションの合計価格または正味価格を設定します。
固定シェア（%） 収益分配率の計算に使用される割合。10 進数（ （小数点以下 4 桁まで）。たとえば、「80.5555」と入力すると、収益分配率は 80.5555% です。つまり、API プロバイダは、デベロッパーに価格の 80.5555% を支払います。 トランザクションごとに課金されます
柔軟な共有モデルの場合:
柔軟な共有モデルを選択すると、[一般的な収益分配率] ウィンドウが表示されます。 追加のフィールドが表示されます。これらのフィールドを使用して集計の基準を指定し、 「収益帯」、つまり、トランザクションによって生成される収益の範囲を指定します。 さまざまな収益分配率を適用できます。
[一般的な収益分配率] ウィンドウで次の情報を入力します。
フィールド 説明 集計ベース 収益を集計する期間。総収益は 各トランザクションの収益帯（および該当する収益）の計算に使用 割合など）が含まれます。月数（1 ～ 12）を選択します。
収益帯 1 つ以上のトランザクション収益の範囲（それぞれの範囲を「収益帯」といいます）。各 収益分配率を割り当てることができます（この割合は [料金] セクションの [収益帯] フィールドで確認できます）。トランザクションは すべての収益グループについて、総収益と あります。各取引に適用される収益分配率は、取引の 選択します
最初の帯域の上限を指定します（例: 1,000（下限） 0 より大きい値に事前に設定されています）。2 つ目のバンドを追加するには、[+] をクリックします。たとえば、 上限は 1,000 ～ 2,000 です。さらにバンドを追加するには、[+] をクリックします。上限は 集計後のすべてのトランザクションを示す空の最後の帯域の上限 収益がこのレベルを上回っています
料金 オペレーター（または組織） 組織の名前。このフィールドは、演算子（または Organization）フィールド値。
国 組織の活動を行っている国。このフィールドは 組織プロファイルの国フィールドの値。
通貨 「ベース」お支払い通貨を選択できます。このフィールドは 組織プロファイルの [通貨] フィールド値を使用してプリセット値を設定します。
料金タイプ 収益分配の基礎。[総額] または [純額] を選択します。[総額]を選択すると 収益分配は、トランザクションの総価格の割合に基づきます。もし [純額] を選択すると、 あります。注: トランザクション記録ポリシーを作成するときに、トランザクションの合計価格または正味価格を設定します。
収益帯の分配率（%） 各トランザクションの収益分配率の計算に使用される割合 選択します各バンドの割合を指定します。10 進数（ 小数点第 4 位まで）。たとえば、[収益] タブで 2 つの収益範囲を指定した場合、 帯域セクション（>0-1000、1000 以上）には、80.5555 を 0 ～ 1,000 を超える収益帯、1,000 以上の収益帯では 90.5。また、 通貨は米ドルです。次に、最大 1,000 ドルが生成されるトランザクションについて、 収益では、収益分配は取引価格の 80.5555%、 収益が 1, 000 ドルを超える取引の場合、収益の 90.5% は 表示されます。
- [適用して閉じる] をクリックして収益分配の詳細を保存し、標準レートに戻ります。 [Plan] ウィンドウ。
- API プロダクト固有の料金プランの場合は、必要に応じて、追加の API プロダクトの料金プランの詳細を構成します。
API を使用して収益分配プランの詳細を指定する
収益分配プランの詳細は、料金プランの作成時に指定します。ユーザーが詳細を指定
に対する呼び出しのリクエスト本文内の ratePlanDetails プロパティに
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans。お客様が
ratePlanDetails プロパティで指定します。これは、選択した共有モデルによって異なります。
固定またはフレキシブルです。
固定共有モデルの収益分配プランの詳細の指定
固定共有モデルを実装するには、料金プランの詳細で次の項目を指定します。
- 料金プランがトランザクションに基づいていることを示す評価パラメータ
（
VOLUME）。デフォルトはVOLUMEです。 - ユニットごとに収益分配が固定されることを示すメータリング タイプ（
UNIT） （つまり、フレキシブル モデルのケースとは異なり、トランザクションの量に基づいたものではなく、 共有モデルなど）。 - 収益タイプ（
GROSSまたはNET）。これは 収益分配は、取引の総額または正味価格に基づきます。 - お支払い期限（例: 30 日）。
- 組織の ID。
- 「ベース」またはお支払いに使用する通貨です。
- 収益分配の計算方法の詳細を示す料金プランのレート。なぜなら、 共有モデルが固定レートに基づく場合、料金プランは 1 つだけ指定します。
料金プランの詳細プロパティの一覧については、料金プランの詳細の構成プロパティをご覧ください。
料金プランのレートには、次の項目を指定します。
- 料金プランのレートのタイプ（
REVSHARE）。 - 収益分配率の計算に使用される割合。たとえば、80.5555 を指定した場合、 収益分配率は 80.5555% です。つまり、API プロバイダはデベロッパーに 80.5555% を支払います。 トランザクションごとに請求される価格（またはトランザクションの件数などのカスタム属性に基づいている場合） 1 回のトランザクションで送信されたバイト数の 80.5555% を開発者に支払います。 （指定されたバイト数を送信すること）がこれに該当します。
- 料金の適用の開始単位（
0）。これはレートが （最初のトランザクションから各トランザクションに適用されます）
料金プランのプロパティの完全なリストについては、料金プランの構成プロパティをご覧ください。
次の例では、固定共有モデルを使用した収益分配プランを作成しています。「 80.5555%と指定します収益分配率は商品の正味価格に基づきます あります。契約は 2013 年 9 月 15 日から有効で、支払い期限は 30 日以内です。（ 収益分配率に関する詳細はハイライト表示されます）。
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Fixed share plan",
"developer":null,
"developerCategory":null,
"advance": false,
"currency": {
"id": "usd"
},
"description": "Fixed share plan",
"displayName": "Fixed share plan",
"earlyTerminationFee": 10,
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": false,
"published": true,
"ratePlanDetails": [
{
"aggregateStandardCounters": true,
"currency": {
"id": "usd"
},
"duration": 1,
"durationType": "MONTH",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates": [
{
"revshare": 80.8555,
"startUnit": 0,
"type": "REVSHARE"
}
],
"ratingParameter": "VOLUME",
"revenueType": "NET",
"type": "REVSHARE"
}
],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"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
レスポンスは次のようになります（レスポンスの一部のみが表示されています）。
{ "advance" : false, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "description" : "Fixed share plan", "displayName" : "Fixed share plan", "earlyTerminationFee" : 10, "id" : "location_fixed_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Fixed share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "01c4d544-d907-423b-964e-4e2aed2816a3", "revshare" : 80.8555, "startUnit" : 0, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }
柔軟な共有モデルの収益分配プランの詳細の指定
フレキシブル共有モデルでは、1 つ以上の料金プランを含む料金プランの詳細を指定します。 料金。各料金プランのレートには、ある範囲のトランザクション収益が含まれます（それぞれの範囲は「収益」と呼ばれます） 。各収益分配率を割り当てます。
料金プランの料金に加えて、料金プランの詳細には次の項目を指定します。
- 料金プランがトランザクションに基づいていることを示す評価パラメータ
（
VOLUME）。デフォルトはVOLUMEです。 - 収益分配の基準がないことを示すメータリング タイプ（
VOLUME） （つまり、固定共有の場合のように固定ではなく、 モデル）。 - 収益タイプ（
GROSSまたはNET）。これは 収益分配は、取引の総額または正味価格に基づきます。 - お支払い期限（例: 30 日）。
- 組織の ID。
- 「ベース」またはお支払いに使用する通貨です。
- 収益の期間を指定する期間と期間タイプ （「集計ベース」とも呼ばれます）。トランザクションは （たとえば 1 か月）を使用して、総収益と該当する 選択します各トランザクションに適用される収益分配率は、収益によって異なります 。
- 該当する収益帯域の決定に使用される集計カウンタ。
料金プランの詳細プロパティの一覧については、料金プランの詳細の構成プロパティをご覧ください。
料金プランごとに、次の項目を指定します。
- 収益帯（
REVSHARE）の料金プランのレートのタイプ。 - 収益分配率の収益分配率の計算に使用される割合。たとえば 80.5555 を指定すると、収益分配帯の収益分配率は 80.5555%、つまり API になります。 その取引で請求された料金の 80.5555% をデベロッパーに支払います。 選択します
- 収益帯の開始単位と終了単位。開始単位では、
収益帯域の上限を指定します。終了単位は収益帯域の上限を指定します。対象
たとえば、開始単位を 0、終了単位を 1,000 に指定した場合、
は、指定された通貨で 0 より大きく 1,000 までのトランザクション収益に対応します。もし
通貨が米ドル、集計基準が 1 か月、収益のパーセンテージが
80.5555% の場合、1 か月の収益が最大 $1,000 であるトランザクションの場合、
収益分配率は取引価格の 80.5555% とします。
最終的な収益範囲の終了ユニットを指定しない場合、 そのバンドは、総収益が これを選択しますたとえば、最後のバンドの開始単位が 1,000 の場合 （米ドルを想定）で、そのバンドの終了単位、 期間中に収益が 1,000 ドルを超えるすべてのトランザクションに 集計期間です。
料金プランのプロパティの完全なリストについては、料金プランの構成プロパティをご覧ください。
次の例では、柔軟な共有モデルを使用した収益分配プランを作成しています。これは、 2 つの収益帯を指定しています。1 つ目のバンドは、1,000 を超えるトランザクション収益を対象としています。 米ドルです。2 つ目のバンドは、1,000 米ドルを超えるトランザクション収益を対象としています。収益 シェアの割合は、最初の収益分配帯が 80.5555%、2 つ目の収益分配帯が 90.5% です。 収益分配率は、取引の正味価格に基づきます。集計の基準は 1 か月です。 契約期間は 2013 年 9 月 15 日から有効で、お支払い期限は 30 日以内です。（ 共有に関する詳細はハイライト表示されます）。
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flexible share plan",
"developer":null,
"developerCategory":null,
"advance": "true",
"currency": {
"id": "usd"
},
"description": "Flexible share plan",
"displayName": "Flexible share plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id": "usd"
},
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates" : [ {
"endUnit" : 1000,
"revshare" : 80.5555,
"startUnit" : 0,
"type" : "REVSHARE"
}, {
"revshare" : 90.5,
"startUnit" : 1000,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"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
レスポンスは次のようになります（レスポンスの一部のみが表示されています）。
{ "advance" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, ... }, "description" : "Flexible share plan", "displayName" : "Flexible share plan", "earlyTerminationFee" : 10, "frequencyDuration" : 30, "frequencyDurationType" : "DAY", "id" : "location_flexible_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Flexible share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : false, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", … "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c", "meteringType" : "VOLUME", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "endUnit" : 1000, "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40", "revshare" : 80.5555, "startUnit" : 0, "type" : "REVSHARE" }, { "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed", "revshare" : 90.5, "startUnit" : 1000, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringFee" : 10, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }