برنامه اعلان قابل تنظیم را پیکربندی کنید

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

مقدمه

در یک طرح اعلان قابل تنظیم، ارائه‌دهنده API می‌تواند تعداد تراکنش‌های هدف را برای هر توسعه‌دهنده برنامه تنظیم کند. می‌توانید پیکربندی کنید که آیا و چه زمانی اعلان‌ها بر اساس زمانی که درصدی از تعداد هدف، مانند ۹۰٪، ۱۰۰٪ یا ۱۵۰٪، حاصل شده است، ارسال شوند. تراکنش‌های اضافی پس از رسیدن به تعداد هدف مسدود نمی‌شوند.

پیکربندی یک طرح اعلان قابل تنظیم با استفاده از رابط کاربری

طرح‌های اعلان قابل تنظیم را مطابق توضیحات زیر پیکربندی کنید.

پیکربندی یک طرح اعلان قابل تنظیم با استفاده از API

جزئیات طرح اعلان قابل تنظیم را در ویژگی ratePlanDetails در بدنه درخواست، در یک درخواست POST به /organizations/{org_name}/monetization-packages/{package_id}/rate-plans مشخص کنید.

برای تعیین یک طرح اعلان قابل تنظیم، مقادیر زیر را در ratePlanDetails بدنه درخواست مشخص کنید:

برای اطلاعات بیشتر در مورد ویژگی‌های پیکربندی که می‌توانند هنگام تعیین جزئیات قابل تنظیم طرح اعلان تنظیم شوند، به تنظیمات پیکربندی جزئیات طرح نرخ مراجعه کنید.

برای مثال، در ادامه یک طرح اعلان قابل تنظیم با مبنای تجمیع ۱ ماهه تعریف شده است.

$ 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

تعیین تعداد تراکنش‌های هدف برای هر توسعه‌دهنده برنامه با استفاده از API

شما می‌توانید تعداد تراکنش‌های هدف را برای یک توسعه‌دهنده اپلیکیشن، زمانی که برنامه نرخ را می‌پذیرد، تعیین کنید و بعداً می‌توانید این مقدار را به‌روزرسانی کنید.

تعیین تعداد تراکنش‌های هدف هنگام پذیرش طرح نرخ

هنگام پذیرش طرح نرخ، برای تعیین تعداد هدف تراکنش‌ها، ویژگی quotaTarget را در بدنه درخواست در یک درخواست POST به منبع /organizations/{org_name}/developers/{developer_id}/developer-rateplans مشخص کنید. quotaTarget را روی یک عدد صحیح مثبت یا 0 تنظیم کنید تا اعلان‌ها برای توسعه‌دهنده برنامه غیرفعال شود. در صورت عدم تعیین، quotaTarget به طور پیش‌فرض روی 0 تنظیم می‌شود.

برای مثال، درخواست زیر تعداد تراکنش‌های هدف را زمانی که توسعه‌دهنده‌ی برنامه طرح اعلان قابل تنظیم را می‌پذیرد، روی ۴۰۰۰ تنظیم می‌کند.

$ 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
}

روش دیگر این است که می‌توانید با ارسال یک درخواست GET به آدرس /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans ، {developer_id {developer-rateplan-id} مربوط به طرح نرخ توسعه‌دهنده را دریافت کنید، که در آن {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 
}
        

درخواست زیر تعداد تراکنش‌های هدف را به ۴۰۰۰ به‌روزرسانی می‌کند.

$ 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