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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

はじめに

収益分配プランでは、API プロバイダは各取引で得られた収益の一定の割合を、取引の総額または正味価格に基づいてデベロッパーと分配します。収益分配プランを作成する際は、分配モデル(固定とフレキシブルのいずれでも可)と、価格ベース(収益分配がトランザクションの総価格と純額のどちらに基づいているかなど)を指定する必要があります。取引の総額または正味価格は、取引記録ポリシーを作成するときに設定します。

固定共有モデルでは、各取引で得られた収益の一定の割合を(取引の総額または正味価格に基づいて)デベロッパーと分配します。フレキシブルな共有モデルでは、収益の一定の割合をデベロッパーに分配します。収益分配率は、一定期間に得られた収益によって異なります。収益分配率の計算に使用される割合は、トランザクションによって発生した収益額に応じて異なります。

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

以下で説明するように、収益分配プランを構成します。

エッジ

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

フィールド 説明
計算モデル 次のいずれかの料金タイプを選択します。
  • 総額 - 収益分配率はトランザクションの総価格の割合に基づきます。
  • 純額 - 収益の分配は取引の正味価格の割合に基づいて算出されます
: 取引の総額または正味価格は、取引記録ポリシーを作成するときに設定します。
計算頻度 トランザクション量(またはカスタム属性関連のボリューム)を計算する期間。月数(1 ~ 24 か月)を選択します。
共有モデル 次のいずれかの収益分配モデルを選択します。
  • 固定 - API プロバイダは、各取引で得られた収益の一定の割合を(取引の総価格または正味価格に基づいて)デベロッパーと共有します。
  • フレキシブル - API プロバイダは収益の一定の割合をデベロッパーと分配します。収益分配率は、一定期間に得られた収益に依存します。収益分配率の計算に使用される割合は、トランザクションで獲得した収益額に応じて変わる可能性があります。
固定の収益分配率 固定共有モデルの場合、収益分配の計算に使用する割合を指定します。小数(小数第 4 位まで)を入力してください。たとえば、「80.5555」と入力した場合、収益分配率は 80.5555% になります。つまり、API プロバイダは、各トランザクションの料金の 80.5555% をデベロッパーに支払います。
収益分配帯

フレキシブル共有モデルの場合、1 つ以上の範囲のトランザクション収益(各範囲が「収益帯」)。各収益帯には収益分配の割合を割り当てることができます。トランザクションは集計ベースで集計され、トランザクションの合計収益と収益帯を計算します。各トランザクションに適用される収益分配率は、収益帯によって異なります。

最初の帯域の上限を指定します(例: 最大 1000)。下限は 0 より大きい値にあらかじめ設定されています。バンドを追加するには [+New] をクリックします。最終的な帯域の上限は、合計収益がこのレベルを超えた後のすべての取引を示すには、空白のままにします。

たとえば、[収益帯] セクションで 2 つの収益帯(>0 ~ 1, 000 と 1, 000 以上)を指定した場合、> 0 ~ 1,000 の収益帯に 80.5555、1, 000 以上の収益帯に 90.5 と入力します。また、通貨は米ドルであるものとします。収益が 1,000 ドルまでの取引の場合、収益分配率は取引価格の 80.5555% です。収益が 1,000 ドルを超える取引の場合、収益分配率は取引価格の 90.5% です。

従来の Edge(Private Cloud)

Classic Edge UI を使用して収益分配プランを構成するには:

  1. 手順に沿って料金プランを作成します。
  2. [料金プランタイプ] プルダウンで [収益分配] を選択し、収益モデルを設定します。
  3. 選択した API パッケージに複数の API プロダクトが含まれている場合は、次のいずれかのオプションを選択します。

    : API パッケージに 1 つの API プロダクトが含まれている場合は、この手順を省略できます。

    • プロダクト固有のプラン: API プロダクトごとに料金プランの詳細を個別に構成します。
    • すべてのプロダクトの汎用プラン: すべての API プロダクトの料金プランの詳細を設定します。
  4. 汎用の料金プランまたは各 API プロダクト固有の料金プランで、[収益分配] をクリックします。

    : API プロダクト固有のプランを構成する場合は、API プロダクトごとに収益分配プランを構成する必要があります。

    [収益受け取り] ウィンドウが開きます。

  5. 次のいずれかの共有モデルを選択します。
    • 固定: このモデルでは、API プロバイダは各取引で得られた収益の一定の割合を(取引の総額または正味価格に基づいて)デベロッパーと共有します。
    • 柔軟性: このモデルでは、API プロバイダは収益の変動的な割合をデベロッパーと分配します。収益分配率は、一定期間に得られた収益によって異なります。収益分配率の計算に使用される割合は、トランザクションによって発生した収益額によって異なる場合があります。

    固定共有モデルの場合:

    固定共有モデルを選択した場合は、[Generic Revenue Share] ウィンドウの [料金] セクションに次の情報を入力します。

    項目 説明
    運営者(または組織)

    組織の名前。このフィールドは、組織プロファイルの演算子(または組織)フィールドの値を使用してプリセットされています。

    組織の事業を運営している国。このフィールドは、組織プロファイルの [国] フィールドの値を使用してプリセットされています。

    通貨

    会社で使用する「基本」または会計通貨。このフィールドは、組織プロファイルの [通貨] フィールドの値を使用してプリセットされています。

    料金タイプ

    収益分配の基本。[総額] または [純額] を選択します。[総額] を選択した場合、収益分配率はトランザクションの総額に対する割合に基づきます。純額を選択した場合、収益分配率はトランザクションの正味価格に対する割合に基づきます。: 取引の総額または正味価格は、取引記録ポリシーを作成するときに設定します。

    固定シェア(%)

    収益分配率の計算に使用される割合。小数(小数第 4 位まで)を入力してください。たとえば、「80.5555」と入力した場合、収益分配率は 80.5555% になります。つまり、API プロバイダは、各取引で請求される料金の 80.5555% をデベロッパーに支払います。

    柔軟な共有モデルの場合:

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

    [Generic Revenue Share] ウィンドウに次の情報を入力します。

    項目 説明
    集計ベース

    収益を集計する期間。集計された収益は、各トランザクションの収益帯(および該当する収益分配率)の計算に使用されます。月数(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% です。

  6. [Apply and Close] をクリックして収益分配の詳細を保存し、標準料金プランのウィンドウに戻ります。
  7. 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 か月など)で集計され、合計収益と該当する収益帯を計算します。各トランザクションに適用される収益分配率は、収益帯によって異なります。
  • 該当する収益帯の決定に使用される集計カウンタ。

料金プランの詳細のプロパティの一覧については、料金プランの詳細に関する設定プロパティをご覧ください。

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

  • 収益帯の料金プランのタイプ(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,000 米ドルを超えるトランザクション収益をカバーします。2 つ目のバンドは 1,000 米ドルを超えるトランザクション収益をカバーしています。収益分配率は、1 つ目の収益帯が 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"
}