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

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

บทนำ

ในแผนการแจ้งเตือนแบบปรับได้ ผู้ให้บริการ 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 
}
        

คำขอต่อไปนี้อัปเดตจำนวนธุรกรรมเป้าหมายเป็น 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":เท็จ
}" \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password