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

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

บทนำ

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

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

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

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

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

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

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

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

รูปแบบการชาร์จ	การคํานวณแอตทริบิวต์ที่กําหนดเอง
อัตราคงที่และตามปริมาณ	custom attribute number * rate = charge to developer สำหรับอัตราคงที่ หมายเลขแอตทริบิวต์ที่กำหนดเองจะกลายเป็นจำนวนธุรกรรมที่คูณกับอัตรา สำหรับกลุ่มตามปริมาณ จำนวนธุรกรรมในกลุ่มจะเพิ่มขึ้นตามจำนวนแอตทริบิวต์ที่กำหนดเอง และระบบจะเรียกเก็บเงินจากนักพัฒนาแอปตามจำนวนธุรกรรมดังกล่าว ตัวอย่างเช่น หากค่าแอตทริบิวต์ที่กำหนดเองในข้อความคือ 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 และระบุพารามิเตอร์การจัดประเภทที่กำหนดเอง

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

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

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

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

ในคำขอข้อความแต่ละรายการจะมีตัวแปร 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 เมื่อใช้นโยบายข้อความที่กําหนดซึ่งแนบมากับการตอบกลับของปลายทางพร็อกซี คุณสามารถสร้างส่วนหัวที่ชื่อ 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 หรือ Edge UI แบบคลาสสิก ตามที่อธิบายไว้ในส่วนต่อไปนี้

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