إعداد خطة الأسعار باستخدام سمات مخصّصة

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

مقدمة

في بعض الحالات، قد تحتاج إلى عدّادات معاملات مستندة إلى متغير أو قيمة مخصّصة. على سبيل المثال، قد تحتاج إلى ما يلي:

• تحصيل مبلغ متغيّر من المطوّرين استنادًا إلى قيمة مقدَّمة في رسالة طلب بيانات من واجهة برمجة التطبيقات على سبيل المثال، يمكنك تحصيل رسوم من مطوّري التطبيقات استنادًا إلى عدد وحدات البايت المنقولة في طلب واجهة برمجة التطبيقات.
• تجميع طلبات بيانات متعددة من واجهة برمجة التطبيقات في معاملة واحدة

باستخدام خطط الأسعار ذات السمات المخصّصة، يمكنك تحديد قيمة في رسالة طلب بيانات من واجهة برمجة التطبيقات تؤدي كقيمة عكسية وتُستخدم لاحتساب عدد المعاملات والرسوم.

تتوفّر خطط الأسعار التالية ذات السمات المخصّصة:

• بطاقة السعر مع سمة مخصّصة
• إشعار قابل للتعديل مع سمة مخصّصة

يمكنك ضبط عشر سمات مخصّصة بحدٍ أقصى لكل خطة سعر.

فهم العمليات الحسابية للسمات المخصّصة

تعتمد كيفية احتساب قيمة السمة المخصّصة في عدد معاملات خطة الأسعار والرسوم على نموذج تحصيل الرسوم، كما هو موضّح في الجدول التالي.

نموذج الشحن	احتساب السمات المخصّصة
السعر الثابت ونطاق الحجم	custom attribute number * rate = charge to developer بالنسبة إلى السعر الثابت، يصبح رقم السمة المخصّصة عدد المعاملات التي يتم ضربها في السعر. بالنسبة إلى "نطاق الحجم"، تتم زيادة عدد المعاملات في النطاق برقم السمة المخصّصة، ويتم تحصيل رسوم من المطوّر مقابل هذا العدد من المعاملات. على سبيل المثال، إذا كانت قيمة السمة المخصّصة في الرسالة هي 10، يتم تحصيل 10 معاملات من المطوّر، وتتم إضافة 10 معاملات إلى عدد النطاقات الحالي. إذا كان لدى المطوّر 6 معاملات فقط متبقية في النطاق الحالي، يتم ضرب 6 في سعر ذلك النطاق. تنتقل الأرقام الأربعة المتبقية إلى النطاق التالي ويتم ضربها في معدّل ذلك النطاق. في خطة "نطاق الحجم"، إذا كان هناك حدّ أقصى لنطاق الحجم الأخير (ليس "غير محدود") وتجاوزت المعاملة هذا الحدّ، سيحدث أمران: ويحصل المطور على المبلغ "الذي يزيد عن" مجانًا. يُحظر على تطبيق المطوّر إجراء المزيد من الطلبات إلى واجهة برمجة التطبيقات حتى تتم إعادة ضبط فترة الخطة. يمكنك الاطّلاع على القسم متى يتم تحصيل الرسوم المتكرّرة وإعادة ضبط خطط الحزمة؟ للحصول على تفاصيل حول موعد إعادة ضبط الخطط.
Bundles	بما أنّه يتم تحصيل رسوم الحِزم من قِبل المجموعة وليس من خلال المعاملة، يتم إجراء العملية الحسابية التالية: custom attribute number = amount added to bundle count على سبيل المثال، إذا كان رقم السمة المخصّصة في الرسالة هو 10، تتم إضافة 10 إلى عدد المعاملات المستخدَمة في الحزمة. إذا لم يتبق سوى 6 معاملات في الحزمة الحالية لمطوّر البرامج، ستتم تعبئة تلك الحزمة وسيزيد عدد الحِزم التالية بمقدار 4 معاملات. يتم تحصيل السعر مقابل الحزمة التالية، إن توفّرت. إذا كان الحدّ الأقصى المسموح به للحزمة الأخيرة (ليس "غير محدود") وتجاوزت المعاملة هذا الحدّ، سيحدث أمران: ويحصل المطور على المبلغ "الذي يزيد عن" مجانًا. يُحظر على تطبيق المطوّر إجراء المزيد من الطلبات إلى واجهة برمجة التطبيقات حتى تتم إعادة ضبط فترة الخطة. يمكنك الاطّلاع على القسم متى يتم تحصيل الرسوم المتكرّرة وإعادة ضبط خطط الحزمة؟ للحصول على تفاصيل حول موعد إعادة ضبط الخطط.
إشعارات قابلة للتعديل	بالنسبة إلى الإشعار القابل للتعديل، تحدث العملية الحسابية التالية: custom attribute number = amount added to transaction count على سبيل المثال، إذا كان رقم السمة المخصّصة في الرسالة هو 10، تتم إضافة 10 إلى إجمالي عدد المعاملات.

