ضبط خطة الإشعارات القابلة للتعديل

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

مقدمة

في خطة الإشعارات القابلة للتعديل، يمكن لموفّر واجهة برمجة التطبيقات تعديل العدد المستهدَف من المعاملات لكل مطوّر تطبيقات. يمكنك ضبط ما إذا كان سيتم إرسال الإشعارات ووقت إرسالها استنادًا إلى وقت بلوغ نسبة مئوية من العدد المستهدَف، مثل %90 أو %100 أو %150. ولا يتم حظر المعاملات الإضافية بعد الوصول إلى الرقم المستهدف.

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

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

Edge

لضبط خطة إشعارات قابلة للتعديل باستخدام واجهة مستخدم Edge، عند إضافة أو تعديل خطة تعرفة، اختَر نوع خطة تعرفة الإشعار القابل للتعديل، وفي قسم الإشعار القابل للتعديل، اضبط المعلومات التالية:

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

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

على سبيل المثال، قد تحتاج إلى:

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

لمزيد من المعلومات، يُرجى الاطّلاع على ضبط خطة الأسعار باستخدام السمات المخصّصة.

Classic Edge (سحابة خاصة)

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

  1. اختَر إشعار قابل للتعديل في حقل نوع خطة الأسعار ضِمن علامة التبويب "تفاصيل الخطة" في نافذة "خطة الأسعار".

    اطّلِع على مقالة إنشاء خطة تعرفات باستخدام واجهة المستخدم للحصول على معلومات عن الوصول إلى نافذة "خطة الأسعار".

  2. اضبط حقل مدة التجديد على عدد الأشهر التي يتم خلالها تجديد الخطة تلقائيًا (ما لم يُنهِ المطوّر الاتفاقية قبل ذلك التاريخ). إذا ضبطت هذه القيمة على 0، تظل الخطة سارية إلى أن يختار المطوّر إنهاءها.
  3. انقر على التفاصيل ضمن "خطة الأسعار العامة".
  4. اضبط أساس التجميع على الفترة الزمنية التي يتم خلالها تجميع حجم المعاملات. اختَر رقمًا بين 1 و24 شهرًا. يتم ضبط هذه القيمة تلقائيًا على شهر واحد.
  5. انقر على تطبيق وإغلاق.
  6. انقر على حفظ كمسودة.
  7. لا تنشر الخطة إلا عندما تكون متأكدًا تمامًا من أنها نهائية. اطّلِع على خطط الأسعار للنشر للحصول على معلومات عن تحديد "تاريخ النشر" ونشر الخطة.

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

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

حدِّد تفاصيل خطة الإشعار القابلة للتعديل في السمة ratePlanDetails ضمن نص الطلب في طلب POST إلى /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

لتحديد خطة إشعارات قابلة للتعديل، حدِّد القيم التالية في ملف ratePlanDetails من نص الطلب:

الموقع القيمة
type اضبط النوع على USAGE_TARGET.
meteringType اضبط النوع على DEV_SPECIFIC.
duration يتم ضبطها على الفترة الزمنية لقاعدة التجميع، بالإضافة إلى durationType. بالنسبة إلى خطط معدّل الإشعارات القابلة للتعديل، اضبط هذا الخيار على قيمة عددية تتراوح بين 1 و24.
durationType

يتم ضبط القيمة على الفترة الزمنية لأساس التجميع، مع durationType. بالنسبة إلى خطط أسعار الإشعارات القابلة للتعديل، اضبط هذه القيمة على MONTH.

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

على سبيل المثال، يحدِّد ما يلي خطة إشعارات قابلة للتعديل مع أساس تجميع تم ضبطه على شهر واحد.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "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": "VOLUME",
           "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

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

بالنسبة إلى كل مطوّر تطبيقات وافق على خطة معدّل الإشعارات القابل للتعديل، عليك ضبط العدد المستهدَف من المعاملات. يمكنك ضبط ما إذا كان سيتم إرسال الإشعارات ووقت إرسالها استنادًا إلى وقت بلوغ نسبة مئوية من العدد المستهدَف، مثل %90 أو %100 أو %150. ولا يتم حظر المعاملات الإضافية بعد بلوغ العدد المستهدَف.

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

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

عند قبول خطة الأسعار، لضبط العدد المستهدَف من المعاملات، حدِّد سمة quotaTarget في نص الطلب في طلب POST إلى مورد /organizations/{org_name}/developers/{developer_id}/developer-rateplans. اضبط quotaTarget على عدد صحيح موجب أو 0 لإيقاف الإشعارات لمطوّر التطبيق. إذا لم يتم تحديد قيمة، يتم ضبط قيمة quotaTarget تلقائيًا على 0.

على سبيل المثال، يضبط الطلب التالي العدد المستهدَف من المعاملات على 4000 عندما يقبل مطوّر التطبيق خطة التنبيهات القابلة للتعديل.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

ضبط العدد المستهدَف للمعاملات عند تعديل خطة الأسعار المقبولة

لضبط العدد المستهدَف من المعاملات، يمكنك تعديل خطة الأسعار المقبولة وتحديد سمة quotaTarget في نص الطلب في طلب PUT إلى موارد /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. اضبط quotaTarget على عدد صحيح موجب أو 0 لإيقاف الإشعارات لمطوّر التطبيق. إذا لم يتم تحديد قيمة، تكون القيمة التلقائية لسمة quotaTarget هي 0.

يتم عرض الرمز {developer_rateplan_id} في الردّ عند قبول خطة الأسعار المُعلَن عنها.

على سبيل المثال:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

بدلاً من ذلك، يمكنك الحصول على {developer-rateplan-id} لخطة تعرفة المطوّر من خلال إرسال طلب GET إلى /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans، حيث يكون {developer_id} هو عنوان البريد الإلكتروني للمطوّر. لمزيد من المعلومات، اطّلِع على مقالة عرض جميع خطط الأسعار المقبولة لدى المطوّر.

على سبيل المثال:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

يعدّل الطلب التالي العدد المستهدَف من المعاملات إلى 4,000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password