กําหนดค่าแพ็กเกจส่วนแบ่งรายได้

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

เกริ่นนำ

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

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

การระบุรายละเอียดแผนส่วนแบ่งรายได้โดยใช้ UI

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

การระบุรายละเอียดแผนส่วนแบ่งรายได้โดยใช้ API

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

ระบุรายละเอียดแผนส่วนแบ่งรายได้สำหรับรูปแบบการแชร์แบบคงที่

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

• พารามิเตอร์การให้คะแนนที่บ่งบอกว่าแพ็กเกจราคาอิงตามธุรกรรม (VOLUME) ค่าเริ่มต้นคือ VOLUME
• ประเภทการวัด (UNIT) ที่บ่งบอกว่าส่วนแบ่งรายได้คงที่ต่อหน่วย (กล่าวคือไม่ได้อิงตามปริมาณธุรกรรม เช่นเดียวกับรูปแบบการแชร์แบบยืดหยุ่น)
• ประเภทรายได้ (GROSS หรือ NET) ข้อมูลนี้จะระบุว่าส่วนแบ่งรายได้อิงตามราคารวมหรือราคาสุทธิของธุรกรรม
• ระยะเวลาที่ครบกำหนดชำระเงิน (เช่น 30 วัน)
• รหัสขององค์กร
• "ฐาน" หรือสกุลเงินที่ใช้ในการบัญชีที่บริษัทของคุณใช้
• อัตราแพ็กเกจราคาที่ระบุรายละเอียดวิธีคำนวณส่วนแบ่งรายได้ เนื่องจากโมเดลการแชร์นั้นอิงตามอัตราคงที่ คุณจึงระบุอัตราแพ็กเกจเพียงอัตราเดียว

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

ในอัตราแพ็กเกจราคา คุณจะระบุสิ่งต่อไปนี้

• ประเภทราคาแพ็กเกจราคา (REVSHARE)
• เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้ ตัวอย่างเช่น หากคุณระบุ 80.5555 ส่วนแบ่งรายได้คือ 80.5555% ในฐานะผู้ให้บริการ API คุณจะต้องชำระเงินให้นักพัฒนาซอฟต์แวร์ 80.5555% ของราคาที่เรียกเก็บสำหรับแต่ละธุรกรรม (หรือหากอิงตามแอตทริบิวต์ที่กำหนดเอง เช่น จำนวนไบต์ที่ส่งในธุรกรรม คุณจะต้องจ่ายเงิน 80.5555% ของราคาที่ส่งให้แก่นักพัฒนาแอป)
• หน่วยเริ่มต้นของแอปพลิเคชันราคา (0) ซึ่งหมายความว่าจะมีการใช้อัตรากับธุรกรรมแต่ละรายการ โดยเริ่มจากธุรกรรมแรก

ดูพร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคาสำหรับรายการที่พักแพ็กเกจราคาทั้งหมด

ตัวอย่างต่อไปนี้สร้างแผนส่วนแบ่งรายได้ที่มีรูปแบบการแชร์แบบคงที่ เปอร์เซ็นต์ส่วนแบ่งรายได้คือ 80.5555% ส่วนแบ่งรายได้จะอิงตามราคาสุทธิของธุรกรรม สัญญามีผลบังคับใช้ในวันที่ 15 กันยายน 2013 และครบกำหนดชำระเงินภายใน 30 วัน (ไฮไลต์รายละเอียดเกี่ยวกับส่วนแบ่งรายได้)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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

คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

การระบุรายละเอียดของแผนส่วนแบ่งรายได้สำหรับรูปแบบการแชร์ที่ยืดหยุ่น

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

นอกจากอัตราแพ็กเกจราคาแล้ว คุณจะต้องระบุข้อมูลต่อไปนี้ในรายละเอียดแพ็กเกจราคาด้วย

• พารามิเตอร์การให้คะแนนที่บ่งบอกว่าแพ็กเกจราคาอิงตามธุรกรรม (VOLUME) ค่าเริ่มต้นคือ VOLUME
• ประเภทการวัด (VOLUME) ที่บ่งบอกว่าส่วนแบ่งรายได้ไม่ได้อิงตามปริมาณธุรกรรม (กล่าวคือไม่มีการกำหนดตายตัว เช่นเดียวกับกรณีของรูปแบบการแชร์คงที่)
• ประเภทรายได้ (GROSS หรือ NET) ข้อมูลนี้จะระบุว่าส่วนแบ่งรายได้อิงตามราคารวมหรือราคาสุทธิของธุรกรรม
• ระยะเวลาที่ครบกำหนดชำระเงิน (เช่น 30 วัน)
• รหัสขององค์กร
• "ฐาน" หรือสกุลเงินที่ใช้ในการบัญชีที่บริษัทของคุณใช้
• ระยะเวลาและประเภทระยะเวลาซึ่งร่วมกันระบุระยะเวลาที่มีการรวบรวมรายได้ (หรือเรียกว่า "เกณฑ์การรวม") ระบบจะรวบรวมข้อมูลธุรกรรมผ่านวิธีการสรุปรวม (เช่น 1 เดือน) เพื่อคำนวณรายได้ทั้งหมดและช่วงรายได้ที่เกี่ยวข้อง เปอร์เซ็นต์ส่วนแบ่งรายได้ที่ใช้กับธุรกรรมแต่ละรายการจะขึ้นอยู่กับช่วงรายได้ ของธุรกรรมนั้นๆ
• ตัวนับการรวมที่ใช้เพื่อกำหนดช่วงรายได้ที่เกี่ยวข้อง

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

