กำหนดค่าแพ็กเกจราคาด้วยแอตทริบิวต์ที่กำหนดเอง

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

เกริ่นนำ

ในบางกรณี คุณอาจต้องตัวนับธุรกรรมตามตัวแปรหรือค่าที่กำหนดเอง ตัวอย่างเช่น คุณอาจต้องทำดังนี้

• เรียกเก็บเงินนักพัฒนาซอฟต์แวร์ตามจำนวนตัวแปรตามค่าที่ระบุในข้อความของการเรียก API ตัวอย่างเช่น คุณอาจต้องการเรียกเก็บเงินแก่นักพัฒนาแอปตามจำนวนไบต์ที่ส่งในคำขอ API
• จัดกลุ่มการเรียก API หลายรายการเป็นธุรกรรมเดียว

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

ระบบรองรับแพ็กเกจราคาที่มีแอตทริบิวต์ที่กําหนดเองต่อไปนี้

• บัตรราคาที่มีแอตทริบิวต์ที่กำหนดเอง
• การแจ้งเตือนแบบปรับได้ที่มีแอตทริบิวต์ที่กำหนดเอง

คุณตั้งค่าแอตทริบิวต์ที่กำหนดเองได้สูงสุด 10 รายการต่อแพ็กเกจราคา

การทำความเข้าใจการคำนวณแอตทริบิวต์ที่กำหนดเอง

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

รุ่นการชาร์จ	การคำนวณแอตทริบิวต์ที่กำหนดเอง
อัตราคงที่และแถบระดับเสียง	custom attribute number * rate = charge to developer สำหรับอัตราคงที่ หมายเลขแอตทริบิวต์ที่กำหนดเองจะกลายเป็นจำนวนธุรกรรมที่คูณกับอัตรา สำหรับ Volume Banded จำนวนธุรกรรมในแบนด์ จะเพิ่มขึ้นตามจำนวนแอตทริบิวต์ที่กำหนดเอง และนักพัฒนาซอฟต์แวร์จะถูกเรียกเก็บ จำนวนธุรกรรมดังกล่าว ตัวอย่างเช่น หากค่าแอตทริบิวต์ที่กำหนดเองในข้อความคือ 10 ระบบจะเรียกเก็บเงินนักพัฒนาแอปสำหรับธุรกรรม 10 รายการ และจะเพิ่มธุรกรรม 10 รายการลงในจำนวนย่านความถี่ปัจจุบัน หากนักพัฒนาแอปมีธุรกรรมเหลืออยู่เพียง 6 รายการในช่วงปัจจุบัน ระบบจะคูณ 6 ด้วยอัตราของช่วงดังกล่าว ส่วนอีก 4 สายที่เหลือจะเข้าสู่ช่วงความถี่ถัดไปและคูณด้วยอัตราของวงดนตรีนั้น ในแพ็กเกจย่านระดับเสียง หากช่วงระดับเสียงสุดท้ายมีขีดจำกัด (ไม่ใช่ "ไม่จำกัด") และธุรกรรมเกินขีดจํากัด 2 สิ่งต่อไปนี้จะเกิดขึ้น นักพัฒนาซอฟต์แวร์จะได้รับจำนวนเงินที่ "เกิน" ฟรี แอปนักพัฒนาแอปถูกบล็อกไม่ให้เรียกใช้ API อีกจนกว่าระยะเวลาของแพ็กเกจจะรีเซ็ต ดูรายละเอียดเกี่ยวกับเวลาที่ระบบรีเซ็ตแพ็กเกจได้ที่หัวข้อจะมีการเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจำและรีเซ็ตแพ็กเกจแพ็กเกจเมื่อใด
Bundles	เนื่องจากกลุ่มเป็นผู้เรียกเก็บเงินสำหรับการซื้อแพ็กเกจ ไม่ใช่โดยธุรกรรม จึงมีการคำนวณดังต่อไปนี้ custom attribute number = amount added to bundle count เช่น หากหมายเลขแอตทริบิวต์ที่กำหนดเองในข้อความคือ 10 ระบบก็จะเพิ่ม 10 ลงในจำนวนธุรกรรมที่ใช้ในแพ็กเกจ หากนักพัฒนาแอปมีธุรกรรมเหลืออยู่เพียง 6 รายการในแพ็กเกจปัจจุบัน แพ็กเกจดังกล่าวจะได้รับการตอบสนองและจำนวนแพ็กเกจถัดไปจะเพิ่มขึ้น 4 รายการ ระบบจะเรียกเก็บเงินสำหรับแพ็กเกจถัดไปดังกล่าว (หากมี) หากแพ็กเกจสุดท้ายมีขีดจำกัด (ไม่ใช่ "ไม่จำกัด") และธุรกรรมเกินขีดจํากัด 2 สิ่งต่อไปนี้จะเกิดขึ้น นักพัฒนาซอฟต์แวร์จะได้รับจำนวนเงินที่ "เกิน" ฟรี แอปนักพัฒนาแอปถูกบล็อกไม่ให้เรียกใช้ API อีกจนกว่าระยะเวลาของแพ็กเกจจะรีเซ็ต ดูรายละเอียดเกี่ยวกับเวลาที่ระบบรีเซ็ตแพ็กเกจได้ที่หัวข้อจะมีการเรียกเก็บค่าธรรมเนียมที่เกิดขึ้นประจำและรีเซ็ตแพ็กเกจแพ็กเกจเมื่อใด
การแจ้งเตือนแบบปรับได้	สำหรับการแจ้งเตือนแบบปรับได้ จะมีการคำนวณดังนี้ custom attribute number = amount added to transaction count เช่น หากหมายเลขแอตทริบิวต์ที่กำหนดเองในข้อความคือ 10 ระบบก็จะเพิ่ม 10 ลงในจำนวนธุรกรรมทั้งหมด

