จัดการรายงาน

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

เกริ่นนำ

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

ประเภทของรายงานการสร้างรายได้

คุณสร้างรายงานการสร้างรายได้ประเภทต่อไปนี้ได้

เกี่ยวกับการเก็บรักษาข้อมูล

ในระบบคลาวด์สาธารณะของ Apigee Edge การเก็บรักษาข้อมูลการสร้างรายได้คือการให้สิทธิ์แพ็กเกจ ดูการให้สิทธิ์การสร้างรายได้ที่ https://cloud.google.com/apigee/specsheets โปรดติดต่อฝ่ายขายของ Apigee หากต้องการเก็บรักษาข้อมูลการสร้างรายได้ไว้เกินระยะเวลาการให้สิทธิ์ ระบบจะเปิดใช้การเก็บรักษาข้อมูลแบบขยายเวลาเมื่อมีการขอ และไม่สามารถเปิดใช้งานย้อนหลังเพื่อรวมข้อมูลก่อนกรอบเวลาการเก็บรักษาข้อมูลเดิมได้

เกี่ยวกับธุรกรรมที่ซ้ำกัน

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

การสำรวจหน้ารายงานการสร้างรายได้

เข้าถึงหน้ารายงานการสร้างรายได้ตามที่อธิบายไว้ด้านล่าง

การกำหนดค่ารายงาน

กำหนดค่ารายงานโดยใช้ UI ตามที่อธิบายไว้ในส่วนต่อไปนี้

ขั้นตอนการกำหนดค่ารายงาน

กำหนดค่ารายงานโดยใช้ Edge UI หรือ Classice Edge UI

การกำหนดค่ารายงานการเรียกเก็บเงิน

ทำตามขั้นตอนเพื่อกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน

การกำหนดค่ารายงานยอดคงเหลือการชำระเงินล่วงหน้า

การกำหนดค่ารายงานรายได้

ทำตามขั้นตอนเพื่อกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน

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

นโยบายการบันทึกธุรกรรมช่วยให้คุณบันทึกข้อมูลแอตทริบิวต์ที่กำหนดเองจากธุรกรรม และรวมแอตทริบิวต์ที่กำหนดเองเหล่านั้นไว้ในรายงานรายได้โดยสรุปได้ กำหนดชุดแอตทริบิวต์ที่กำหนดเองเริ่มต้นที่รวมอยู่ในตารางฐานข้อมูลการสร้างรายได้โดยการตั้งค่าพร็อพเพอร์ตี้ 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">[&quot;partner_id&quot;,&quot;tax_source&quot;]</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 โปรดดูตัวเลือกการกำหนดค่าเกณฑ์

การกำหนดค่ารายงานความแปรปรวน (เลิกใช้งาน)

ทำตามขั้นตอนเพื่อกำหนดค่ารายงาน และป้อนข้อมูลต่อไปนี้ในหน้ารายงาน

การสร้างและการดาวน์โหลดรายงาน

หลังจากสร้างรายงานแล้ว คุณจะดาวน์โหลดผลลัพธ์ของรายงานในรูปแบบไฟล์ CSV หรือ ZIP ได้ คุณสามารถสร้างไฟล์ CSV หรือ ZIP แบบซิงโครนัสหรือไม่พร้อมกันก็ได้

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

  ระดับรายงานสรุปรองรับเฉพาะการสร้างแบบซิงโครนัสเท่านั้น

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

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

  ระดับรายงานรายละเอียดรองรับการสร้างแบบอะซิงโครนัส

หากต้องการสร้างและดาวน์โหลดรายงานในรูปแบบไฟล์ CSV หรือ ZIP ให้ดำเนินการอย่างใดอย่างหนึ่งต่อไปนี้

1. เข้าถึงหน้ารายงาน
2. วางเคอร์เซอร์ไว้เหนือรายงานที่คุณต้องการดาวน์โหลด

3. ในคอลัมน์แก้ไข ให้คลิกตัวเลือกต่อไปนี้

   1. ไอคอน หรือไอคอน (สำหรับรายงานสรุป) โดยรายงานจะบันทึกเป็นไฟล์ CSV หรือ ZIP พร้อมกัน
   2. ส่งงาน (สำหรับรายงานโดยละเอียด) งานที่ไม่พร้อมกันจะเริ่มต้น

      1. ตรวจสอบสถานะของงานในคอลัมน์แก้ไข

         ไอคอนดิสก์จะปรากฏขึ้นเมื่อรายงานพร้อมสำหรับการดาวน์โหลด:

         
      2. หลังจากงานเสร็จสมบูรณ์แล้ว ให้คลิกไอคอนดิสก์เพื่อดาวน์โหลดรายงาน

รายการต่อไปนี้แสดงตัวอย่างไฟล์ CSV สำหรับรายงานการเรียกเก็บเงินสรุป

การแก้ไขรายงาน

วิธีแก้ไขรายงาน

1. เข้าถึงหน้ารายงาน
2. วางเคอร์เซอร์ไว้เหนือรายงานที่ต้องการแก้ไข แล้วคลิก ในเมนูการทำงาน
3. อัปเดตการกำหนดค่ารายงานตามต้องการ
4. คลิกอัปเดตรายงานเพื่อบันทึกการกำหนดค่ารายงานที่อัปเดต

การลบรายงาน

วิธีลบรายงาน

1. เข้าถึงหน้ารายงาน
2. วางเคอร์เซอร์ไว้เหนือรายงานที่ต้องการลบ
3. คลิก ในเมนูการทำงาน

การจัดการรายงานการสร้างรายได้โดยใช้ 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

คุณสามารถส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อกรองและจัดเรียงผลลัพธ์ได้

ตัวอย่างเช่น โค้ดต่อไปนี้จะแสดงการกำหนดค่ารายงานสำหรับองค์กรและจำกัดการดึงข้อมูลในการกำหนดค่ารายงานสูงสุด 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 ไปยังทรัพยากรอย่างใดอย่างหนึ่งต่อไปนี้

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

ตัวเลือกการกำหนดค่าเกณฑ์

ตัวเลือกการกำหนดค่าต่อไปนี้ใช้ได้กับรายงานผ่านพร็อพเพอร์ตี้ mintCriteria

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]