กําหนดค่าแผนการแจ้งเตือนที่ปรับได้

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X info

บทนำ

ในแพ็กเกจการแจ้งเตือนที่ปรับได้ ผู้ให้บริการ API สามารถปรับจำนวนธุรกรรมเป้าหมายสำหรับ นักพัฒนาแอปแต่ละรายได้ คุณสามารถกำหนดค่าได้ว่าจะให้ส่งการแจ้งเตือนเมื่อใด โดยอิงตามเวลาที่เปอร์เซ็นต์ของจำนวนเป้าหมายถึง เช่น 90%, 100% หรือ 150% ระบบจะไม่บล็อกธุรกรรมเพิ่มเติม หลังจากถึงจำนวนเป้าหมายแล้ว

การกำหนดค่าแพ็กเกจการแจ้งเตือนที่ปรับได้โดยใช้ UI

กำหนดค่าแพ็กเกจการแจ้งเตือนที่ปรับได้ตามที่อธิบายไว้ด้านล่าง

การกำหนดค่าแพ็กเกจการแจ้งเตือนที่ปรับได้โดยใช้ 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 โดยค่าเริ่มต้น

ตัวอย่างเช่น คำขอต่อไปนี้จะตั้งค่าจำนวนธุรกรรมเป้าหมายเป็น 4, 000 รายการเมื่อนักพัฒนาแอป ยอมรับแพ็กเกจการแจ้งเตือนที่ปรับได้

$ 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