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

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

เกริ่นนำ

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

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

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

การกำหนดค่าแผนการแจ้งเตือนแบบปรับเปลี่ยนได้โดยใช้ API

ระบุรายละเอียดแผนการแจ้งเตือนแบบปรับได้ในพร็อพเพอร์ตี้ ratePlanDetails ในส่วนเนื้อหาของคำขอในคำขอ POST ที่จะส่งไปยัง /organizations/{org_name}/monetization-packages/{package_id}/rate-plans

หากต้องการระบุแผนการแจ้งเตือนแบบปรับได้ ให้ระบุค่าต่อไปนี้ใน RatePlanDetails ของเนื้อหาคำขอ

พร็อพเพอร์ตี้	ค่า
type	ตั้งค่าเป็น USAGE_TARGET
meteringType	ตั้งค่าเป็น DEV_SPECIFIC
duration	ตั้งค่าเป็นระยะเวลาที่ใช้เป็นเกณฑ์การรวม พร้อมกับ durationType สำหรับแพ็กเกจราคาการแจ้งเตือนแบบปรับได้ ให้ตั้งค่านี้เป็นค่าจำนวนเต็มระหว่าง 1 ถึง 24
durationType	ตั้งค่าเป็นระยะเวลาที่ใช้เป็นเกณฑ์การรวม พร้อมกับ durationType สำหรับแพ็กเกจอัตราการแจ้งเตือนแบบปรับได้ ให้ตั้งค่านี้เป็น MONTH

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

ตัวอย่างต่อไปนี้กำหนดแผนการแจ้งเตือนแบบปรับได้ที่มีการตั้งค่าเกณฑ์การรวมเป็น 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
}

หรือขอรับ {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"
 }email:password