پیکربندی طرح اعلان قابل‌تنظیم

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

مقدمه

در طرح اعلان قابل‌تنظیم، ارائه‌دهنده 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 را روی عدد صحیح مثبت یا ۰ تنظیم کنید. اگر مشخص نشده باشد، quotaTarget به‌طور پیش‌فرض روی ۰ تنظیم می‌شود.

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

$ 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 را روی عدد صحیح مثبت یا ۰ تنظیم کنید. اگر مشخص نشده باشد، quotaTarget به‌طور پیش‌فرض روی ۰ تنظیم می‌شود.

وقتی طرح نرخ منتشرشده را می‌پذیرید، {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-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