إعداد خطة حصة الأرباح

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

مقدمة

في خطة حصة الأرباح، يشارك مزوّد واجهة برمجة التطبيقات مع المطوّر نسبة مئوية من الأرباح الناتجة عن كل معاملة (استنادًا إلى السعر الإجمالي أو الصافي للمعاملة). عند إنشاء خطة لحصة الأرباح، عليك الإشارة إلى نموذج مشاركة يمكن أن يكون ثابتًا أو مرنًا، وأساس تسعير (مثل ما إذا كانت حصة الأرباح مستندة إلى السعر الإجمالي للمعاملة أو صافيها). ويمكنك تحديد السعر الإجمالي أو الصافي للمعاملة عند إنشاء سياسة تسجيل المعاملات.

في نموذج المشاركة الثابتة، يمكنك مشاركة نسبة ثابتة من الأرباح المحقَّقة من كل معاملة مع المطوّر (استنادًا إلى السعر الإجمالي أو الصافي للمعاملة). في نموذج المشاركة المرن، يمكنك مشاركة نسبة مئوية متغيرة من الأرباح مع المطوّر. وتعتمد حصة الأرباح على الأرباح التي تم تحقيقها خلال فترة زمنية. ويمكن أن تختلف النسبة المئوية المستخدَمة في احتساب حصة الأرباح استنادًا إلى مبلغ الأرباح المحقَّقة من المعاملات.

تحديد تفاصيل خطة مشاركة الأرباح باستخدام واجهة المستخدم

اضبط خطط مشاركة الأرباح، كما هو موضّح أدناه.

تحديد تفاصيل خطة مشاركة الأرباح باستخدام واجهة برمجة التطبيقات

عليك تحديد تفاصيل خطة مشاركة الأرباح عند إنشاء خطة الأسعار. يجب تحديد التفاصيل في السمة ratePlanDetails ضمن نص الطلب عند الاستدعاء إلى /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. ويعتمد ما تحدّده في السمة ratePlanDetails على نموذج المشاركة الذي تختاره: ثابت أم مرن.

تحديد تفاصيل خطة مشاركة الأرباح لنموذج مشاركة ثابت

لتطبيق نموذج المشاركة الثابتة، عليك تحديد ما يلي في تفاصيل خطة الأسعار:

• مَعلَمة تقييم تشير إلى أنّ خطة الأسعار تستند إلى المعاملات (VOLUME)، وهي القيمة التلقائية VOLUME.
• يشير ذلك إلى نوع من قياس حصة القراءة المجانية (UNIT) يشير إلى أنّ حصة الأرباح ثابتة لكل وحدة (أي أنّها لا تستند إلى حجم المعاملات، كما هو الحال مع نموذج المشاركة المرنة).
• نوع الأرباح (GROSS أو NET)، ويشير إلى ما إذا كانت حصة الأرباح مستندة إلى السعر الإجمالي أو الصافي للمعاملة.
• فترة استحقاق الدفع (على سبيل المثال، 30 يومًا).
• رقم تعريف مؤسستك.
• "الأساسية" أو العملة المحاسبية التي تستخدمها شركتك.
• معدّل خطة الأسعار الذي يوفّر تفاصيل حول كيفية احتساب حصة الأرباح. بما أنّ نموذج المشاركة يستند إلى سعر ثابت، يمكنك تحديد سعر خطة سعر واحد فقط.

يمكنك الاطّلاع على خصائص الإعدادات لتفاصيل خطة الأسعار للحصول على قائمة كاملة بخصائص تفاصيل خطة الأسعار.

في سعر خطة الأسعار، يمكنك تحديد ما يلي:

• نوع سعر خطة الأسعار (REVSHARE)
• النسبة المئوية المستخدمة لاحتساب حصة الأرباح. على سبيل المثال، إذا حدّدت 80.5555، تكون حصة الأرباح 80.5555%، أي أنّك، بصفتك مقدّم واجهة برمجة التطبيقات، تدفع لمطوّر البرامج 80.5555% من السعر المحصَّل عن كل معاملة (أو إذا كنت بناءً على سمة مخصَّصة مثل عدد وحدات البايت المنقولة في إحدى المعاملات، ستدفع للمطوّر 80.5555% من السعر المحدّد مقابل نقل وحدات البايت).
• وحدة البداية لتطبيق السعر (0). هذا يعني أنه سيتم تطبيق السعر على كل معاملة، بدءًا من المعاملة الأولى.

اطّلِع على خصائص الإعدادات لخطط الأسعار للحصول على قائمة كاملة بخصائص خطط الأسعار.

على سبيل المثال، ينشئ ما يلي خطة لمشاركة الأرباح مع نموذج مشاركة ثابت. تبلغ النسبة المئوية لحصة الأرباح 80.5555%. تعتمد حصة الأرباح على السعر الصافي للمعاملة. يسري هذا العقد اعتبارًا من 15 أيلول (سبتمبر) 2013، وسيكون تاريخ استحقاق الدفع مستحقًا بعد 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"
}

تحديد تفاصيل خطة مشاركة الأرباح لنموذج مشاركة مرن

