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

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

บทนำ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ในคำขอส่งข้อความแต่ละรายการ มีตัวแปร client.received.content.length ที่ มีจำนวนไบต์ในเพย์โหลดคำขอ แนบนโยบาย "มอบหมายข้อความ" ไว้กับ การตอบกลับของปลายทางพร็อกซี เราจะสร้างส่วนหัวการตอบกลับที่เรียกว่า 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 ไว้ในนักพัฒนาซอฟต์แวร์แต่ละราย ดังนี้

เมื่อใช้นโยบายคีย์ Verify 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