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

収益分配プランを構成する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。情報

はじめに

収益分配プランでは、API プロバイダが各トランザクションから発生した収益の一部（トランザクションの総額または正味価格に基づく）をデベロッパーに分配します。収益分配プランを作成する場合は、共有モデル（固定または柔軟）と料金ベース（収益分配が取引の総額または純額に基づくかどうかなど）を指定する必要があります。取引の総額または正味額は、取引記録ポリシーを作成するときに設定します。

固定分配モデルでは、各取引から発生した収益の一定の割合を（取引の総額または純額に基づいて）デベロッパーと分配します。柔軟な分配モデルでは、収益の一定の割合をデベロッパーと共有します。収益分配率は、一定期間に発生した収益によって異なります。収益分配の計算に使用される割合は、取引によって得られた収益額によって異なります。

UI を使用して収益分配プランの詳細を指定する

以下の手順に沿って、収益分配プランを構成します。

Edge

Edge UI を使用して収益分配プランを構成するには、料金プランを作成または編集するときに、[収益分配] または [レート表と収益分配] 料金プランタイプを選択し、[収益分配] セクションで次の情報を構成します。

フィールド	説明
計算モデル	次のいずれかの料金タイプを選択します。総額 - 収益分配は、トランザクションの総額の割合に基づいています。純額 - トランザクションの正味価格の割合に基づく収益分配率注: トランザクションの総額または正味額は、トランザクションの記録ポリシーを作成するときに設定します。
計算頻度	トランザクション数（またはカスタム属性関連のボリューム）を計算する期間。月数（1 ～ 24 か月）を選択します。
モデルの共有	次の収益分配モデルのいずれかを選択します。固定 - API プロバイダは、各トランザクションから発生した収益の一定の割合を（トランザクションの総額または純額に基づいて）デベロッパーと分配します。柔軟 - API プロバイダは、収益の一定割合をデベロッパーと共有します。収益分配率は、一定期間に発生した収益によって決まります。収益分配の計算に使用される割合は、取引によって得られた収益額によって異なる場合があります。
固定収益分配	固定分配モデルの場合、収益分配の計算に使用する割合を指定します。小数値を入力します（小数点以下は 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 プロダクトが 1 つだけ含まれている場合は、この手順をスキップできます。
- プロダクト固有のプラン: API プロダクトごとに料金プランの詳細を個別に構成します。
- Generic Plan for All Products: すべての API プロダクトの料金プランの詳細を構成します。
汎用料金プランまたは API プロダクト固有の料金プランごとに [収益分配] をクリックします。
注: API プロダクト固有のプランを構成する場合は、API プロダクトごとに収益分配プランを個別に構成する必要があります。

[収益分配] ウィンドウが開きます。

次のいずれかの共有モデルを選択します。

固定: このモデルでは、API プロバイダは、各トランザクションから発生した収益の一定の割合を（トランザクションの総額または正味額に基づいて）デベロッパーと分配します。
フレキシブル: このモデルでは、API プロバイダがデベロッパーと収益の一部を共有します。収益分配率は、一定期間に発生した収益によって異なります。収益分配の計算に使用される割合は、取引によって得られる収益額によって異なる場合があります。

固定分配モデルの場合:

固定分配モデルを選択した場合は、[一般的な収益分配] ウィンドウの [料金] セクションに次の情報を入力します。

フィールド	説明
オペレーター（または組織）	組織の名前。このフィールドは、組織プロファイルのオペレーター（または組織）フィールドの値を使用してプリセットされています。
国	組織の事業拠点がある国。このフィールドは、組織プロファイルの国フィールドの値を使用して事前設定されます。
通貨	会社が使用する「基本」または会計通貨。このフィールドは、組織プロファイルの [通貨] フィールドの値を使用して事前設定されます。
料金タイプ	収益分配の基礎。[総額] または [正味額] を選択します。[総額] を選択すると、収益分配は取引の総額の割合に基づいて行われます。[正味] を選択した場合、収益分配は取引の正味価格の割合に基づきます。注: トランザクション記録ポリシーを作成するときに、トランザクションの合計価格または正味価格を設定します。
固定分配率	収益分配率の計算に使用される割合。10 進数を入力します（小数点以下は 4 桁まで）。たとえば、80.5555 と入力すると、収益分配率は 80.5555% になります。つまり、API プロバイダは、各トランザクションで請求された料金の 80.5555% をデベロッパーに支払います。

フレキシブルな共有モデルの場合:

柔軟な共有モデルを選択すると、[一般的な収益分配] ウィンドウに追加のフィールドが表示されます。これらのフィールドは、集計の基準を指定したり、「収益帯」を指定したりするために使用します。収益帯とは、異なる収益分配率を適用できるトランザクションによる収益の範囲です。