ที่ที่แพ็กเกจราคาได้รับค่าแอตทริบิวต์ที่กำหนดเอง

นโยบายการบันทึกธุรกรรม (ในแพ็กเกจผลิตภัณฑ์ API) จะบอกการสร้างรายได้ว่าต้องดูตำแหน่งใดในข้อความสำหรับค่าแอตทริบิวต์ที่กำหนดเอง คุณระบุแอตทริบิวต์ที่กำหนดเองได้ในส่วนแอตทริบิวต์ที่กำหนดเองของนโยบายการบันทึกธุรกรรมสำหรับแพ็กเกจผลิตภัณฑ์ API

จากนั้นคุณจะเลือกแอตทริบิวต์ที่กำหนดเองดังกล่าวในแพ็กเกจราคาได้หลังจากที่สร้างกลุ่มผลิตภัณฑ์ API ที่มีนโยบายการบันทึกธุรกรรมซึ่งกำหนดแอตทริบิวต์ที่กำหนดเองแล้ว

ขั้นตอนระดับสูงมีดังนี้

1. กำหนดแอตทริบิวต์ที่กำหนดเองเมื่อเพิ่มผลิตภัณฑ์ API
2. สร้างชุดผลิตภัณฑ์ API ที่มีผลิตภัณฑ์ดังกล่าว
   ในนโยบายการบันทึกธุรกรรมสำหรับแพ็กเกจผลิตภัณฑ์ API ให้เพิ่มแอตทริบิวต์ที่กำหนดเองซึ่งจะใช้ในการกำหนดแพ็กเกจราคา
3. สร้างแผนราคาประเภทการ์ดราคาหรือการแจ้งเตือนแบบปรับได้สำหรับแพ็กเกจผลิตภัณฑ์ API และระบุพารามิเตอร์การให้คะแนนที่กำหนดเอง

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

วิธีสร้างค่าแอตทริบิวต์ที่กำหนดเองในข้อความ

นโยบายการบันทึกธุรกรรมจะค้นหาค่าแอตทริบิวต์ที่กำหนดเองได้จากหลายที่ เช่น ส่วนหัวการตอบกลับ เนื้อหาการตอบกลับ หรือตัวแปรโฟลว์ที่กำหนดไว้ล่วงหน้าในการตอบกลับ (คำขอไม่พร้อมใช้งานเนื่องจากธุรกรรมยังไม่เป็นทางการจนกว่าคุณจะได้รับการตอบกลับสำเร็จ) ต่อไปนี้เป็นตัวอย่างที่แสดงวิธีเพิ่มส่วนหัวการตอบกลับที่มีค่าตัวเลขในข้อความ ในทั้ง 2 กรณี เราจะใช้นโยบายมอบหมายข้อความร่วมกับตัวแปร

การเพิ่มขนาดเปย์โหลดคำขอลงในส่วนหัวการตอบกลับ

ในคำขอข้อความแต่ละรายการจะมีตัวแปร client.received.content.length ที่มีจำนวนไบต์ในเพย์โหลดของคำขอ การแนบนโยบาย Assign Message กับการตอบกลับปลายทางพร็อกซีจะทำให้เราสามารถสร้างส่วนหัวการตอบกลับที่ชื่อว่า messageSize ที่มีค่าความยาวดังนี้

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

การเพิ่มค่าแอตทริบิวต์ที่กำหนดเองของแอปในส่วนหัว

เราสร้างส่วนหัวด้วยค่าของแอตทริบิวต์ที่กำหนดเองในแอปในลักษณะเดียวกันได้ เช่น หากคุณใส่แอตทริบิวต์ที่กำหนดเองชื่อ apprating ในแอปนักพัฒนาแอปแต่ละแอป ดังนี้

เมื่อใช้นโยบายคีย์ API ยืนยัน (ซึ่งจำเป็นสำหรับการสร้างรายได้) ค่านี้จะจัดเก็บในตัวแปรที่ชื่อ verifyapikey.{policy_name}.apprating เมื่อใช้นโยบาย Assign Message ซึ่งแนบกับการตอบสนองปลายทางของพร็อกซี คุณจะสร้างส่วนหัวชื่อ apprating ที่มีค่า apprating ของแอปได้ ดังนี้

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

การตั้งค่าแพ็กเกจราคา

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

การกำหนดค่าแพ็กเกจเรตการ์ดด้วยแอตทริบิวต์ที่กำหนดเองโดยใช้ UI

กำหนดค่าแพ็กเกจเรตการ์ดด้วยแอตทริบิวต์ที่กำหนดเองโดยใช้ Edge UI หรือ UI ของ Edge แบบคลาสสิกตามที่อธิบายไว้ในส่วนต่อไปนี้

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

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

การระบุรายละเอียดสำหรับแพ็กเกจราคาด้วยแอตทริบิวต์ที่กำหนดเองโดยใช้ API

ทำตามขั้นตอนเบื้องต้นต่อไปนี้

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

ถัดไป ให้ใช้ API เพื่อสร้างแพ็กเกจราคา

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

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

ตัวอย่างต่อไปนี้สร้างการ์ดราคาที่มีแพ็กเกจแอตทริบิวต์ที่กำหนดเองตามแอตทริบิวต์ที่กำหนดเองชื่อ messageSize (ดูรายการเป็นตัวหนา)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

รายการต่อไปนี้สร้างการแจ้งเตือนแบบปรับได้พร้อมแพ็กเกจอัตราแอตทริบิวต์ที่กำหนดเองตามแอตทริบิวต์ที่กำหนดเองชื่อ messageSize (ดูรายการเป็นตัวหนา)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based 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": "messageSize",
           "ratingParameterUnit": "MB",
           "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