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

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

บทนำ

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

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

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

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

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

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

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

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

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

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

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

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

กําหนดค่ารายงานโดยใช้ UI ของ Edge หรือ UI ของ Edge แบบคลาสสิก

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

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

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

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

ทําตามขั้นตอนในการกําหนดค่ารายงาน แล้วป้อนข้อมูลต่อไปนี้ในหน้ารายงาน

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

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

หากต้องการรวมแอตทริบิวต์ที่กำหนดเองไว้ในรายงานรายได้สรุปหลังจากที่เปิดใช้ฟีเจอร์นี้ ให้ใช้ Report 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 และ ผลิตภัณฑ์ 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",
    ...
]