[一般的な収益分配率] ウィンドウで次の情報を入力します。

フィールド	説明
集計ベース	収益を集計する期間。集計された収益は、各取引の収益帯（および該当する収益分配率）の計算に使用されます。月数（1 ～ 12）を選択します。
収益帯取引収益の 1 つ以上の範囲（各範囲は「収益帯」です）。各収益帯には収益分配率を割り当てることができます（この割合は [料金] セクションの [収益帯] フィールドで設定します）。トランザクションは集計ベースで集計され、トランザクションの合計収益と収益帯が計算されます。各取引に適用される収益分配率は、収益バンドによって異なります。最初のバンドの上限を指定します（最大 1,000 など）。下限は 0 より大きい値にプリセットされています。2 つ目のバンドを追加するには、[+] をクリックします（1, 000 より大きく 2,000 までなど）。[+] をクリックしてバンドを追加します。最後のバンドの上限を空白のままにすると、合計収益がこのレベルを超えた後のすべてのトランザクションを示すことができます。
料金
オペレーター（または組織）	組織の名前。このフィールドは、組織プロファイルのオペレーター（または組織）フィールドの値を使用してプリセットされています。
国	組織の事業拠点がある国。このフィールドは、組織プロファイルの国フィールドの値を使用して事前設定されます。
通貨	組織で使用している「基本」または会計通貨。このフィールドは、組織プロファイルの [通貨] フィールドの値を使用してプリセットされています。
料金タイプ	収益分配の基準。[総額] または [純額] を選択します。[総額] を選択した場合、収益分配はトランザクションの総価格の割合に基づきます。純額を選択した場合、収益分配はトランザクションの正味価格の割合に基づきます。注: トランザクション記録ポリシーを作成するときに、トランザクションの合計価格または正味価格を設定します。
収益バンドの割合（%）	各収益分配帯でのトランザクションの収益分配率の計算に使用される割合。各バンドの割合を指定します。小数点以下 4 桁までの小数を入力します。たとえば、[収益帯] セクションで 2 つの収益帯（0 ～ 1, 000 超、1, 000 超）を指定する場合は、0 ～ 1,000 超の収益帯に 80.5555、1, 000 超の収益帯に 90.5 と入力します。また、通貨は米ドルとします。収益が $1,000 までの取引では、収益分配は取引価格の 80.5555% で、収益が $1,000 を超える取引では、収益分配は取引価格の 90.5% です。

[適用して閉じる] をクリックして収益分配の詳細を保存し、[標準料金プラン] ウィンドウに戻ります。
API プロダクト固有の料金プランの場合は、必要に応じて追加の API プロダクトの料金プランの詳細を構成します。

API を使用して収益分配プランの詳細を指定する

収益分配プランの詳細は、料金プランを作成するときに指定します。詳細は、/organizations/{org_name}/monetization-packages/{package_id}/rate-plans の呼び出しでリクエスト本文内の ratePlanDetails プロパティに指定します。ratePlanDetails プロパティで指定する内容は、選択した共有モデル（固定または柔軟）によって異なります。

固定分配モデルの収益分配プランの詳細を指定する

固定の共有モデルを実装するには、料金プランの詳細で次のように指定します。

料金プランがトランザクション（VOLUME）に基づいていることを示す評価パラメータ。デフォルトは VOLUME です。
収益分配がユニットごとに固定されていることを示すメータータイプ（UNIT）。つまり、柔軟な共有モデルの場合とは異なり、取引量に基づくものではありません。
収益タイプ（GROSS または NET）。収益分配率が取引の総額または正味額に基づくかどうかを示します。
トランザクション記録ポリシーを作成するときに、トランザクションの総額または正味価格を設定します。
お支払い期日（30 日間など）。
組織の ID。
会社で使用している「基本」または会計通貨。
収益分配の計算方法の詳細を示す料金プランのレート。共有モデルは固定料金に基づいているため、料金プランの料金は 1 つだけ指定します。

料金プランの詳細プロパティの一覧については、料金プランの詳細の構成プロパティをご覧ください。

料金プランの料金で、次の項目を指定します。

料金プランの料金のタイプ（REVSHARE）。
収益分配の計算に使用される割合。たとえば、80.5555 を指定した場合、収益分配は 80.5555% になります。つまり、API プロバイダはトランザクションごとに請求される料金の 80.5555% をデベロッパーに支払います（または、トランザクションで送信されたバイト数などのカスタム属性に基づく場合は、課金される送信バイト数の 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 か月など）で集計され、総収益と該当する収益帯域が計算されます。各取引に適用される収益分配率は、収益バンドによって異なります。
適用される収益帯を決定するために使用される集計カウンタ。