สำหรับอัตราแพ็กเกจราคาแต่ละรายการ คุณจะระบุข้อมูลดังนี้

• ประเภทของอัตราแพ็กเกจอัตราสำหรับช่วงรายได้ (REVSHARE)
• เปอร์เซ็นต์ที่ใช้ในการคำนวณส่วนแบ่งรายได้สำหรับช่วงรายได้ ตัวอย่างเช่น หากคุณระบุ 80.5555 ส่วนแบ่งรายได้สำหรับช่วงรายได้คือ 80.5555% กล่าวคือ ในฐานะผู้ให้บริการ API คุณจะต้องชำระเงินให้กับนักพัฒนาซอฟต์แวร์ 80.5555% ของราคาที่เรียกเก็บสำหรับธุรกรรมแต่ละรายการในช่วงรายได้นั้น
• หน่วยเริ่มต้นและหน่วยสิ้นสุดของช่วงรายได้ หน่วยเริ่มต้นจะระบุขีดจำกัดต่ำสุดของช่วงรายได้ และหน่วยสุดท้ายจะระบุขีดจำกัดบนของช่วงรายได้ ตัวอย่างเช่น หากคุณระบุหน่วยเริ่มต้นเป็น 0 และหน่วยสิ้นสุดเป็น 1000 ช่วงรายได้จะครอบคลุมรายได้จากธุรกรรมที่มากกว่า 0 แต่ไม่เกิน 1,000 ในสกุลเงินที่ระบุ หากสกุลเงินเป็นดอลลาร์สหรัฐ เกณฑ์การรวมคือ 1 เดือน และเปอร์เซ็นต์ของช่วงรายได้คือ 80.5555% สำหรับธุรกรรมที่สร้างรายได้สูงสุด $1,000 ใน 1 เดือน ส่วนแบ่งรายได้จะเท่ากับ 80.5555% ของราคาธุรกรรม

  หากคุณไม่ระบุหน่วยสิ้นสุดสำหรับช่วงรายได้สุดท้าย เปอร์เซ็นต์ส่วนแบ่งของช่วงรายได้ดังกล่าวจะมีผลกับธุรกรรมทั้งหมดหลังจากที่รายได้รวมสูงกว่าหน่วยเริ่มต้นสำหรับช่วงดังกล่าว ตัวอย่างเช่น หากหน่วยเริ่มต้นสำหรับช่วงสุดท้ายคือ 1,000 (ใช้ดอลลาร์สหรัฐฯ) และคุณไม่ได้ระบุหน่วยปิดท้ายสำหรับช่วงความถี่นั้น เปอร์เซ็นต์รายได้สำหรับช่วงความถี่จะใช้กับธุรกรรมทั้งหมดที่มีรายได้สูงกว่า $1, 000 ในช่วงเวลารวม

ดูพร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคาสำหรับรายการที่พักแพ็กเกจราคาทั้งหมด

ตัวอย่างต่อไปนี้สร้างแผนส่วนแบ่งรายได้ที่มีรูปแบบการแชร์ที่ยืดหยุ่น ระบุช่วงรายได้ 2 ช่วง ช่วงแรกครอบคลุมรายได้จากธุรกรรมมากกว่า 1,000 ดอลลาร์สหรัฐ ช่วงที่ 2 ครอบคลุมรายได้จากธุรกรรมมากกว่า 1,000 ดอลลาร์สหรัฐ เปอร์เซ็นต์ส่วนแบ่งรายได้ของช่วงรายได้ที่ 2 คือ 80.5555% และ 90.5% สำหรับช่วงรายได้ที่ 2 ส่วนแบ่งรายได้จะอิงตามราคาสุทธิของธุรกรรม เกณฑ์วิธีการรวมคือ 1 เดือน ระยะเวลาของสัญญามีผลวันที่ 15 กันยายน 2013 และครบกำหนดชำระภายใน 30 วัน (ไฮไลต์รายละเอียดเกี่ยวกับส่วนแบ่งรายได้)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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

คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}