في نموذج المشاركة المرن، يمكنك تحديد تفاصيل خطة الأسعار التي تتضمّن سعر خطة أسعار واحدًا أو أكثر. يغطي كل سعر لخطة الأسعار نطاقًا من أرباح المعاملات (يُسمّى كل نطاق "نطاق الأرباح"). يمكنك تحديد نسبة مئوية من حصة الأرباح لكل نطاق أرباح.

بالإضافة إلى أسعار خطة الأسعار، يمكنك تحديد ما يلي في تفاصيل خطة الأسعار:

• مَعلَمة تقييم تشير إلى أنّ خطة الأسعار تستند إلى المعاملات (VOLUME)، وهي القيمة التلقائية VOLUME.
• نوع قياس حصة الأرباح (VOLUME) يشير إلى أنّ حصة الأرباح لا تستند إلى حجم المعاملات (أي أنّها غير ثابتة، كما هو الحال مع نموذج المشاركة الثابتة).
• نوع الأرباح (GROSS أو NET)، ويشير إلى ما إذا كانت حصة الأرباح مستندة إلى السعر الإجمالي أو الصافي للمعاملة.
• فترة استحقاق الدفع (على سبيل المثال، 30 يومًا).
• رقم تعريف مؤسستك.
• "الأساسية" أو العملة المحاسبية التي تستخدمها شركتك.
• يشير ذلك المصطلح إلى نوع المدة والمدة اللذين يتم خلالهما تحديد الفترة الزمنية التي يتم تجميع الأرباح خلالها (يُسمى ذلك أيضًا "أساس التجميع"). ويتم تجميع المعاملات على أساس التجميع (على سبيل المثال، شهر واحد) لاحتساب إجمالي الأرباح ونطاق الأرباح الساري. وتعتمد النسبة المئوية لحصة الأرباح المطبَّقة على كل معاملة على نطاق أرباحها.
• عدّادات تجميع البيانات المستخدَمة لتحديد نطاق الأرباح الساري

يمكنك الاطّلاع على خصائص الإعدادات لتفاصيل خطة الأسعار للحصول على قائمة كاملة بخصائص تفاصيل خطة الأسعار.

لكل سعر خطة أسعار، يمكنك تحديد:

• نوع سعر خطة الأسعار لنطاق الأرباح (REVSHARE)
• النسبة المئوية المستخدَمة لاحتساب حصة الأرباح في نطاق الأرباح على سبيل المثال، إذا حددت القيمة 80.5555، تكون حصة الأرباح في نطاق الأرباح 80.5555%، أي، بصفتك مقدّم واجهة برمجة تطبيقات، ستدفع للمطوّر% 80.5555 من السعر المحصَّل عن كل معاملة في نطاق الأرباح هذا.
• وحدة البداية والنهاية لنطاق الأرباح. تحدد وحدة البداية الحدّ الأدنى لنطاق الأرباح، بينما تحدد وحدة النهاية الحدّ الأقصى لنطاق الأرباح. على سبيل المثال، إذا حددت وحدة بداية على 0 ووحدة نهاية قدرها 1000، سيغطي نطاق الأرباح أرباح المعاملات التي تزيد عن 0 وما يصل إلى 1000 بالعملة المحدّدة. إذا كانت العملة هي الدولار الأمريكي، ويكون أساس التجميع هو شهر واحد، وكانت النسبة المئوية لنطاق الأرباح هي 80.5555%، ثم بالنسبة إلى المعاملات التي تحقق أرباحًا تصل إلى 1,000 دولار أمريكي في الشهر، تكون حصة الأرباح 80.5555% من سعر المعاملة.

  إذا لم تحدّد وحدة نهاية لنطاق الأرباح النهائية، يتم تطبيق النسبة المئوية للحصة على كل المعاملات بعد أن تتجاوز الأرباح المجمّعة وحدة البداية لذلك النطاق. على سبيل المثال، إذا كانت وحدة البداية للنطاق الأخير هي 1,000 (افترض أن بالدولار الأمريكي)، ولم تحدد وحدة نهاية لهذا النطاق، سيتم تطبيق النسبة المئوية لأرباح النطاق على جميع المعاملات التي تزيد قيمتها عن 1, 000 دولار أمريكي من الأرباح خلال الفترة المجمّعة.

اطّلِع على خصائص الإعدادات لخطط الأسعار للحصول على قائمة كاملة بخصائص خطط الأسعار.

على سبيل المثال، ينشئ ما يلي خطة لمشاركة الأرباح مع نموذج مشاركة مرن. ويحدّد نطاقَين من الأرباح. يغطي النطاق الأول أرباح المعاملات التي تزيد قيمتها عن ما يصل إلى 1,000 دولار أمريكي. أما النطاق الثاني، فيغطي إيرادات المعاملات التي تزيد عن 1000 دولار أمريكي. تبلغ نسبة حصة الأرباح 80.5555% لنطاق الأرباح الأول و90.5% لنطاق الأرباح الثاني. تستند حصة الأرباح إلى السعر الصافي للمعاملة. ويكون أساس التجميع هو شهر واحد. تسري فترة العقد في 15 أيلول (سبتمبر) 2013، وسيكون تاريخ استحقاق الدفع مستحقًا بعد 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"
}