คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เกริ่นนำ
รายงานการสร้างรายได้ช่วยให้คุณสามารถเข้าถึงข้อมูลการใช้งานที่เน้นกิจกรรมและการทำธุรกรรม ตัวอย่างเช่น คุณอาจระบุได้ว่าแอปพลิเคชัน นักพัฒนาซอฟต์แวร์ กลุ่มผลิตภัณฑ์ API หรือผลิตภัณฑ์ API ใดมีกิจกรรมธุรกรรมในช่วงวันที่ที่ระบุ คุณสร้างรายงานสรุปหรือรายงานแบบละเอียดที่ติดตามการใช้งาน API ได้ด้วยการสร้างรายได้
ประเภทของรายงานการสร้างรายได้
คุณสามารถสร้างรายงานการสร้างรายได้ประเภทต่อไปนี้
รายงาน | คำอธิบาย |
---|---|
การเรียกเก็บเงิน | ดูกิจกรรมของนักพัฒนาแอปสำหรับเดือนเรียกเก็บเงิน 1 เดือนและยืนยันว่ามีการใช้แพ็กเกจราคาอย่างถูกต้อง |
ยอดคงเหลือที่ชำระล่วงหน้า | ดูการเติมเงินที่นักพัฒนาแอปแบบชำระล่วงหน้าดำเนินการในเดือนสำหรับการเรียกเก็บเงินหรือในเดือนที่เปิดอยู่ในปัจจุบัน เพื่อให้คุณสามารถปรับยอดการชำระเงินที่ได้รับจากผู้ประมวลผลการชำระเงินของคุณได้ |
รายได้ | ดูกิจกรรมและรายได้ที่นักพัฒนาซอฟต์แวร์สร้างขึ้นภายในช่วงวันที่ เพื่อให้คุณวิเคราะห์ประสิทธิภาพของกลุ่มผลิตภัณฑ์ API และผลิตภัณฑ์สำหรับนักพัฒนาซอฟต์แวร์ (และแอปพลิเคชันของพวกเขา) ได้ |
ความแปรปรวน |
เปรียบเทียบกิจกรรมและรายได้ที่เกิดจากนักพัฒนาซอฟต์แวร์ในช่วงวันที่ 2 ช่วง เพื่อให้คุณวิเคราะห์แนวโน้มที่สูงขึ้นหรือต่ำลงในประสิทธิภาพของแพ็กเกจ API และผลิตภัณฑ์สำหรับนักพัฒนาซอฟต์แวร์ (และแอปพลิเคชัน) ได้ |
เกี่ยวกับการเก็บรักษาข้อมูล
ในระบบคลาวด์สาธารณะของ Apigee Edge การเก็บรักษาข้อมูลการสร้างรายได้เป็นสิทธิ์ของแผน ดูการให้สิทธิ์การสร้างรายได้ที่ https://cloud.google.com/apigee/specsheets โปรดติดต่อฝ่ายขาย Apigee หากต้องการเก็บข้อมูลการสร้างรายได้ไว้เกินระยะเวลาการให้สิทธิ์ ระบบจะเปิดใช้งานการเก็บรักษาข้อมูลแบบขยาย ณ เวลาที่ขอ และจะไม่สามารถเปิดใช้งานย้อนหลังเพื่อรวมข้อมูลไว้ก่อนกรอบเวลาการเก็บรักษาข้อมูลเดิมได้
การสำรวจหน้ารายงานการสร้างรายได้
เข้าถึงหน้ารายงานการสร้างรายได้ตามที่อธิบายไว้ด้านล่าง
Edge
วิธีเข้าถึงหน้ารายงานโดยใช้ Edge UI
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > รายงานในแถบนำทางด้านซ้าย
หน้ารายงานจะปรากฏขึ้น
ตามที่ไฮไลต์ในรูป หน้ารายงานช่วยให้คุณทําสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของรายงานทั้งหมด ได้แก่ ชื่อและคำอธิบาย ประเภทรายงานและช่วงวันที่ และวันที่แก้ไขล่าสุด
- กำหนดค่ารายงาน
- สร้างและดาวน์โหลดรายงานในรูปแบบไฟล์ CSV หรือ ZIP
- แก้ไขรายงาน
- ลบรายงาน
- ค้นหารายการของรายงาน
Classic Edge (Private Cloud)
วิธีเข้าถึงหน้ารายงานโดยใช้ UI แบบคลาสสิกของ Edge
- ลงชื่อเข้าใช้
http://ms-ip:9000
โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ - เลือกการสร้างรายได้ > รายงานการสร้างรายได้ในแถบนำทางด้านบน
หน้ารายงานจะปรากฏขึ้น
- ดูรายการรายงานปัจจุบัน
- กำหนดค่ารายงาน
- สร้างและดาวน์โหลดรายงานในรูปแบบ CSV
- แก้ไขรายงาน
- ลบรายงาน
การกำหนดค่ารายงาน
กำหนดค่ารายงานโดยใช้ UI ตามที่อธิบายไว้ในส่วนต่อไปนี้
ขั้นตอนการกำหนดค่ารายงาน
กำหนดค่ารายงานโดยใช้ Edge UI หรือ UI ของ Edge แบบคลาสสิก
Edge
วิธีกำหนดค่ารายงานโดยใช้ Edge UI
- เลือกเผยแพร่ > การสร้างรายได้ > รายงานในแถบนำทางด้านซ้าย
- คลิก + รายงาน
- กําหนดค่ารายละเอียดรายงานที่ระบุไว้ในตารางต่อไปนี้
ฟิลด์ คำอธิบาย ชื่อ ชื่อที่ไม่ซ้ำกันของรายงาน คำอธิบาย คำอธิบายของรายงาน ประเภทรายงาน ดูประเภทของรายงานการสร้างรายได้ - กําหนดค่ารายละเอียดรายงานที่เหลือตามประเภทรายงานที่เลือก ตามที่อธิบายในส่วนต่อไปนี้
- หลังจากป้อนข้อมูลในหน้าต่างรายงานแล้ว คุณจะทำสิ่งต่อไปนี้ได้
- คลิกบันทึกรายงานเพื่อบันทึกการกําหนดค่ารายงาน
หากต้องการรายงานแบบละเอียดเท่านั้น ให้คลิกส่งงานเพื่อเรียกใช้รายงานแบบไม่พร้อมกันและเรียกดูผลลัพธ์ในภายหลัง ดูการสร้างและการดาวน์โหลดรายงานสำหรับข้อมูลเพิ่มเติม
- คลิกบันทึกเป็น CSV หรือบันทึกเป็น Zip เพื่อดาวน์โหลดรายงานที่สร้างขึ้นลงในเครื่องของคุณในรูปแบบค่าที่คั่นด้วยคอมมา (CSV) หรือไฟล์ ZIP ที่บีบอัดซึ่งมี CSV แนะนำให้ใช้การดาวน์โหลดแบบ Zip สำหรับรายงานขนาดใหญ่และจะดาวน์โหลดได้อย่างมีประสิทธิภาพมากขึ้น
Classic Edge (Private Cloud)
วิธีสร้างรายงานโดยใช้ UI แบบคลาสสิกของ Edge
- เลือกการสร้างรายได้ > รายงานการสร้างรายได้ในแถบนำทางด้านบน
- ในเมนูแบบเลื่อนลง ให้เลือกประเภทของรายงานที่คุณต้องการสร้าง ดูประเภทของรายงานการสร้างรายได้
- คลิก + รายงาน
- กำหนดค่ารายละเอียดของรายงานตามประเภทการเรียกเก็บเงินที่เลือก ตามที่อธิบายในส่วนต่อไปนี้
- หลังจากป้อนข้อมูลในหน้าต่างรายงานแล้ว คุณจะทำสิ่งต่อไปนี้ได้
- คลิกบันทึกเป็น ... เพื่อบันทึกการกำหนดค่ารายงานและดาวน์โหลดรายงานในภายหลัง
สำหรับรายงานโดยละเอียดเท่านั้น ให้คลิกส่งงานเพื่อเรียกใช้รายงานตามลำดับเวลา และเรียกดูผลลัพธ์ในภายหลัง ดูการสร้างและการดาวน์โหลดรายงานสำหรับข้อมูลเพิ่มเติม
- คลิกดาวน์โหลด CSV เพื่อสร้างและดาวน์โหลดรายงานไปยังเครื่องของคุณในรูปแบบไฟล์ค่าที่คั่นด้วยคอมมา (CSV) เพื่อดู
การกำหนดค่ารายงานการเรียกเก็บเงิน
ทำตามขั้นตอนการกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน
ฟิลด์ | คำอธิบาย |
---|---|
เดือนที่เรียกเก็บเงิน |
เดือนที่เรียกเก็บเงินสำหรับรายงาน |
ระดับการรายงาน |
ระดับการรายงาน ค่าที่ถูกต้องได้แก่
|
ชุดผลิตภัณฑ์ |
หมายเหตุ: ใน UI ของ Edge แบบคลาสสิก กลุ่มผลิตภัณฑ์ API จะเรียกว่าแพ็กเกจ API เลือกชุดผลิตภัณฑ์ API ที่จะรวมไว้ในรายงาน หากไม่เลือกไว้ กลุ่มผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน รายงานจะมีบรรทัดแยกต่างหากสำหรับกลุ่มผลิตภัณฑ์ API ที่เลือกแต่ละกลุ่ม สำหรับรายงานสรุป คุณเลือกไม่แสดงในตัวเลือกการแสดงผลสรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากแพ็กเกจผลิตภัณฑ์ API ทั้งหมด (หรือที่เลือกไว้) (และไม่แสดงข้อมูลสำหรับกลุ่มผลิตภัณฑ์ API แต่ละกลุ่มแยกกัน) |
ผลิตภัณฑ์ |
เลือกผลิตภัณฑ์ API ที่จะรวมไว้ในรายงาน หากไม่เลือกรายการใด ผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน รายงานจะมีบรรทัดแยกต่างหากสําหรับผลิตภัณฑ์ API ที่เลือกแต่ละรายการ สำหรับรายงานสรุป คุณเลือกไม่แสดงในตัวเลือกการแสดงผลสรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลของนักพัฒนาแอปทั้งหมด (หรือนักพัฒนาแอปบางราย) (แต่ไม่รวมข้อมูลของนักพัฒนาแอปที่เลือกแต่ละรายแยกกัน) |
บริษัท | เลือกบริษัทที่จะรวมไว้ในรายงาน หากไม่เลือกรายการใดเลย ทุกบริษัทจะรวมอยู่ในรายงาน |
แพ็กเกจราคา |
แพ็กเกจราคาที่จะรวมไว้ในรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
|
การกำหนดค่ารายงานยอดคงเหลือชำระล่วงหน้า
ทำตามขั้นตอนการกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงานฟิลด์ | คำอธิบาย |
---|---|
เดือนที่เรียกเก็บเงิน |
เดือนที่เรียกเก็บเงินสำหรับรายงาน |
ระดับการรายงาน |
ระดับการรายงาน ค่าที่ถูกต้องได้แก่
|
บริษัท | เลือกบริษัทที่จะรวมไว้ในรายงาน หากไม่เลือกรายการใดเลย ทุกบริษัทจะรวมอยู่ในรายงาน |
การกำหนดค่ารายงานรายได้
ทำตามขั้นตอนการกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน
ฟิลด์ | คำอธิบาย |
---|---|
ช่วงวันที่ |
ช่วงวันที่สำหรับรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
|
เลือกสกุลเงิน |
สกุลเงินสำหรับรายงาน ค่าที่ถูกต้องได้แก่
|
ระดับการรายงาน |
ระดับการรายงาน ค่าที่ถูกต้องได้แก่
|
ชุดผลิตภัณฑ์ |
หมายเหตุ: ใน UI ของ Edge แบบคลาสสิก กลุ่มผลิตภัณฑ์ API จะเรียกว่าแพ็กเกจ API เลือกชุดผลิตภัณฑ์ API ที่จะรวมไว้ในรายงาน หากไม่เลือกไว้ กลุ่มผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน รายงานจะมีบรรทัดแยกต่างหากสำหรับกลุ่มผลิตภัณฑ์ API ที่เลือกแต่ละกลุ่ม สำหรับรายงานสรุป คุณเลือกไม่แสดงในตัวเลือกการแสดงผลสรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากแพ็กเกจผลิตภัณฑ์ API ทั้งหมด (หรือที่เลือกไว้) (และไม่แสดงข้อมูลสำหรับกลุ่มผลิตภัณฑ์ API แต่ละกลุ่มแยกกัน) |
ผลิตภัณฑ์ |
เลือกผลิตภัณฑ์ API ที่จะรวมไว้ในรายงาน หากไม่เลือกรายการใด ผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน รายงานจะมีบรรทัดแยกต่างหากสําหรับผลิตภัณฑ์ API ที่เลือกแต่ละรายการ สำหรับรายงานสรุป คุณเลือกไม่แสดงในตัวเลือกการแสดงผลสรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลของนักพัฒนาแอปทั้งหมด (หรือนักพัฒนาแอปบางราย) (แต่ไม่รวมข้อมูลของนักพัฒนาแอปที่เลือกแต่ละรายแยกกัน) |
บริษัท | เลือกบริษัทที่จะรวมไว้ในรายงาน หากไม่เลือกรายการใดเลย ทุกบริษัทจะรวมอยู่ในรายงาน สำหรับรายงานสรุป คุณเลือกไม่แสดงในส่วนตัวเลือกการแสดงสรุปได้ หากต้องการ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากบริษัททั้งหมด (หรือบริษัทที่เลือก) (และไม่ได้แสดงข้อมูลสำหรับแต่ละบริษัทที่เลือกแยกกัน) |
แอป |
เลือกแอปพลิเคชันที่จะรวมในรายงาน หากไม่เลือกรายการใดเลย แอปพลิเคชันทั้งหมดจะรวมอยู่ในรายงาน รายงานจะมีบรรทัดแยกต่างหากสําหรับแต่ละแอปพลิเคชันที่เลือก สำหรับรายงานสรุป คุณเลือกไม่แสดงในส่วนตัวเลือกการแสดงสรุปได้ หากต้องการ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากแอปพลิเคชันทั้งหมด (หรือที่เลือกไว้) (และไม่แสดงข้อมูลสำหรับแอปพลิเคชันที่เลือกแต่ละรายการแยกกัน) |
ตัวเลือกการแสดงสรุป |
ลำดับในการจัดกลุ่มคอลัมน์และแสดงในรายงาน เลือกตัวเลขที่ระบุลำดับสัมพัทธ์ของส่วนนั้นในการจัดกลุ่ม (1 คือการจัดกลุ่มแรก) ตัวอย่างเช่น กลุ่มต่อไปนี้จะจัดกลุ่มรายงานตามแพ็กเกจก่อน ตามด้วยผลิตภัณฑ์ แล้วตามแอปพลิเคชัน หากคุณไม่ต้องการแสดงหัวข้อ ให้เลือกไม่ต้องแสดง และเลือกช่องที่เหลือตามลำดับ ลำดับจะอัปเดตโดยอัตโนมัติเมื่อคุณเปลี่ยนลำดับที่เกี่ยวข้องของส่วนหนึ่งหรือเลือกที่จะไม่แสดงส่วนในรายงาน |
การรวมแอตทริบิวต์ธุรกรรมที่กำหนดเองไว้ในรายงานสรุปรายได้
นโยบายการบันทึกธุรกรรมช่วยให้คุณบันทึกข้อมูลแอตทริบิวต์ที่กำหนดเองจากธุรกรรมได้ และคุณรวมแอตทริบิวต์ที่กำหนดเองเหล่านั้นไว้ในรายงานสรุปรายได้ได้ด้วย กำหนดชุดแอตทริบิวต์ที่กำหนดเองเริ่มต้นที่รวมอยู่ในตารางฐานข้อมูลการสร้างรายได้โดยการตั้งค่าพร็อพเพอร์ตี้ MINT.SUMMARY_CUSTOM_ATTRIBUTES
สำหรับองค์กร
การใช้ฟีเจอร์นี้จะต้องใช้การพิจารณาและการวางแผนอย่างรอบคอบ ดังนั้นโปรดอ่านข้อควรพิจารณาด้านล่าง
หากคุณเป็นลูกค้าระบบคลาวด์ โปรดติดต่อฝ่ายสนับสนุนของ Apigee Edge เพื่อตั้งค่าพร็อพเพอร์ตี้ หากคุณเป็น Apigee Edge สำหรับลูกค้า Private Cloud ให้ตั้งค่าแฟล็กโดยใช้คำขอ PUT ไปยัง API ต่อไปนี้ด้วยข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ
curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \ "<Organization type="trial" name="MyOrganization"> <Properties> <Property name="features.isMonetizationEnabled">true</Property> <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">["partner_id","tax_source"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
ในตัวอย่างนี้ การเรียก API จะเปิดใช้ฟีเจอร์นี้และเพิ่มคอลัมน์ partner_id
และ tax_source
ลงในฐานข้อมูลการสร้างรายได้ โปรดทราบว่าอาร์เรย์ของแอตทริบิวต์ที่กำหนดเองในการเรียก API มีการเข้ารหัส URL
ข้อควรพิจารณาสำหรับการระบุแอตทริบิวต์ธุรกรรมที่กำหนดเองในรายงาน
- ตั้งชื่อแอตทริบิวต์ให้ชัดเจนก่อนที่จะสร้างด้วย API ชื่อเหล่านี้คือชื่อคอลัมน์ในฐานข้อมูล และระบบจะจัดเก็บข้อมูลแอตทริบิวต์ที่กำหนดเองไว้ในฐานข้อมูลเสมอ
- มีช่องแอตทริบิวต์ที่กำหนดเองที่ใช้ได้ 10 ช่องในนโยบายการบันทึกธุรกรรมแต่ละรายการดังที่แสดงในรูปภาพต่อไปนี้ ใช้ชื่อแอตทริบิวต์และตำแหน่งเดียวกันสำหรับแอตทริบิวต์เดียวกันในผลิตภัณฑ์ต่างๆ ที่จะรวมไว้ในรายงาน เช่น ในนโยบายการบันทึกธุรกรรมต่อไปนี้ แอตทริบิวต์ที่กำหนดเอง
partner_id
และtax_source
จะใช้ช่อง 4 และ 5 ตามลำดับ ควรเป็นชื่อและตําแหน่งของแบรนด์ในนโยบายการบันทึกธุรกรรมทั้งหมดสําหรับผลิตภัณฑ์ที่จะรวมไว้ในการรายงาน
หากต้องการใส่แอตทริบิวต์ที่กำหนดเองในรายงานสรุปรายได้หลังจากเปิดใช้ฟีเจอร์แล้ว ให้ใช้ API การรายงานโดยการเพิ่ม transactionCustomAttributes
ลงใน MintCriteria
โปรดดูตัวเลือกการกำหนดค่าเกณฑ์
การกำหนดค่ารายงานความแปรปรวน (เลิกใช้แล้ว)
ทำตามขั้นตอนการกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน
ฟิลด์ | คำอธิบาย |
---|---|
ช่วงวันที่ |
ช่วงวันที่สำหรับรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
|
กล่องพัสดุ |
แพ็กเกจ API ที่จะรวมในรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
รายงานจะมีบรรทัดแยกกันสําหรับแพ็กเกจ API ที่เลือกแต่ละรายการ สำหรับรายงานสรุป คุณเลือกไม่แสดง (แพ็กเกจ) ได้ในส่วน ตัวเลือกการแสดงข้อมูลสรุป ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากแพ็กเกจ API ทั้งหมด (หรือที่เลือกไว้) (และไม่แสดงข้อมูลสำหรับแพ็กเกจ API แต่ละรายการแยกกัน) |
ผลิตภัณฑ์ |
ผลิตภัณฑ์ API ที่จะรวมในรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
รายงานจะมีบรรทัดแยกต่างหากสําหรับผลิตภัณฑ์ API ที่เลือกแต่ละรายการ สำหรับรายงานสรุป คุณเลือกไม่แสดง "ไม่แสดง (ผลิตภัณฑ์)" ในส่วน "ตัวเลือกการแสดงผล" สรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากผลิตภัณฑ์ API ทั้งหมด (หรือที่เลือกไว้) (แต่ไม่แสดงข้อมูลสำหรับผลิตภัณฑ์ API แต่ละรายการแยกกัน) |
บริษัท |
บริษัทที่จะรวมในรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
รายงานจะมีบรรทัดแยกต่างหากสําหรับแต่ละบริษัทที่เลือก สำหรับรายงานสรุป คุณเลือกไม่แสดง (บริษัท) ได้ในส่วน ตัวเลือกการแสดงผลสรุป ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากบริษัททั้งหมด (หรือบริษัทที่เลือก) (และจะไม่แสดงข้อมูลสำหรับแต่ละบริษัทที่เลือกแยกกัน) |
แอป |
แอปพลิเคชันที่จะรวมในรายงาน โปรดเลือกตัวเลือกต่อไปนี้เพียงตัวเลือกเดียว
รายงานจะมีบรรทัดแยกต่างหากสําหรับแต่ละแอปพลิเคชันที่เลือก สำหรับรายงานสรุป คุณสามารถเลือก "ไม่แสดง (แอปพลิเคชัน)" ในส่วน ตัวเลือกการแสดงผลสรุปได้ ในกรณีนี้ รายงานจะรวบรวมข้อมูลจากแอปพลิเคชันทั้งหมด (หรือที่เลือกไว้) (และไม่แสดงข้อมูลสำหรับแอปพลิเคชันที่เลือกแต่ละรายการแยกกัน) |
สกุลเงิน |
สกุลเงินสำหรับรายงาน ค่าที่ถูกต้องได้แก่
|
ตัวเลือกการแสดงสรุป |
ลำดับในการจัดกลุ่มคอลัมน์และแสดงในรายงาน เลือกตัวเลขที่ระบุลำดับสัมพัทธ์ของส่วนนั้นในการจัดกลุ่ม (1 คือการจัดกลุ่มแรก) ตัวอย่างเช่น กลุ่มต่อไปนี้จะจัดกลุ่มรายงานตามแพ็กเกจก่อน ตามด้วยผลิตภัณฑ์ แล้วตามแอปพลิเคชัน หากคุณไม่ต้องการแสดงหัวข้อ ให้เลือกไม่ต้องแสดง และเลือกช่องที่เหลือตามลำดับ ลำดับจะอัปเดตโดยอัตโนมัติเมื่อคุณเปลี่ยนลำดับที่เกี่ยวข้องของส่วนหนึ่งหรือเลือกที่จะไม่แสดงส่วนในรายงาน |
การสร้างและการดาวน์โหลดรายงาน
หลังจากที่สร้างรายงานแล้ว คุณจะดาวน์โหลดผลลัพธ์ของรายงานในรูปแบบไฟล์ CSV หรือ ZIP ได้ คุณสามารถสร้างไฟล์ CSV หรือ ZIP ได้แบบซิงโครนัสหรืออะซิงโครนัส
สำหรับรายงานแบบซิงโครนัส คุณเรียกใช้คำขอรายงานและระบบจะบล็อกคำขอจนกว่าเซิร์ฟเวอร์การวิเคราะห์จะตอบกลับ อย่างไรก็ตาม เนื่องจากรายงานอาจต้องประมวลผลข้อมูลจำนวนมาก (เช่น 100 GB) รายงานแบบพร้อมกันอาจล้มเหลวเนื่องจากหมดเวลา
ระดับรายงานสรุปรองรับเฉพาะการสร้างพร้อมกันเท่านั้น
สำหรับรายงานแบบไม่พร้อมกัน คุณเรียกใช้รายงานและดึงผลลัพธ์ในภายหลังได้ สถานการณ์ที่ควรใช้การประมวลผลการค้นหาแบบอะซิงโครนัสมีดังนี้
- การวิเคราะห์และสร้างรายงานที่ครอบคลุมช่วงเวลาขนาดใหญ่
- การวิเคราะห์ข้อมูลด้วยมิติข้อมูลการจัดกลุ่มที่หลากหลายและข้อจำกัดอื่นๆ ที่เพิ่มความซับซ้อนให้กับการสืบค้นข้อมูล
- จัดการการค้นหาเมื่อพบว่าปริมาณข้อมูลเพิ่มขึ้นอย่างมากสำหรับผู้ใช้หรือองค์กรบางราย
ระดับรายงานแบบละเอียดรองรับการสร้างแบบไม่พร้อมกัน
หากต้องการสร้างและดาวน์โหลดรายงานในรูปแบบไฟล์ CSV หรือ ZIP ให้ดำเนินการอย่างใดอย่างหนึ่งต่อไปนี้
- เข้าถึงหน้ารายงาน
- วางเคอร์เซอร์ไว้เหนือรายงานที่ต้องการดาวน์โหลด
ใต้คอลัมน์แก้ไข ให้คลิกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
- ไอคอน หรือไอคอน (สำหรับรายงานสรุป) รายงานจะบันทึกเป็นไฟล์ CSV หรือ ZIP แบบพร้อมกัน
- ส่งงาน (สำหรับรายงานโดยละเอียด) งานแบบอะซิงโครนัสจะเริ่มต้น
ตรวจสอบสถานะของงานในคอลัมน์แก้ไข
ไอคอนดิสก์จะปรากฏขึ้นเมื่อรายงานพร้อมให้ดาวน์โหลด:
- หลังจากที่งานเสร็จสิ้นแล้ว ให้คลิกไอคอนดิสก์เพื่อดาวน์โหลดรายงาน
ข้อมูลต่อไปนี้ให้ตัวอย่างของไฟล์ CSV สำหรับรายงานสรุปการเรียกเก็บเงิน
การแก้ไขรายงาน
วิธีแก้ไขรายงาน
- เข้าถึงหน้ารายงาน
- วางเคอร์เซอร์ไว้เหนือรายงานที่ต้องการแก้ไข แล้วคลิก ในเมนูการทำงาน
- อัปเดตการกำหนดค่ารายงานตามที่จำเป็น
- คลิกอัปเดตรายงานเพื่อบันทึกการกําหนดค่ารายงานที่อัปเดต
การลบรายงาน
วิธีลบรายงาน
- เข้าถึงหน้ารายงาน
- วางเคอร์เซอร์ไว้เหนือรายงานที่ต้องการลบ
- คลิก ในเมนูการทํางาน
การจัดการรายงานการสร้างรายได้โดยใช้ API
ส่วนต่อไปนี้จะอธิบายวิธีจัดการรายงานการสร้างรายได้โดยใช้ API
การกำหนดค่ารายงานโดยใช้ API
หากต้องการกำหนดค่ารายงานสำหรับทั้งองค์กร ให้ส่งคำขอ POST ไปที่ /organizations/{org_name}/report-definitions
หากต้องการกำหนดค่ารายงานสำหรับนักพัฒนาซอฟต์แวร์ที่เจาะจง ให้ส่งคำขอ POST ไปยัง /organizations/{org_name}/developers/{dev_id}/report-definitions
โดยที่ {dev_id}
คือตัวระบุของนักพัฒนาแอป
เมื่อคุณส่งคำขอ คุณต้องระบุชื่อและประเภทของรายงาน ประเภทเป็นอย่างใดอย่างหนึ่งต่อไปนี้ BILLING
, REVENUE
, VARIANCE
(เลิกใช้งานแล้ว) หรือ PREPAID_BALANCE
นอกจากนี้ คุณยังระบุเกณฑ์ในพร็อพเพอร์ตี้ mintCriteria
ที่กำหนดค่ารายงานเพิ่มเติมได้ด้วย มีเกณฑ์มากมายที่คุณระบุได้ วิธีนี้ช่วยให้คุณกำหนดค่ารายงานได้อย่างยืดหยุ่นอย่างมาก
ต่อไปนี้เป็นตัวอย่างสิ่งที่คุณสามารถระบุเป็นเกณฑ์ได้
- สำหรับรายงานการเรียกเก็บเงินหรือยอดเติมเงิน เดือนที่เรียกเก็บเงินสำหรับรายงาน
- สำหรับรายงานรายได้ ประเภทธุรกรรมที่ครอบคลุมในรายงาน เช่น ธุรกรรมการซื้อ การเรียกเก็บเงินธุรกรรม และการคืนเงิน
- สำหรับรายงานยอดคงเหลือชำระล่วงหน้า นักพัฒนาซอฟต์แวร์ที่เป็นเจ้าของรายงาน
- สำหรับรายงานรายได้ จะมีการใช้แพ็กเกจผลิตภัณฑ์ API (หรือแพ็กเกจ API), ผลิตภัณฑ์, แพ็กเกจราคา และแอปพลิเคชันที่จะใช้รายงาน
- สำหรับรายงานรายได้หรือความแปรปรวน สกุลเงินที่ใช้ในรายงาน
- สำหรับการเรียกเก็บเงิน ยอดเงินชำระล่วงหน้า หรือรายงานรายได้ ไม่ว่ารายงานจะเป็นรายงานสรุปหรือรายงานแบบละเอียด
- สำหรับรายงานสรุปรายได้ ให้ใส่แอตทริบิวต์ธุรกรรมที่กำหนดเองในรายงาน
โปรดดูตัวเลือกการกำหนดค่ารายงานสำหรับรายการเกณฑ์รายงานทั้งหมด
ตัวอย่างต่อไปนี้สร้างรายงานรายได้ที่สรุปกิจกรรมการทำธุรกรรมสำหรับเดือนกรกฎาคม 2015 รายงานนี้มีธุรกรรมหลายประเภทที่ระบุไว้ในพร็อพเพอร์ตี้ transactionTypes
และมีผลกับกลุ่มผลิตภัณฑ์ Payment API และผลิตภัณฑ์ Payment API โดยเฉพาะ เนื่องจากไม่มีการระบุนักพัฒนาซอฟต์แวร์หรือแอปพลิเคชันที่เฉพาะเจาะจงในคำจำกัดความของรายงาน รายงานนี้จึงมีผลกับนักพัฒนาซอฟต์แวร์และแอปพลิเคชันทั้งหมด และเนื่องจากพร็อพเพอร์ตี้ currencyOption
ตั้งค่าเป็น LOCAL
รายงานแต่ละบรรทัดจะแสดงโดยใช้สกุลเงินของแพ็กเกจราคาที่เกี่ยวข้อง นอกจากนี้ พร็อพเพอร์ตี้ groupBy
ยังระบุว่าคอลัมน์ในรายงานจะจัดกลุ่มตามลำดับต่อไปนี้ PACKAGE, PRODUCT, DEVELOPER, APPLICATION และ RATEPLAN (รวมถึงชื่อและรหัสแพ็กเกจราคาในรายงาน)
$ curl -H "Content-Type: application/json" -X POST -d \ '{ "name": "July 2015 revenue report", "description": " July 2015 revenue report for Payment product", "type": "REVENUE", "mintCriteria":{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "monetizationPackageIds":[ "payment" ], "productIds":[ "payment" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ] } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \ -u email:password
ข้อมูลต่อไปนี้จะสร้างรายงานการเรียกเก็บเงินโดยละเอียดที่แสดงกิจกรรมของนักพัฒนาซอฟต์แวร์ DEV FIVE ในเดือนมิถุนายน 2015
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":true, "showSummary":false, "currencyOption":"LOCAL" }, "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"myorg"}] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \ -u email:password
การดูการกำหนดค่ารายงานโดยใช้ API
คุณสามารถดูการกำหนดค่ารายงานที่ต้องการหรือการกำหนดค่ารายงานทั้งหมดสำหรับองค์กรได้ คุณยังดูการกำหนดค่ารายงานของนักพัฒนาแอปแต่ละรายได้ด้วย
หากต้องการดูการกำหนดค่ารายงานที่เจาะจงสำหรับองค์กร ให้ส่งคำขอ GET ไปยัง
/organizations/{org_name}/report-definitions/{report_definition_id}
โดยที่
{report_definition_id}
คือตัวระบุการกำหนดค่ารายงานที่เจาะจง (รหัส
จะแสดงผลในการตอบสนองเมื่อคุณสร้างการกำหนดค่ารายงาน) เช่น
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \ -u email:password
หากต้องการดูการกำหนดค่ารายงานทั้งหมดสำหรับองค์กร ให้ส่งคำขอ GET ไปยัง
/organizations/{org_name}/report-definitions
คุณส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองและจัดเรียงผลการค้นหาได้
พารามิเตอร์การค้นหา | คำอธิบาย |
---|---|
all |
แฟล็กที่ระบุว่าจะส่งคืนแพ็กเกจผลิตภัณฑ์ API ทั้งหมดหรือไม่ หากตั้งค่าเป็น false พารามิเตอร์การค้นหาของ size จะเป็นตัวกำหนดจำนวนแพ็กเกจผลิตภัณฑ์ API ที่แสดงผลในแต่ละหน้า ค่าเริ่มต้นคือ false |
size |
จำนวนกลุ่มผลิตภัณฑ์ API ที่ส่งคืนต่อหน้า ค่าเริ่มต้นคือ 20 หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ |
page |
จำนวนหน้าที่ต้องการแสดงผล (หากเนื้อหามีการใส่เลขหน้า) หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะละเว้นพารามิเตอร์นี้ |
sort |
ฟิลด์สำหรับจัดเรียงข้อมูล หากตั้งค่าพารามิเตอร์การค้นหา all เป็น true ระบบจะไม่สนใจพารามิเตอร์นี้ ค่าเริ่มต้นคือ UPDATED:DESC |
ตัวอย่างเช่น การกำหนดค่ารายงานต่อไปนี้จะแสดงผลการกำหนดค่ารายงานสำหรับองค์กรและจำกัดการดึงข้อมูลไว้ไม่เกินการกำหนดค่ารายงานสูงสุด 5 รายการ
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ -u email:password
คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)
{ "reportDefinition" : [ { "description" : "Test revenue report", "developer" : null, "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5", "lastModified" : "2015-08-27 15:44:03", "mintCriteria" : { "asXorg" : false, "currencyOption" : "LOCAL", "fromDate" : "2015-07-01 00:00:00", "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "monetizationPackageIds" : [ "payment" ], "productIds" : [ "payment" ], "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : true, "showTxType" : false, "toDate" : "2015-08-01 00:05:00", "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ] }, "name" : "Test revenue report", "organization" : { ... }, "type" : "REVENUE" }, { "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:13:20", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "currencyOption" : "LOCAL", "showRevSharePct" : false, "showSummary" : false, "showTxDetail" : true, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" } ], "totalRecords" : 2 }
หากต้องการดูการกำหนดค่ารายงานสำหรับนักพัฒนาซอฟต์แวร์ที่เจาะจง ให้ส่งคำขอ GET ไปยัง /organizations/{org_name}/developers/{dev_id}/report-definitions
โดยที่ {dev_id}
คือตัวระบุของนักพัฒนาแอป เมื่อส่งคำขอ คุณจะระบุพารามิเตอร์การค้นหาที่อธิบายไว้ข้างต้นเพื่อกรองและจัดเรียงข้อมูลได้
ตัวอย่างเช่น การแสดงผลการกำหนดค่ารายงานต่อไปนี้สำหรับนักพัฒนาแอปบางรายและจัดเรียงคำตอบตามชื่อรายงาน
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ -u email:password
การอัปเดตการกำหนดค่ารายงานโดยใช้ API
หากต้องการอัปเดตการกำหนดค่ารายงาน ให้ส่งคำขอ PUT ไปยัง /organizations/{org_name}/report-definitions/{report_definition_id}
โดยที่ {report_definition_id}
คือตัวระบุการกำหนดค่ารายงานที่เฉพาะเจาะจง เมื่อทำการอัปเดต คุณต้องระบุค่าการกำหนดค่าที่อัปเดตและรหัสของการกำหนดค่ารายงานลงในเนื้อหาของคำขอ ตัวอย่างเช่น คำขอต่อไปนี้อัปเดตรายงานเป็นรายงานสรุป (ระบบจะไฮไลต์พร็อพเพอร์ตี้ที่อัปเดต)
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id": "fedac696-ce57-469b-b62c-a77b535fd0eb", "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":false, "showSummary":true } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)
{ "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:47:29", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : false, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" }
การลบการกำหนดค่ารายงานโดยใช้ API
หากต้องการลบการกำหนดค่ารายงาน ให้ส่งคำขอ DELETE ไปยัง
/organizations/{org_namer}/report-definitions/{report_definition_id}
โดยที่ {report_definition_id}
คือตัวระบุการกำหนดค่ารายงานที่จะลบ
เช่น
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
การสร้างรายงานโดยใช้ API
หลังจากกำหนดค่ารายงานแล้ว คุณจะสร้างรายงานได้ในรูปแบบไฟล์ค่าที่คั่นด้วยคอมมา (CSV) เพื่อดู
หากต้องการสร้างรายงาน ให้สร้างคำขอ POST ไปที่ organizations/{org_id}/{report_type}
โดยที่ {report_type}
จะระบุประเภทของรายงานที่คุณต้องการสร้าง ประเภทต่างๆ มีดังนี้
billing-reports
revenue-reports
prepaid-balance-reports
variance-reports
ตัวอย่างเช่น หากต้องการสร้างรายงานการเรียกเก็บเงิน ให้ส่งคำขอ POST ไปที่ organizations/{org_name}/billing-reports
ในเนื้อหาคำขอ (สำหรับรายงานประเภทใดก็ได้) ให้ระบุเกณฑ์การค้นหาของรายงาน ใช้พร็อพเพอร์ตี้ mintCriteria
เพื่อระบุเกณฑ์การค้นหา โปรดดูรายละเอียดเพิ่มเติมในตัวเลือกการกำหนดค่าเกณฑ์
ตัวอย่างเช่น คำขอต่อไปนี้จะค้นหารายงานรายได้ตามเกณฑ์ต่างๆ เช่น วันที่เริ่มต้นและวันที่สิ้นสุดของรายงาน และประเภทธุรกรรม
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN"] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
หากพบรายงานรายได้ที่สร้างขึ้นในรูปแบบไฟล์ CSV ตัวอย่างเอาต์พุตรายงานมีดังนี้
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate, Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
การรวมแอตทริบิวต์ที่กำหนดเองของนักพัฒนาแอปไว้ในรายงานรายได้โดยใช้ API
สำหรับรายงานรายได้เท่านั้น คุณจะรวมแอตทริบิวต์ที่กำหนดเองไว้ในรายงานได้ หากมีการกำหนดแอตทริบิวต์ที่กำหนดเองสำหรับนักพัฒนาซอฟต์แวร์ คุณต้องระบุแอตทริบิวต์ที่กำหนดเองเมื่อเพิ่มนักพัฒนาแอปลงในองค์กร ตามที่อธิบายไว้ในการจัดการนักพัฒนาแอป
หากต้องการใส่แอตทริบิวต์ที่กำหนดเองในรายงานรายได้ ให้ส่งคำขอ POST ไปยัง organizations/{org_name}/revenue-reports
และใส่อาร์เรย์ devCustomAttributes
ไว้ในเนื้อหาของคำขอ
"devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ]
หมายเหตุ: อย่าระบุแอตทริบิวต์ MINT_*
และ ADMIN_*
ที่กำหนดไว้ล่วงหน้าในอาร์เรย์ devCustomAttributes
ตัวอย่างเช่น ตัวอย่างต่อไปนี้มีแอตทริบิวต์ที่กำหนดเอง 3 รายการ ได้แก่ BILLING_TYPE
, SFID
และ ORG_EXT
ในรายงาน (หากกำหนดไว้สำหรับนักพัฒนาแอป)
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "devCustomAttributes": [ "BILLING_TYPE", "SFID", "ORG_EXT" ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
ต่อไปนี้เป็นตัวอย่างเอาต์พุตรายงานที่มีค่าสำหรับแอตทริบิวต์ที่กำหนดเอง 2 รายการ
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
การรายงานกิจกรรมธุรกรรมโดยใช้ API
คุณดูกิจกรรมธุรกรรมขององค์กรได้โดยการส่งคำขอ POST ไปยัง /organizations/{org_name}/transaction-search
เมื่อส่งคำขอ คุณต้องระบุเกณฑ์สำหรับการเรียกข้อมูล ต่อไปนี้เป็นตัวอย่างสิ่งที่คุณสามารถระบุเป็นเกณฑ์ได้
- รหัสของผลิตภัณฑ์ API อย่างน้อย 1 รายการที่มีการออกธุรกรรม
- เดือนที่เรียกเก็บเงินและปีของธุรกรรม
- นักพัฒนาแอปที่ออกธุรกรรม
- ประเภทธุรกรรม เช่น การซื้อและค่าธรรมเนียมการตั้งค่า
- สถานะธุรกรรม เช่น สำเร็จและไม่สำเร็จ
โปรดดูตัวเลือกการกำหนดค่าเกณฑ์เพื่อดูรายการเกณฑ์ทั้งหมด
ตัวอย่างเช่น ธุรกรรมการคืนสินค้าต่อไปนี้ที่ออกโดยนักพัฒนาแอปที่เฉพาะเจาะจงสำหรับเดือนมิถุนายน 2015 มีดังนี้
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "billingMonth": "JUNE", "billingYear": 2015, "devCriteria": [{ "id": "RtHAeZ6LtkSbEH56", "orgId":"myorg"}], "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"], "transactionStatus": ["SUCCESS", "FAILED"] }' "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \ -u email:password
นอกจากนี้ คุณยังระบุได้ว่าแอปพลิเคชัน นักพัฒนาซอฟต์แวร์ แพ็กเกจผลิตภัณฑ์ API หรือผลิตภัณฑ์ API ใดมีกิจกรรมการทำธุรกรรมในช่วงวันที่ที่ระบุ คุณจะดูข้อมูลนี้สำหรับออบเจ็กต์แต่ละประเภทแยกกัน ตัวอย่างเช่น คุณสามารถดูข้อมูลเฉพาะเกี่ยวกับแอปพลิเคชันที่เข้าถึง API ในกลุ่มผลิตภัณฑ์ API ที่สร้างรายได้ภายในวันที่เริ่มต้นและวันที่สิ้นสุดที่ระบุไว้
หากต้องการดูข้อมูลเกี่ยวกับกิจกรรมการทำธุรกรรม ให้ส่งคำขอ GET ไปยังทรัพยากรรายการใดรายการหนึ่งต่อไปนี้
ทรัพยากร | การคืนสินค้า |
---|---|
/organizations/{org_name}/applications-with-transactions |
แอปพลิเคชันที่มีธุรกรรม |
/organizations/{org_name}/developers-with-transactions |
นักพัฒนาแอปที่มีธุรกรรม |
/organizations/{org_name}/products-with-transactions |
ผลิตภัณฑ์ที่มีธุรกรรม |
/organizations/{org_name}/packages-with-transactions |
ชุดผลิตภัณฑ์ API (หรือแพ็กเกจ API) ที่มีธุรกรรม |
เมื่อส่งคำขอ คุณต้องระบุวันที่เริ่มต้นและวันที่สิ้นสุดสำหรับช่วงวันที่นั้นเป็นพารามิเตอร์การค้นหา ตัวอย่างเช่น คำขอต่อไปนี้จะแสดงรายชื่อนักพัฒนาแอปที่มีธุรกรรมในช่วงเดือนสิงหาคม 2015
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \ -u email:password
คําตอบควรมีลักษณะดังนี้ (แสดงเฉพาะบางส่วนของคําตอบ)
{ "developer" : [ { "address" : [ { "address1" : "Dev Five Address", "city" : "Pleasanton", "country" : "US", "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev5@myorg.com", "hasSelfBilling" : false, "id" : "tJZG6broTpGGGeLV", "legalName" : "DEV FIVE", "name" : "Dev Five", "organization" : { ... }, "registrationId" : "dev5", "status" : "ACTIVE", "type" : "UNTRUSTED" }, { "address" : [ { "address1" : "Dev Seven Address", "city" : "Pleasanton", "country" : "US", "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev7@myorg.com", "hasSelfBilling" : false, "id" : "VI3l8m8IPAvJTvjS", "legalName" : "DEV SEVEN", "name" : "Dev Seven", "organization" : { ... }, "registrationId" : "dev7", "status" : "ACTIVE", "type" : "UNTRUSTED" }, ... ] }
ตัวเลือกการกำหนดค่ารายงานสำหรับ API
ตัวเลือกการกำหนดค่ารายงานต่อไปนี้จะใช้ได้กับ API
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
name |
ชื่อของรายงาน |
ไม่มีข้อมูล | มี |
description |
คำอธิบายของรายงาน |
ไม่มีข้อมูล | ไม่ได้ |
mintCriteria |
เกณฑ์สำหรับการกำหนดค่ารายงาน โปรดดูรายละเอียดเพิ่มเติมในตัวเลือกการกำหนดค่าเกณฑ์ |
ไม่มีข้อมูล | ไม่ได้ |
type |
ประเภทของรายงาน ค่าอาจเป็นค่าใดค่าหนึ่งต่อไปนี้
|
ไม่มีข้อมูล | มี |
ตัวเลือกการกำหนดค่าเกณฑ์
ตัวเลือกการกําหนดค่าต่อไปนี้ใช้ได้กับรายงานผ่านพร็อพเพอร์ตี้ mintCriteria
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
appCriteria |
รหัสและองค์กรสำหรับแอปพลิเคชันเฉพาะที่จะรวมไว้ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ แอปพลิเคชันทั้งหมดจะรวมอยู่ในรายงาน |
ไม่มีข้อมูล | ไม่ได้ |
billingMonth |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้ไม่ได้กับรายงานรายได้ เดือนที่เรียกเก็บเงินสําหรับรายงาน เช่น กรกฎาคม |
ไม่มีข้อมูล | มี |
billingYear |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้ไม่ได้กับรายงานรายได้ ปีที่เรียกเก็บเงินสำหรับรายงาน เช่น 2015 |
ไม่มีข้อมูล | มี |
currCriteria |
รหัสและองค์กรสำหรับสกุลเงินเฉพาะที่จะรวมไว้ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ สกุลเงินที่รองรับทั้งหมดจะรวมอยู่ในรายงาน |
ไม่มีข้อมูล | ไม่ได้ |
currencyOption |
สกุลเงินสำหรับรายงาน ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
devCriteria |
รหัสนักพัฒนาซอฟต์แวร์ (อีเมล) และชื่อองค์กรของนักพัฒนาซอฟต์แวร์ที่เจาะจงจะรวมอยู่ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ นักพัฒนาแอปทุกรายจะรวมอยู่ในรายงาน เช่น "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"my_org"} ] |
ไม่มีข้อมูล | ไม่ได้ |
devCustomAttributes |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานรายได้เท่านั้น แอตทริบิวต์ที่กำหนดเองที่จะรวมไว้ในรายงาน หากกำหนดไว้สำหรับนักพัฒนาแอป เช่น "devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ] หมายเหตุ: อย่าระบุแอตทริบิวต์ |
ไม่มีข้อมูล | ไม่ได้ |
fromDate |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานรายได้ ความแปรปรวน และกิจกรรมธุรกรรมเท่านั้น วันที่เริ่มต้นของรายงานในเขตเวลา UTC |
ไม่มีข้อมูล | จำเป็นสำหรับรายงานรายได้ ไม่จำเป็นสำหรับรายงานประเภทอื่นๆ |
groupBy |
ลำดับการจัดกลุ่มคอลัมน์ในรายงาน ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
monetizationPackageId |
รหัสของกลุ่มผลิตภัณฑ์ API อย่างน้อย 1 กลุ่มที่จะรวมไว้ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ แพ็กเกจผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้ไม่ได้เมื่อดูกิจกรรมธุรกรรม ( |
ไม่มีข้อมูล | ไม่ได้ |
pkgCriteria |
รหัสและการจัดระเบียบสำหรับแพ็กเกจผลิตภัณฑ์ API ที่เฉพาะเจาะจงที่จะรวมอยู่ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ แพ็กเกจผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน คุณระบุพร็อพเพอร์ตี้นี้แทนพร็อพเพอร์ตี้ หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้ไม่ได้เมื่อดูกิจกรรมธุรกรรม ( |
ไม่มีข้อมูล | ไม่ได้ |
prevFromDate |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานความแปรปรวนเท่านั้น วันที่เริ่มต้นของช่วงเวลาก่อนหน้าในเขตเวลา UTC ใช้สร้างรายงานของช่วงเวลาก่อนหน้าเพื่อเปรียบเทียบกับรายงานปัจจุบัน |
ไม่มีข้อมูล | ไม่ได้ |
prevToDate |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานความแปรปรวนเท่านั้น วันที่สิ้นสุดของช่วงเวลาก่อนหน้าในเขตเวลา UTC ใช้สร้างรายงานของช่วงเวลาก่อนหน้าเพื่อเปรียบเทียบกับรายงานปัจจุบัน |
ไม่มีข้อมูล | ไม่ได้ |
prodCriteria |
รหัสและองค์กรสำหรับผลิตภัณฑ์ API ที่เฉพาะเจาะจงที่จะรวมอยู่ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ ผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน คุณระบุพร็อพเพอร์ตี้นี้แทนพร็อพเพอร์ตี้ หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้ไม่ได้เมื่อดูกิจกรรมธุรกรรม ( |
ไม่มีข้อมูล | ไม่ได้ |
productIds |
รหัสของผลิตภัณฑ์ API อย่างน้อย 1 รายการที่จะรวมไว้ในรายงาน หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ ผลิตภัณฑ์ API ทั้งหมดจะรวมอยู่ในรายงาน ควรระบุรหัสผลิตภัณฑ์ API เป็น |
ไม่มีข้อมูล | ไม่ได้ |
pricingTypes |
ประเภทการกำหนดราคาของแพ็กเกจราคาที่จะรวมไว้ในรายงาน ค่าที่ถูกต้องได้แก่
หากไม่ได้ระบุที่พักนี้ แพ็กเกจราคาทุกประเภทจะรวมอยู่ในรายงาน |
ไม่มีข้อมูล | ไม่ได้ |
ratePlanLevels |
ประเภทแพ็กเกจราคาที่จะรวมไว้ในรายงาน ค่าที่ถูกต้องได้แก่
หากไม่ได้ระบุที่พักนี้ ทั้งแพ็กเกจราคาเฉพาะนักพัฒนาแอปและแพ็กเกจราคามาตรฐานจะรวมอยู่ในรายงาน |
ไม่มีข้อมูล | ไม่ได้ |
showRevSharePct |
การแจ้งที่ระบุว่ารายงานจะแสดงเปอร์เซ็นต์ส่วนแบ่งรายได้หรือไม่ ค่าที่ถูกต้องมีดังนี้
|
ไม่มีข้อมูล | ไม่ได้ |
showSummary |
แฟล็กที่ระบุว่ารายงานเป็นสรุปหรือไม่ ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
showTxDetail |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานรายได้เท่านั้น แฟล็กที่ระบุว่ารายงานจะแสดงรายละเอียดระดับธุรกรรมหรือไม่ ค่าที่ถูกต้องมีดังนี้
|
ไม่มีข้อมูล | ไม่ได้ |
showTxType |
แฟล็กที่ระบุว่ารายงานแสดงประเภทของธุรกรรมแต่ละรายการหรือไม่ ค่าที่ถูกต้องมีดังนี้
|
ไม่มีข้อมูล | ไม่ได้ |
toDate |
หมายเหตุ: พร็อพเพอร์ตี้นี้ใช้กับรายงานรายได้ ความแปรปรวน และกิจกรรมธุรกรรมเท่านั้น วันที่สิ้นสุดของรายงานในเขตเวลา UTC รายงานนี้ประกอบด้วยข้อมูลที่รวบรวมจนถึงสิ้นวันก่อนวันที่ที่ระบุ ข้อมูลรายงานที่รวบรวมในวันที่สิ้นสุดที่ระบุจะไม่รวมอยู่ในรายงาน ตัวอย่างเช่น หากต้องการให้แพ็กเกจราคาหมดอายุในวันที่ 31 ธันวาคม 2016 คุณควรตั้งค่า toDate เป็น 2017-01-01 ในกรณีนี้ รายงานจะรวมข้อมูลรายงานจนถึงวันที่ 31 ธันวาคม 2016 จนถึงวันที่ 1 มกราคม 2017 ข้อมูลรายงานจะถูกยกเว้น |
ไม่มีข้อมูล | จำเป็นสำหรับรายงานรายได้ ไม่จำเป็นสำหรับรายงานประเภทอื่นๆ |
transactionStatus |
สถานะของธุรกรรมที่จะรวมในรายงาน ค่าที่ถูกต้องได้แก่
|
ไม่มีข้อมูล | ไม่ได้ |
transactionCustomAttributes |
แอตทริบิวต์ธุรกรรมที่กำหนดเองที่จะรวมไว้ในรายงานสรุปรายได้ คุณต้องเปิดใช้ฟีเจอร์นี้ในองค์กร ดูการรวมแอตทริบิวต์ธุรกรรมที่กำหนดเองในรายงานสรุปรายได้ |
ไม่มีข้อมูล | ไม่ได้ |
transactionTypes |
ประเภทธุรกรรมที่จะรวมในรายงาน ค่าที่ถูกต้องได้แก่
หากไม่ได้ระบุพร็อพเพอร์ตี้นี้ ธุรกรรมทุกประเภทจะรวมอยู่ในรายงาน |
ไม่มีข้อมูล | ไม่ได้ |