คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
จัดการแพ็กเกจราคาโดยใช้ UI และ API ตามที่อธิบายไว้ในส่วนต่อไปนี้
สำรวจหน้าแพ็กเกจราคา
เข้าถึงหน้าแพ็กเกจราคาตามที่อธิบายไว้ด้านล่าง
Edge
หากต้องการดูแพ็กเกจราคาใน Edge UI ให้ไปที่หน้าแพ็กเกจราคา ดังนี้
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > แพ็กเกจราคาในแถบนำทางด้านซ้าย
หน้าแพ็กเกจราคาจะปรากฏขึ้น
ดังที่ไฮไลต์ในรูป หน้าแพ็กเกจราคาช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของแพ็กเกจราคาทั้งหมด ซึ่งรวมถึงชื่อแพ็กเกจ แพ็กเกจผลิตภัณฑ์ API สถานะ (เผยแพร่หรือฉบับร่าง) ค่าใช้จ่ายของแพ็กเกจ และวันที่เริ่มต้นและสิ้นสุด
หมายเหตุ: แพ็กเกจราคาที่หมดอายุจะไม่แสดงใน UI หากต้องการดูแพ็กเกจราคาที่หมดอายุ โปรดใช้ API โปรดดูการดูแพ็กเกจราคาโดยใช้ API - สร้างแพ็กเกจราคา
- แก้ไขแพ็กเกจราคา
- เผยแพร่แพ็กเกจราคา
- ลบแพ็กเกจราคาฉบับร่าง
- เพิ่มแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในการจัดการแพ็กเกจราคาในอนาคต
- ค้นหารายการแพ็กเกจราคาในช่องที่มองเห็นได้ หรือชื่อนักพัฒนาแอปหรือหมวดหมู่ (หากมี)
Classic Edge (Private Cloud)
หากต้องการดูแพ็กเกจราคาโดยใช้ UI แบบคลาสสิกของ Edge โปรดไปที่หน้าแพ็กเกจ API โดยทำดังนี้
- ลงชื่อเข้าใช้
http://ms-ip:9000
โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ - เลือกเผยแพร่ > แพ็กเกจในแถบนำทางด้านบน
หน้าแพ็กเกจ API จะแสดงแพ็กเกจราคาที่กำหนดไว้สำหรับแต่ละแพ็กเกจ
หน้าแพ็กเกจราคาช่วยให้คุณทำสิ่งต่อไปนี้ได้
- สร้างแพ็กเกจราคา
- แก้ไขแพ็กเกจราคา
- เผยแพร่แพ็กเกจราคา
- ลบแพ็กเกจราคาฉบับร่าง
- เพิ่มแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในการจัดการแพ็กเกจราคาในอนาคต
- ค้นหารายการแพ็กเกจราคาในช่องที่มองเห็นได้ หรือชื่อนักพัฒนาแอปหรือหมวดหมู่ (หากมี)
การสร้างแพ็กเกจราคา
วิธีสร้างแพ็กเกจราคา
- เข้าถึงหน้าแพ็กเกจราคา
- คลิก +แพ็กเกจราคา
- กำหนดค่าช่องต่อไปนี้ในแผงด้านบน:
ฟิลด์ คำอธิบาย ค่าเริ่มต้น จำเป็น ชื่อแพ็กเกจราคา ชื่อแพ็กเกจราคา หมายเหตุ: ชื่อต้องไม่ซ้ำกันภายในแพ็กเกจผลิตภัณฑ์ API แพ็กเกจ 2 รายการในแพ็กเกจผลิตภัณฑ์เดียวกันไม่สามารถมีชื่อซ้ำกันได้
ไม่มีข้อมูล มี ประเภทแพ็กเกจราคา ประเภทแพ็กเกจราคา เลือกค่าจากรายการแบบเลื่อนลง โปรดดูรายการประเภทแพ็กเกจราคาที่ถูกต้องที่หัวข้อประเภทแพ็กเกจราคาที่รองรับ ไม่มีข้อมูล มี แพ็กเกจผลิตภัณฑ์ กลุ่มผลิตภัณฑ์ API เลือกค่าจากรายการแบบเลื่อนลง สำหรับข้อมูลเพิ่มเติมเกี่ยวกับกลุ่มผลิตภัณฑ์ API โปรดดูการจัดการกลุ่มผลิตภัณฑ์ API หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ คุณต้องเลือกว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการ หรือแพ็กเกจราคาทั่วไปที่จะใช้กับผลิตภัณฑ์ API ทั้งหมด
ไม่มีข้อมูล มี ผู้ชม กลุ่มเป้าหมายที่เข้าถึงแพ็กเกจราคาได้ เลือกค่าใดค่าหนึ่งต่อไปนี้จากรายการแบบเลื่อนลง - ทุกคน - นักพัฒนาแอปทั้งหมด
- นักพัฒนาซอฟต์แวร์ - นักพัฒนาซอฟต์แวร์หรือบริษัท ป้อนชื่อนักพัฒนาแอปหรือบริษัท ในขณะที่คุณพิมพ์ รายชื่อนักพัฒนาซอฟต์แวร์/บริษัทที่มีสตริงนี้จะแสดงในเมนูแบบเลื่อนลง คลิกชื่อนักพัฒนาแอปหรือบริษัทจากรายการแบบเลื่อนลง
- หมวดหมู่นักพัฒนาซอฟต์แวร์ - หมวดหมู่นักพัฒนาซอฟต์แวร์ เลือกหมวดหมู่นักพัฒนาซอฟต์แวร์จากรายการแบบเลื่อนลง
กำหนดค่าหมวดหมู่นักพัฒนาซอฟต์แวร์ตามที่จำเป็น ตามที่อธิบายไว้ในจัดการหมวดหมู่นักพัฒนาซอฟต์แวร์
ทุกคน ไม่ได้ วันที่เริ่มต้น วันที่แพ็กเกจราคามีผล ป้อนวันที่เริ่มต้นหรือเลือกวันที่โดยใช้ปฏิทิน วันนี้ ไม่ได้ End date วันที่แพ็กเกจราคาสิ้นสุดลง หากต้องการระบุวันที่สิ้นสุด ให้เปิดใช้สวิตช์มีวันที่สิ้นสุด และป้อนวันที่สิ้นสุด หรือเลือกวันที่โดยใช้ปฏิทิน หมายเหตุ: แพ็กเกจราคาจะมีผลจนถึงสิ้นสุดวันในวันที่ที่ระบุ ตัวอย่างเช่น หากต้องการให้แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2018 คุณควรตั้งค่า endDate เป็น 30-11-2018 ในกรณีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันที่ 30 พฤศจิกายน 2018 และจะบล็อกคำขอทั้งหมดในวันที่ 1 ธันวาคม 2018
ไม่มี ไม่ได้ ปรากฏแก่พอร์ทัล กำหนดว่าแพ็กเกจราคาเป็นสาธารณะหรือส่วนตัว ดูแพ็กเกจราคาสาธารณะกับส่วนลดเฉพาะบุคคล เปิดใช้อยู่ ไม่ได้ - กำหนดค่าค่าธรรมเนียมสำหรับแพ็กเกจราคา ดูการกำหนดค่าค่าธรรมเนียมสำหรับแพ็กเกจราคา
หมายเหตุ: ใช้ไม่ได้กับแผนการแจ้งเตือนแบบปรับเปลี่ยนได้ - หากเลือกแพ็กเกจผลิตภัณฑ์ที่มีผลิตภัณฑ์ API มากกว่า 1 รายการ ให้ตั้งค่ากำหนดต่อไปนี้ในส่วนแพ็กเกจราคาที่เจาะจงหรือทั่วไป
หมายเหตุ: ขั้นตอนนี้ใช้ไม่ได้กับแผนการแจ้งเตือนแบบปรับได้
ฟิลด์ คำอธิบาย ค่าเริ่มต้น กำหนดค่าผลิตภัณฑ์แต่ละรายการแยกกัน แฟล็กที่ระบุว่าจะกำหนดค่าแพ็กเกจราคาแต่ละรายการสำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้ กำหนดค่าข้อเสนอฟรีเมียมของแต่ละผลิตภัณฑ์แยกกัน แฟล็กที่ระบุว่าจะกำหนดค่าแพ็กเกจ Freemium สำหรับผลิตภัณฑ์ API แต่ละรายการหรือไม่ ปิดใช้ เลือกไอเทม หากเปิดใช้การตั้งค่าสถานะรายการใดรายการหนึ่งหรือทั้ง 2 รายการ คุณต้องเลือกผลิตภัณฑ์แต่ละรายการจากรายการแบบเลื่อนลง และกำหนดค่ารายละเอียดแพ็กเกจราคา หมายเหตุ: ตรวจสอบว่าได้กำหนดค่าผลิตภัณฑ์ทั้งหมดในแพ็กเกจผลิตภัณฑ์แล้ว
ไม่มีข้อมูล - กำหนดค่ารายละเอียดแพ็กเกจราคาตามประเภทแพ็กเกจราคาที่เลือก ดังนี้
- คลิกหนึ่งในตัวเลือกต่อไปนี้
ปุ่ม คำอธิบาย บันทึกเป็นฉบับร่าง บันทึกแพ็กเกจราคาเป็นฉบับร่าง นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคาจนกว่าคุณจะเผยแพร่แพ็กเกจ คุณแก้ไขช่องใดก็ได้ในแพ็กเกจราคาฉบับร่าง
เผยแพร่แผนใหม่ เผยแพร่แผน หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ในกรณีที่ยังไม่ได้ตั้งค่าเท่านั้น คุณจะลบแพ็กเกจราคาหลังจากที่เผยแพร่แล้วไม่ได้ แต่สามารถทำให้แพ็กเกจราคาหมดอายุและแทนที่ด้วยแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในแพ็กเกจราคาที่เผยแพร่แล้วหมดอายุ
- แนบนโยบายการตรวจสอบขีดจำกัดการสร้างรายได้กับพร็อกซี API ที่เชื่อมโยงกับผลิตภัณฑ์ API ที่รวมอยู่ในแพ็กเกจราคา นโยบายการตรวจสอบขีดจำกัดการสร้างรายได้บังคับใช้ขีดจำกัดการสร้างรายได้บนพร็อกซีของ API และดูแลให้มีการบันทึกข้อผิดพลาดอย่างถูกต้องในรายงานข้อมูลวิเคราะห์และการสร้างรายได้ สำหรับข้อมูลเพิ่มเติม โปรดดูที่บังคับใช้ขีดจำกัดการสร้างรายได้บนพร็อกซี API
การแก้ไขแพ็กเกจราคา
คุณสามารถแก้ไขทุกช่องในแผนราคาฉบับร่างได้ ยกเว้นกลุ่มผลิตภัณฑ์ ประเภท และกลุ่มเป้าหมาย หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ในกรณีที่ไม่ได้ระบุวันที่สิ้นสุดเท่านั้น
วิธีแก้ไขแพ็กเกจราคา
- เข้าถึงหน้าแพ็กเกจราคา
- คลิกในแถวของแพ็กเกจราคาที่ต้องการแก้ไข
แผงแพ็กเกจราคาจะปรากฏขึ้น - แก้ไขช่องแพ็กเกจราคาตามต้องการ
หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ในกรณีที่ยังไม่ได้ตั้งค่าเท่านั้น - คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
ปุ่ม คำอธิบาย อัปเดตฉบับร่าง (แผนอัตราฉบับร่าง) บันทึกแพ็กเกจราคาเป็นฉบับร่าง
นักพัฒนาแอปจะไม่เห็นแพ็กเกจราคานี้จนกว่าคุณจะเผยแพร่แพ็กเกจ คุณแก้ไขช่องใดก็ได้ในแพ็กเกจราคาฉบับร่างเผยแพร่ฉบับร่าง (แพ็กเกจอัตราฉบับร่าง) เผยแพร่แพ็กเกจราคา
หมายเหตุ: หลังจากเผยแพร่แพ็กเกจราคาแล้ว คุณจะแก้ไขวันที่สิ้นสุดได้ในกรณีที่ยังไม่ได้ตั้งค่าเท่านั้น คุณจะลบแพ็กเกจราคาหลังจากที่เผยแพร่แล้วไม่ได้ แต่สามารถทำให้แพ็กเกจราคาหมดอายุและแทนที่ด้วยแพ็กเกจราคาในอนาคตตามที่อธิบายไว้ในแพ็กเกจราคาที่เผยแพร่แล้วหมดอายุวันที่สิ้นสุดที่อัปเดต (แพ็กเกจราคาที่เผยแพร่) กำหนดวันที่สิ้นสุดของแผนที่เผยแพร่
หมายเหตุ: เมื่อกำหนดวันที่สิ้นสุดสำหรับแพ็กเกจราคาที่เผยแพร่แล้ว จะแก้ไขไม่ได้อีก
การลบแพ็กเกจราคาฉบับร่าง
ลบแพ็กเกจราคาฉบับร่างหากไม่ต้องการใช้บริการแล้ว
หมายเหตุ: คุณจะลบแพ็กเกจราคาที่เผยแพร่ไม่ได้
วิธีลบแพ็กเกจราคาฉบับร่าง
- เข้าถึงหน้าแพ็กเกจราคา
- วางเคอร์เซอร์ไว้เหนือแพ็กเกจราคาที่ต้องการลบเพื่อแสดงเมนูการทำงาน
- คลิก
- คลิกลบเพื่อยืนยันการดำเนินการ
การจัดการแพ็กเกจราคาโดยใช้ API
ส่วนต่อไปนี้จะอธิบายวิธีจัดการแพ็กเกจราคาโดยใช้ API
การสร้างแพ็กเกจราคาโดยใช้ API
หากต้องการสร้างแพ็กเกจราคา ให้ส่งคำขอ POST ไปยัง /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans
โดยที่ {monetizationpackage_id}
คือรหัสของแพ็กเกจผลิตภัณฑ์ API ที่คุณสร้างแพ็กเกจราคาให้ (ระบบจะส่งรหัสในคำตอบเมื่อคุณสร้างกลุ่มผลิตภัณฑ์ API)
เมื่อสร้างแพ็กเกจราคา คุณต้องระบุสิ่งต่อไปนี้ในเนื้อหาคำขอ
- รหัสองค์กร
- รหัสชุดผลิตภัณฑ์ API
- ชื่อของแพ็กเกจราคา
- คำอธิบายแพ็กเกจราคา
- ขอบเขตของแพ็กเกจราคา (มีผลกับนักพัฒนาแอปทุกราย หรือนักพัฒนาแอป บริษัท หรือหมวดหมู่นักพัฒนาแอปที่เจาะจงเท่านั้น)
- วันที่แพ็กเกจราคามีผล
- สกุลเงินสำหรับแพ็กเกจราคา
- จะเผยแพร่แพ็กเกจราคาหรือไม่
- แพ็กเกจราคาเป็นสาธารณะหรือส่วนตัว
มีการตั้งค่าอื่นๆ ที่คุณเลือกระบุได้ เช่น วันที่ครบกำหนดชำระเงิน (เช่น 30 วัน) โปรดดูพร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคา
หากสร้างแพ็กเกจราคา (นอกเหนือจากแพ็กเกจค่าธรรมเนียมเท่านั้น) สำหรับแพ็กเกจผลิตภัณฑ์ API ที่มีผลิตภัณฑ์มากกว่า 1 รายการ คุณจะใช้แพ็กเกจดังกล่าวกับผลิตภัณฑ์ที่เฉพาะเจาะจงในแพ็กเกจผลิตภัณฑ์ได้ โดยระบุผลิตภัณฑ์ในคำขอ หากไม่ระบุผลิตภัณฑ์ ระบบจะใช้แผนกับผลิตภัณฑ์ทั้งหมดในแพ็กเกจผลิตภัณฑ์ API
ส่วนต่อไปนี้อธิบายวิธีสร้างแพ็กเกจราคา
- การสร้างแพ็กเกจราคามาตรฐานโดยใช้ API
- การสร้างแพ็กเกจราคาสำหรับนักพัฒนาหรือบริษัทโดยใช้ API
- การสร้างแพ็กเกจราคาหมวดหมู่นักพัฒนาซอฟต์แวร์โดยใช้ API
- การสร้างแพ็กเกจราคาเฉพาะผลิตภัณฑ์ API โดยใช้ API
- การตั้งค่าแพ็กเกจราคาเป็นสาธารณะหรือส่วนตัวโดยใช้ API
การสร้างแพ็กเกจราคามาตรฐานโดยใช้ API
หากต้องการสร้างแพ็กเกจราคามาตรฐาน ให้ตั้งค่าแอตทริบิวต์ type
เป็น STANDARD
ดังที่แสดงในตัวอย่างต่อไปนี้
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
การสร้างแพ็กเกจราคาสำหรับนักพัฒนาหรือบริษัทโดยใช้ API
หากต้องการใช้แพ็กเกจราคากับนักพัฒนาแอปหรือบริษัทที่เฉพาะเจาะจง ให้กำหนดค่า type
เป็น Developer
คุณต้องระบุนักพัฒนาแอปหรือบริษัทในคำขอ โดยระบุรหัส ชื่อตามกฎหมาย และชื่อนักพัฒนาแอปของบริษัท
ตัวอย่างเช่น ข้อความที่ตัดตอนมาต่อไปนี้สร้างแพ็กเกจราคาสำหรับนักพัฒนาแอป Dev Five
... "type": "DEVELOPER", "developer" : { "id" : "0mkKu1PALUGfjUph", "legalName" : "DEV FIVE", "name" : "Dev Five" } ...
การสร้างแพ็กเกจราคาหมวดหมู่นักพัฒนาซอฟต์แวร์โดยใช้ API
หากต้องการใช้แพ็กเกจราคากับหมวดหมู่นักพัฒนาแอป ให้กำหนดค่า type
เป็น Developer_Category
คุณต้องระบุหมวดหมู่นักพัฒนาซอฟต์แวร์ในคำขอด้วย
เช่น
... "type": "DEVELOPER_CATEGORY", "developerCategory" : { "id" : "5e172299-8232-45f9-ac46-40076139f373", "name" : "Silver", "description" : "Silver category" } ...
การสร้างแผนอัตราเฉพาะผลิตภัณฑ์ API โดยใช้ API
เมื่อสร้างแพ็กเกจราคาสำหรับแพ็กเกจผลิตภัณฑ์ API ที่มีผลิตภัณฑ์ API หลายรายการ คุณจะระบุรายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API แต่ละรายการได้
ตัวอย่างต่อไปนี้จะสร้างแผนส่วนแบ่งรายได้ที่มีผลิตภัณฑ์ API 2 รายการ
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Multi-product rate plan", "currency": { "id" : "usd" }, "description": "Multi-product rate plan", "displayName" : "Multi-product rate plan", "monetizationPackage": { "id": "mypackage", ... }, "organization": { "id": "{org_name}", ... }, "published": true, "isPrivate" : false, "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":0, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product1","displayName":"Product1"}, "customPaymentTerm":false }, { "ratePlanRates":[{ "revshare":10, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "product":{"id":"product2","displayName":"Product2"}, "customPaymentTerm":false } ], "startDate": "2019-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \ -u email:password
หากต้องการเพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API my-package
คุณจะต้องเพิ่มรายละเอียดแพ็กเกจราคาสำหรับผลิตภัณฑ์ API ในส่วนเนื้อหาของคำขอตามที่อธิบายไว้ในส่วนการเพิ่มผลิตภัณฑ์ API ลงในแพ็กเกจผลิตภัณฑ์ API ที่มีแพ็กเกจอัตราเฉพาะผลิตภัณฑ์ API
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "ratePlan": [ { "id": "my-package_multi-product-rate-plan", "ratePlanDetails": [ { "ratePlanRates":[{ "revshare":20, "startUnit":0, "type":"REVSHARE", "endUnit":null }], "revenueType":"NET", "type":"REVSHARE" "currency":{...}, "customPaymentTerm":false }] }] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \ -u email:password
การตั้งแพ็กเกจราคาเป็นสาธารณะหรือส่วนตัวโดยใช้ API
เมื่อสร้างแพ็กเกจราคา คุณระบุได้ว่าแพ็กเกจดังกล่าวเป็นแบบสาธารณะหรือส่วนตัวโดยใช้แอตทริบิวต์ isPrivate
ในเนื้อหาคำขอ หากตั้งค่าเป็น true
แพ็กเกจราคาจะเป็นแบบส่วนตัว ดูข้อมูลเพิ่มเติมได้ที่แพ็กเกจราคาสาธารณะและส่วนตัว
ตัวอย่างต่อไปนี้สร้างแพ็กเกจอัตราส่วนลดเฉพาะบุคคล
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Simple rate plan", "currency": { "id" : "usd" }, "description": "Simple rate plan", "displayName" : "Simple rate plan", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "published": true, "isPrivate" : true, "ratePlanDetails": [ { … } ], "startDate": "2013-09-15", "type": "STANDARD" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \ -u email:password
การเผยแพร่แพ็กเกจราคาโดยใช้ API
หากต้องการเผยแพร่แพ็กเกจราคา ให้กำหนดค่าที่พัก published
เป็น "จริง" เมื่อสร้างแพ็กเกจราคา นักพัฒนาแอปจะดูแพ็กเกจราคาได้ตั้งแต่วันที่ที่ระบุไว้ในพร็อพเพอร์ตี้ startDate
ของแพ็กเกจ
ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจการ์ดราคาและเผยแพร่แพ็กเกจดังกล่าว (แสดงเฉพาะคำขอเพียงบางส่วนเท่านั้น)
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "true", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
การบันทึกแพ็กเกจราคาฉบับร่างโดยใช้ API
หากต้องการบันทึกแพ็กเกจราคาโดยไม่เผยแพร่ ให้ตั้งค่าที่พัก published
เป็น "เท็จ" เมื่อสร้างแพ็กเกจราคา
ตัวอย่างเช่น การดำเนินการต่อไปนี้จะสร้างแผนการ์ดราคาและบันทึกเป็นฉบับร่าง (แสดงเฉพาะคำขอเพียงบางส่วนเท่านั้น)
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Flat rate card plan", "developer":null, "developerCategory":null, "advance": "false", … "published": "false", "ratePlanDetails": [ … ], … "type": "RATECARD" }], … }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \ -u email:password
การแก้ไขแพ็กเกจราคาฉบับร่างโดยใช้ API
หากต้องการอัปเดตฉบับร่างแพ็กเกจราคา ให้ส่งคำขอ PUT ไปยัง
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}
โดย {package_id}
คือตัวระบุแพ็กเกจ API และ
{plan_Id}
คือตัวระบุแพ็กเกจราคา เมื่อทำการอัปเดต คุณต้องระบุการตั้งค่าที่อัปเดตและรหัสของแพ็กเกจราคาในส่วนเนื้อหาของคำขอ หากอัปเดตราคาแพ็กเกจราคา คุณจะต้องระบุรหัสของราคาแพ็กเกจด้วย ตัวอย่างเช่น คำขอต่อไปนี้อัปเดตอัตราแพ็กเกจราคาในแพ็กเกจราคาที่มีรหัสเป็น location_flat_rate_card_plan
(ไฮไลต์การอัปเดต)
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "location_flat_rate_card_plan", "name": "Flat rate card plan", "advance": "false", "currency": { "id" : "usd" }, "description": "Flat rate card plan", "displayName" : "Flat rate card plan", "frequencyDuration": "30", "frequencyDurationType": "DAY", "earlyTerminationFee": "10", "monetizationPackage": { "id": "location" }, "organization": { "id": "{org_name}" }, "paymentDueDays": "30", "prorate": "false", "published": "false", "ratePlanDetails": [ { "currency": { "id" : "usd" }, "paymentDueDays": "30", "meteringType": "UNIT", "organization": { "id": "{org_name}" }, "ratePlanRates": [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "type": "RATECARD", "rate": "0.15", "startUnit": "0" } ], "ratingParameter": "VOLUME", "type": "RATECARD" }], "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/location_flat_rate_card_plan" \ -u email:password
คําตอบประกอบด้วยอัตราแพ็กเกจราคาที่อัปเดต (แสดงคําตอบเพียงบางส่วนเท่านั้น) ดังนี้
… "ratePlanRates" : [ { "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec", "rate" : 0.15, "startUnit" : 0, "type" : "RATECARD" } ], …
การดูแพ็กเกจราคาโดยใช้ API
คุณสามารถดูแพ็กเกจราคาโดยใช้ API การสร้างรายได้ตามที่อธิบายไว้ในส่วนต่อไปนี้
- การดูแพ็กเกจราคาทั้งหมดสำหรับองค์กรโดยใช้ API
- การดูแพ็กเกจราคาทั้งหมดสำหรับแพ็กเกจผลิตภัณฑ์ API โดยใช้ API
- การดูแพ็กเกจราคาสำหรับแพ็กเกจผลิตภัณฑ์ API โดยใช้ API
- การดูแพ็กเกจราคาที่ใช้งานอยู่ทั้งหมดสำหรับนักพัฒนาแอปที่ใช้ API
- การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่ใช้ API
- การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API ที่ใช้ API
- การดูแพ็กเกจราคาทั้งหมดที่นักพัฒนาแอปยอมรับโดยใช้ API
การดูแพ็กเกจราคาทั้งหมดสำหรับองค์กรโดยใช้ API
หากต้องการดูแพ็กเกจราคาทั้งหมดสำหรับองค์กร ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/rate-plans
โดย {org_name}
เป็นชื่อองค์กรของคุณ
คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้
พารามิเตอร์การค้นหา | คำอธิบาย |
---|---|
all |
แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจราคาทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหา size จะเป็นตัวกำหนดจำนวนแพ็กเกจราคาที่แสดงต่อหน้า ค่าเริ่มต้นคือ true |
size |
จำนวนแพ็กเกจ API ที่ส่งคืนต่อหน้า หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ |
page |
จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้ |
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
การดูแพ็กเกจราคาทั้งหมดสำหรับแพ็กเกจผลิตภัณฑ์ API โดยใช้ API
หากต้องการดูแพ็กเกจราคาทั้งหมดสำหรับแพ็กเกจ API ให้ส่งคำขอ GET ไปยัง
/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans
โดย {package_id}
คือรหัสของแพ็กเกจ API (ระบบจะส่งรหัสแพ็กเกจให้เมื่อคุณสร้างแพ็กเกจการสร้างรายได้)
โดยค่าเริ่มต้น ระบบจะแสดงเฉพาะแพ็กเกจราคาที่ใช้งานอยู่ แพ็กเกจสาธารณะ และแพ็กเกจราคามาตรฐานในผลการค้นหา วิธีรวม
- แพ็กเกจราคาฉบับร่างหรือที่หมดอายุ ให้ตั้งค่าพารามิเตอร์การค้นหา
current
เป็นfalse
(เช่น?current=false
) - แพ็กเกจอัตราส่วนลดเฉพาะบุคคล ให้ตั้งค่าพารามิเตอร์การค้นหา
showPrivate
เป็นtrue
(เช่น?showPrivate=true
) - แพ็กเกจราคามาตรฐานทั้งหมด ให้ตั้งค่าพารามิเตอร์การค้นหา
standard
เป็นtrue
(เช่น?standard=true
)
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
การดูแพ็กเกจราคาสำหรับแพ็กเกจ API โดยใช้ API
หากต้องการดูแพ็กเกจราคาสำหรับแพ็กเกจ API ให้ส่งคำขอ GET ไปยัง
/mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}
โดย {package_id}
คือรหัสของแพ็กเกจ API และ {plan_id}
คือ
รหัสของแพ็กเกจราคา (ระบบจะส่งรหัสแพ็กเกจให้เมื่อคุณสร้างแพ็กเกจการสร้างรายได้ และระบบจะส่งคืนรหัสแพ็กเกจราคาเมื่อคุณสร้างแพ็กเกจราคา)
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "advance" : true, "contractDuration" : 1, "contractDurationType" : "YEAR", "currency" : { "id" : "usd", ... "organization" : { ... }, ... }, "description" : "Standard Fixed Plan", "displayName" : "Standard Fixed Plan", "earlyTerminationFee" : 0.0000, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "communications_standard_fixed_plan", "isPrivate" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Standard Fixed Plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : true, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2", "rate" : 0.0500, "startUnit" : 0, "type" : "RATECARD" } ], "ratingParameter" : "VOLUME", "type" : "RATECARD" } ], "recurringFee" : 200.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 100.0000, "startDate" : "2013-01-11 22:00:00", "type" : "STANDARD" }
การดูแพ็กเกจราคาที่ใช้งานอยู่ทั้งหมดสำหรับนักพัฒนาแอปที่ใช้ API
หากต้องการดูแพ็กเกจราคาทั้งหมดที่ใช้งานอยู่สำหรับนักพัฒนาแอป ให้ส่งคำขอ GET ไปยัง
/mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans
โดย
{developer_id}
คืออีเมลของนักพัฒนาซอฟต์แวร์
คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้
พารามิเตอร์การค้นหา | คำอธิบาย |
---|---|
all |
แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false |
size |
จำนวนแพ็กเกจ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ |
page |
จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้ |
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "ratePlan" : [ { "advance" : true, "contractDuration" : 1, "contractDurationType" : "MONTH", "currency" : { "description" : "United States Dollar", "displayName" : "United States Dollar", "id" : "usd", "name" : "USD", "organization" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Fee Only RatePlan", "displayName" : "Fee Only RatePlan", "earlyTerminationFee" : 10.0000, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "WEEK", "id" : "messaging_package_fee_only_rateplan", "isPrivate" : false, "monetizationPackage" : { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, "name" : "Fee Only RatePlan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ ], "recurringFee" : 10.0000, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 20.0000, "startDate" : "2013-02-20 00:00:00", "type" : "STANDARD" } ], "totalRecords" : 1 }
การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์โดยใช้ API
หากต้องการดูแพ็กเกจราคาที่ใช้งานอยู่สำหรับนักพัฒนาแอป ให้ส่งคำขอ GET ไปยัง
/mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}
โดย {developer_id}
คืออีเมลของนักพัฒนาซอฟต์แวร์ และ {developer_rateplan_id}
คือ
รหัสของแพ็กเกจราคาที่ยอมรับซึ่งจะได้รับการตอบกลับเมื่อคุณยอมรับแพ็กเกจราคาที่เผยแพร่
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "created" : "2018-01-25 20:01:54", "developer" : { }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }
การดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API ที่ใช้ API
หากต้องการดูแพ็กเกจราคาที่ยอมรับสำหรับนักพัฒนาซอฟต์แวร์ที่มีผลิตภัณฑ์ API ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product
โดย {developer_id}
คือรหัสของนักพัฒนาซอฟต์แวร์ และ /{product_id}
คือรหัสของผลิตภัณฑ์
โดยค่าเริ่มต้น ระบบจะแสดงเฉพาะแพ็กเกจราคาสาธารณะในผลการค้นหา หากต้องการแสดงแพ็กเกจอัตราส่วนลดเฉพาะบุคคล ให้ตั้งค่าพารามิเตอร์การค้นหา showPrivate
เป็น true
(เช่น ?showPrivate=true
)
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
การดูแพ็กเกจราคาทั้งหมดที่นักพัฒนาแอปยอมรับโดยใช้ API
หากต้องการดูแพ็กเกจราคาที่นักพัฒนาแอปยอมรับแล้ว ให้ส่งคําขอ GET ไปยัง
/mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans
โดย {developer_id}
คือรหัสของนักพัฒนาแอป
คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองผลลัพธ์ได้
พารามิเตอร์การค้นหา | คำอธิบาย |
---|---|
all |
แฟล็กที่ระบุว่าจะแสดงผลแพ็กเกจ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false |
size |
จำนวนแพ็กเกจ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ |
page |
จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้ |
เช่น
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "developerRatePlan" : [ { "created" : "2018-01-25 20:01:54", "developer" : { ... }, "id" : "a73s104-276f-45b3-8075-83d1046ea550", "nextCycleStartDate" : "2018-02-19 00:00:00", "nextRecurringFeeDate" : "2018-02-19 00:00:00", "prevRecurringFeeDate" : "2018-01-25 00:00:00", "ratePlan" : { "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "recurringFee" : 0.0000, "recurringStartUnit" : 19, "recurringType" : "CALENDAR", "setUpFee" : 0.0000, "type" : "STANDARD" }, "startDate" : "2018-01-25 20:01:54", "updated" : "2018-01-25 20:01:54" }], "totalRecords" : 1 }
การลบแพ็กเกจราคาฉบับร่างโดยใช้ API
หากต้องการลบแพ็กเกจราคาฉบับร่าง ให้ส่งคำขอ "ลบ" ไปยัง
/organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}
โดย {plan_Id}
คือหมายเลขระบุแพ็กเกจราคาที่จะลบ และ
{package_id}
คือตัวระบุแพ็กเกจ API สำหรับแพ็กเกจราคาดังกล่าว เช่น
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \ -u email:password
พร็อพเพอร์ตี้การกำหนดค่าสำหรับแพ็กเกจราคา
เมื่อสร้างแพ็กเกจราคาโดยใช้ API คุณจะระบุการตั้งค่าการกำหนดค่าต่อไปนี้ได้
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
advance |
ใช้ได้สำหรับค่าธรรมเนียมที่เกิดซ้ำเท่านั้น แฟล็กที่ระบุว่ามีการเรียกเก็บค่าธรรมเนียมตามรอบล่วงหน้าหรือไม่ ค่าที่ถูกต้องได้แก่
|
false | ไม่ได้ |
contractDuration |
ระยะเวลาของสัญญาสำหรับแผนร่วมกับ |
ไม่มีข้อมูล | ไม่ได้ |
contractDurationType |
ระยะเวลาของสัญญาสำหรับแผนร่วมกับ
|
ไม่มีข้อมูล | ไม่ได้ |
currency |
สกุลเงินที่ใช้สำหรับแพ็กเกจราคา ระบุรหัส ISO 4217 สำหรับสกุลเงิน เช่น |
ไม่มีข้อมูล | มี |
description |
คำอธิบายของแพ็กเกจราคา |
ไม่มีข้อมูล | มี |
developer |
รหัสนักพัฒนาซอฟต์แวร์ (อีเมล) ระบุสำหรับแพ็กเกจราคาสำหรับนักพัฒนาซอฟต์แวร์เท่านั้น |
ไม่มีข้อมูล | ไม่ได้ |
developerCategory |
รหัสหมวดหมู่นักพัฒนาซอฟต์แวร์ ระบุสำหรับแพ็กเกจราคาหมวดหมู่นักพัฒนาซอฟต์แวร์เท่านั้น |
ไม่มีข้อมูล | ไม่ได้ |
displayName |
ชื่อที่แสดงที่ใช้งานง่ายสำหรับแพ็กเกจราคา |
ไม่มีข้อมูล | มี |
earlyTerminationFee |
ระบบจะเรียกเก็บค่าธรรมเนียมแบบจ่ายครั้งเดียวหากนักพัฒนาแอปสิ้นสุดแพ็กเกจก่อนระยะเวลาการต่ออายุ |
ไม่มีข้อมูล | ไม่ได้ |
endDate |
วันที่แพ็กเกจสิ้นสุดลง นักพัฒนาแอปจะดูแพ็กเกจราคาไม่ได้หลังจากวันที่ดังกล่าว หากไม่ต้องการให้แพ็กเกจราคาสิ้นสุดในวันที่ที่ระบุ ให้ระบุค่า Null สำหรับ แพ็กเกจราคาจะมีผลจนถึงสิ้นสุดวันในวันที่ที่ระบุ ตัวอย่างเช่น หากต้องการให้แพ็กเกจราคาหมดอายุในวันที่ 1 ธันวาคม 2016 คุณควรตั้งค่า endDate เป็น 2016-11-30 ในกรณีนี้ แพ็กเกจราคาจะหมดอายุเมื่อสิ้นสุดวันที่ 30 พฤศจิกายน 2016 และคำขอทั้งหมดในวันที่ 1 ธันวาคม 2016 จะถูกบล็อก หมายเหตุ: เมื่อดูแพ็กเกจราคาโดยใช้ API ระบบจะระบุเวลาประทับของ endDate เป็น |
ไม่มีข้อมูล | ไม่ได้ |
freemiumDuration |
ระยะเวลาของฟรีเมียมร่วมกับ |
ไม่มีข้อมูล | ไม่ได้ |
freemiumDurationType |
ระยะเวลาของฟรีเมียมร่วมกับ
|
ไม่มีข้อมูล | ไม่ได้ |
freemiumUnit |
จำนวนฟรีเมียม ค่าอาจเป็นจำนวนธุรกรรมหรือจำนวนหน่วยที่เกี่ยวข้องกับแอตทริบิวต์ที่กำหนดเองที่บันทึกไว้ในนโยบายการบันทึกธุรกรรม |
ไม่มีข้อมูล | ไม่ได้ |
frequencyDuration |
ใช้ได้สำหรับค่าธรรมเนียมที่เกิดซ้ำเท่านั้น ระยะเวลาระหว่างการเรียกเก็บค่าธรรมเนียมตามรอบกับ |
ไม่มีข้อมูล | ไม่ได้ |
frequencyDurationType |
ใช้ได้สำหรับค่าธรรมเนียมที่เกิดซ้ำเท่านั้น ระยะเวลาระหว่างการเรียกเก็บค่าธรรมเนียมตามรอบกับ frequencyDuration ค่าที่ใช้ได้ ได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
isPrivate |
แจ้งว่าแพ็กเกจราคาเป็นสาธารณะหรือส่วนตัว ค่าเริ่มต้นคือ false (สาธารณะ) ดูข้อมูลเพิ่มเติมได้ที่แพ็กเกจราคาสาธารณะและส่วนตัว |
ไม่มีข้อมูล | ไม่ได้ |
monetizationPackage |
รหัสชุดผลิตภัณฑ์ API สำหรับแพ็กเกจราคา |
ไม่มีข้อมูล | ไม่ได้ |
name |
ชื่อของแพ็กเกจราคา |
ไม่มีข้อมูล | มี |
organization |
รหัสองค์กรสำหรับแพ็กเกจราคา |
ไม่มีข้อมูล | มี |
paymentDueDays |
ใช้ได้สำหรับค่าธรรมเนียมที่เกิดซ้ำเท่านั้น จำนวนวันที่ต้องชำระค่าธรรมเนียม เช่น กำหนดค่าเป็น 30 เพื่อระบุว่าค่าธรรมเนียมจะครบกำหนดชำระใน 30 วัน |
ไม่มีข้อมูล | ไม่ได้ |
proRate |
ใช้ได้สำหรับค่าธรรมเนียมที่เกิดซ้ำเท่านั้น แฟล็กที่ระบุว่าค่าธรรมเนียมที่เกิดซ้ำจะคิดตามสัดส่วนเมื่อนักพัฒนาแอปเริ่มต้นหรือสิ้นสุดแพ็กเกจในช่วง 1 เดือนหรือไม่ ค่าที่ถูกต้องมีดังนี้
|
false | ไม่ได้ |
published |
แฟล็กที่ระบุว่าควรเผยแพร่แพ็กเกจราคาให้นักพัฒนาแอปดูหรือไม่ ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | มี |
ratePlanDetails |
รายละเอียดแพ็กเกจราคา (ดูพร็อพเพอร์ตี้การกำหนดค่าสำหรับรายละเอียดแพ็กเกจราคา) |
ไม่มีข้อมูล | มี |
recurringFee |
ค่าธรรมเนียมที่เรียกเก็บจากนักพัฒนาแอปอย่างต่อเนื่องจนกว่านักพัฒนาซอฟต์แวร์จะสิ้นสุดแพ็กเกจ |
ไม่มีข้อมูล | ไม่ได้ |
recurringStartUnit |
ใช้ได้เมื่อตั้งค่า |
ไม่มีข้อมูล | ไม่ได้ |
recurringType |
กำหนดชำระค่าธรรมเนียมตามรอบ ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
setUpFee |
ค่าธรรมเนียมที่เรียกเก็บเพียงครั้งเดียวจะเรียกเก็บจากนักพัฒนาแอปแต่ละรายในวันที่เริ่มต้นของแพ็กเกจ (ซึ่งก็คือวันที่ที่นักพัฒนาแอปซื้อแพ็กเกจ) |
ไม่มีข้อมูล | ไม่ได้ |
startDate |
วันที่ที่เริ่มใช้แผน นักพัฒนาแอปจะดูแพ็กเกจราคาได้ตั้งแต่วันที่นี้เป็นต้นไป |
ไม่มีข้อมูล | มี |
type |
ประเภทแพ็กเกจราคา ระบุข้อใดข้อหนึ่งต่อไปนี้
|
ไม่มีข้อมูล | มี |
พร็อพเพอร์ตี้การกำหนดค่าสำหรับรายละเอียดแพ็กเกจราคา
คุณระบุพร็อกซีการกำหนดค่าใดก็ได้ต่อไปนี้เป็นส่วนหนึ่งของอาร์เรย์ ratePlanDetails
เมื่อสร้างแพ็กเกจราคา
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
aggregateFreemiumCounters |
แฟล็กที่ระบุว่าจะเปิดใช้ตัวนับแบบรวมหรือไม่ เพื่อดูว่าการใช้งานผลิตภัณฑ์ API อยู่ในช่วงฟรีหรือไม่ ต้องเปิดใช้ตัวนับรวมเพื่อตั้งค่าแพ็กเกจฟรีเมียมสำหรับผลิตภัณฑ์ ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
aggregateStandardCounters |
แฟล็กที่ระบุว่าจะใช้ตัวนับแบบรวมเพื่อกำหนดช่วงการใช้งานหรือไม่ (เช่น แถบระดับเสียงสำหรับแพ็กเกจเรตการ์ด ค่าอาจเป็นค่าใดค่าหนึ่งต่อไปนี้
|
ไม่มีข้อมูล | ไม่ได้ |
aggregateTransactions |
หมายเหตุ: ปัจจุบันการสร้างรายได้ไม่ได้ใช้พร็อพเพอร์ตี้นี้และละเว้นได้ |
จริง | ไม่ได้ |
currency |
สกุลเงิน |
ไม่มีข้อมูล | ไม่ได้ |
duration |
ระยะเวลาของความถี่ในการคํานวณร่วมกับ เช่น ตั้งค่า |
ไม่มีข้อมูล | ไม่ได้ |
durationType |
ระยะเวลาของความถี่ในการคำนวณ พร้อมกับ ดูตัวอย่างการใช้งานได้ที่ |
ไม่มีข้อมูล | ไม่ได้ |
freemiumDuration |
ระยะเวลาสำหรับช่วงฟรีเมียมของผลิตภัณฑ์ API แต่ละรายการร่วมกับ |
ไม่มีข้อมูล | ไม่ได้ |
freemiumDurationType |
ระยะเวลาสำหรับช่วงฟรีเมียมของผลิตภัณฑ์ API แต่ละรายการร่วมกับ
ตัวอย่างเช่น หากต้องการระบุว่าระยะเวลาฟรีเมียมของผลิตภัณฑ์ API คือ 30 วัน ให้ตั้งค่า |
ไม่มีข้อมูล | ไม่ได้ |
freemiumUnit |
จำนวน Freemium สำหรับผลิตภัณฑ์ API ค่าอาจเป็นจำนวนธุรกรรมหรือจำนวนหน่วยที่เกี่ยวข้องกับแอตทริบิวต์ที่กำหนดเองที่บันทึกไว้ในนโยบายการบันทึกธุรกรรม |
ไม่มีข้อมูล | ไม่ได้ |
meteringType |
รูปแบบการเรียกเก็บเงินสำหรับแพ็กเกจเรตการ์ด ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ใช่ |
organization |
รหัสองค์กร |
ไม่มีข้อมูล | ไม่ได้ |
paymentDueDays |
วันที่ครบกำหนดชำระเงินสำหรับนักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง ตัวอย่างเช่น ตั้งค่าเป็น 30 เพื่อระบุว่าการชำระเงินจะครบกำหนดชำระใน 30 วัน |
ไม่มีข้อมูล | ไม่ได้ |
product |
ข้อมูลผลิตภัณฑ์ API เช่น รหัส |
ไม่มีข้อมูล | ไม่ได้ |
ratePlanRates |
รายละเอียดอัตราแพ็กเกจราคา เช่น ประเภทแพ็กเกจราคา ( |
ไม่มีข้อมูล | มี |
ratingParameter |
เกณฑ์พื้นฐานสำหรับแพ็กเกจราคา แพ็กเกจราคาอิงตามธุรกรรมหรือแอตทริบิวต์ที่กำหนดเอง ค่าที่ถูกต้องได้แก่
|
VOLUME |
มี |
ratingParameterUnit |
หน่วยที่ใช้กับ |
ไม่มีข้อมูล | มี |
revenueType |
พื้นฐานของส่วนแบ่งรายได้ในแผนส่วนแบ่งรายได้ ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
type |
ประเภทแพ็กเกจราคา ค่าที่ถูกต้องได้แก่
โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับประเภทแพ็กเกจราคาที่หัวข้อประเภทแพ็กเกจราคาที่รองรับ |
ไม่มีข้อมูล | มี |