الحالات التي تحصل فيها خطة السعر على قيمة السمة المخصّصة

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

يمكنك بعد ذلك اختيار تلك السمة المخصّصة في خطة السعر، وذلك بعد إنشاء حزمة منتجات لواجهة برمجة التطبيقات تتضمّن سياسة تسجيل المعاملات مع تحديد السمة المخصّصة.

فيما يلي التدفق عالي المستوى:

1. حدِّد السمات المخصّصة عند إضافة منتج واجهة برمجة التطبيقات.
2. أنشِئ حزمة منتجات واجهة برمجة التطبيقات التي تحتوي على المنتج.
   في سياسة تسجيل المعاملات لحزمة منتجات واجهة برمجة التطبيقات، أضِف السمات المخصّصة التي سيتم استخدامها لتحديد خطط الأسعار.
3. أنشِئ خطة أسعار من نوع بطاقة السعر أو إشعارًا قابلاً للتعديل لحزمة منتجات واجهة برمجة التطبيقات وحدِّد مَعلمة تقييم مخصّصة.

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

كيفية إنشاء قيمة السمة المخصّصة في الرسالة

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

إضافة حجم حمولة الطلب إلى عنوان الاستجابة

في كل طلب رسالة، يتضمّن كل طلب رسالة متغيّر client.received.content.length يحتوي على عدد وحدات البايت في حمولة الطلب. من خلال إرفاق سياسة "تخصيص الرسالة" باستجابة نقطة نهاية الخادم الوكيل، يمكننا إنشاء عنوان استجابة يُسمى 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 في كل تطبيق مطوّر، على النحو التالي:

عند استخدام سياسة التحقّق من مفتاح واجهة برمجة التطبيقات (المطلوبة لتحقيق الربح)، يتم تخزين هذه القيمة في متغيّر يُسمى verifyapikey.{policy_name}.apprating. باستخدام سياسة "تحديد الرسائل" المرتبطة باستجابة نقطة نهاية الخادم الوكيل، يمكنك إنشاء عنوان يُسمى 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>

إعداد خطة الأسعار

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

ضبط خطة بطاقة السعر بسمة مخصّصة باستخدام واجهة المستخدم

يمكنك ضبط خطط بطاقة السعر بسمات مخصّصة باستخدام واجهة مستخدم Edge أو واجهة مستخدم Edge الكلاسيكية، كما هو موضَّح في الأقسام التالية.

ضبط خطة إشعارات قابلة للتعديل بسمات مخصّصة باستخدام واجهة المستخدم

يمكنك ضبط خطط الإشعارات القابلة للتعديل باستخدام سمات مخصّصة، كما هو موضّح أدناه.

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

نفِّذ الخطوات الأساسية التالية:

1. في سياسة تسجيل المعاملات لأحد منتجات واجهة برمجة التطبيقات، أضِف السمات المخصّصة التي سيتم استخدامها لتحديد خطط الأسعار. للحصول على التفاصيل، اطّلِع على مقدّمة حول هذا الموضوع بالإضافة إلى إنشاء سياسة لتسجيل المعاملات. يمكنك إجراء ذلك لكل منتج من منتجات واجهة برمجة التطبيقات تريد تضمينه في حزمة واجهة برمجة التطبيقات.
2. بعد ضبط منتجات واجهة برمجة التطبيقات وسياسات تسجيل المعاملات بالطريقة التي تريدها، أنشِئ حزمة واجهة برمجة تطبيقات تتضمّن المنتج. يُرجى الاطّلاع على مقالة إنشاء حِزم واجهة برمجة التطبيقات.

بعد ذلك، يمكنك استخدام واجهة برمجة التطبيقات لوضع خطة السعر.

يمكنك تحديد تفاصيل خطة أسعار باستخدام سمات مخصّصة عند إنشاء خطة الأسعار. يمكنك تحديد التفاصيل في السمة ratePlanDetails ضمن نص الطلب عند الطلب /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. في التفاصيل، يمكنك تحديد قيمة مَعلمة تقييم تحدّد اسم السمة المخصّصة. ويمكنك أيضًا تحديد قيمة مَعلمة تقييم تُجمِّع السمة المخصّصة خلال فترة زمنية محدّدة.

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

على سبيل المثال، ينشئ ما يلي "بطاقة سعر" مع خطة سمات مخصّصة استنادًا إلى سمة مخصّصة باسم 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