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

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

مقدمه

در یک طرح اعلان قابل تنظیم، ارائه‌دهنده API می‌تواند تعداد مورد نظر تراکنش‌ها را برای هر برنامه‌نویس برنامه تنظیم کند. می‌توانید تعیین کنید که آیا و چه زمانی اعلان‌ها بر اساس زمانی که به درصدی از عدد هدف رسیده‌اند، مانند 90، 100، یا 150 درصد، ارسال شوند. تراکنش های اضافی پس از رسیدن به شماره هدف مسدود نمی شوند.

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

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

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

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

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

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

به عنوان مثال، موارد زیر یک برنامه اعلان قابل تنظیم را با مبنای تجمیع تعیین شده برای 1 ماه تعریف می کند.

$ 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 است.

به عنوان مثال، زمانی که توسعه‌دهنده برنامه طرح اعلان قابل تنظیم را بپذیرد، درخواست زیر تعداد تراکنش‌های مورد نظر را روی 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
}

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

درخواست زیر تعداد تراکنش های مورد نظر را به 4000 به روز می کند.

$ 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