נהל דוחות

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

מבוא

דוחות המונטיזציה מאפשרים לכם לגשת למידע ממוקד על נתוני השימוש ופעילות העסקאות. לדוגמה, אפשר לקבוע אילו אפליקציות, מפתחים, חבילות של מוצרי API או מוצרי API היו להם פעילויות עסקאות בטווח תאריכים נתון. באמצעות המונטיזציה, אפשר ליצור דוחות סיכום או מפורטים שעוקבים אחרי השימוש ב-API.

סוגי דוחות המונטיזציה

אתם יכולים ליצור את סוגי דוחות המונטיזציה הבאים.

מידע על שמירת נתונים

בענן הציבורי של Apigee Edge, שמירת נתוני מונטיזציה היא זכות שמגיעה עם המינוי. אפשר לעיין בהרשאות למונטיזציה בכתובת https://cloud.google.com/apigee/specsheets. אם אתם רוצים לשמור את נתוני המונטיזציה מעבר לתקופת ההרשאה, עליכם לפנות למחלקת המכירות של Apigee. הארכת תקופת השמירה של הנתונים מופעלת בזמן שליחת הבקשה, ולא ניתן להפעיל אותה באופן רטרואקטיבי כדי לכלול נתונים שנאספו לפני חלון השמירה המקורי.

מידע על עסקאות כפולות

אם משווים בין דוחות העסקאות של המונטיזציה לבין נתוני Analytics, יכול להיות שתבחינו במספר קטן של עסקאות כפולות. זוהי התנהגות צפויה, כי מערכת המונטיזציה יכולה לעבד כמה מיליוני עסקאות ביום, ורבות מהן עוברות עיבוד במקביל בכל רגע נתון. בממוצע, כ-0.1% מהעסקאות עשויות להיות כפילויות.

הסבר על הדף 'דוחות מונטיזציה'

נכנסים לדף 'דוחות מונטיזציה', כפי שמתואר בהמשך.

הגדרת דוח

מגדירים דוח באמצעות ממשק המשתמש, כפי שמתואר בקטעים הבאים.

שלבים להגדרת דוח

מגדירים דוח באמצעות ממשק המשתמש של Edge או ממשק המשתמש הקלאסי של Edge.

הגדרת דוח חיוב

פועלים לפי השלבים להגדרת דוח ומזינים את הפרטים הבאים בדף הדוח:

הגדרת דוח של יתרה מראש

הגדרת דוח הכנסות

פועלים לפי השלבים להגדרת דוח ומזינים את הפרטים הבאים בדף הדוח:

הוספת מאפייני עסקאות מותאמים אישית לדוחות סיכום הכנסות

כללי המדיניות בנושא תיעוד עסקאות מאפשרים לכם לתעד נתונים של מאפיינים מותאמים אישית מעסקאות, ואפשר לכלול את המאפיינים המותאמים אישית האלה בדוחות סיכום הכנסות. כדי להגדיר את קבוצת ברירת המחדל של המאפיינים המותאמים אישית שכלולים בטבלאות של מסדי הנתונים של המונטיזציה, מגדירים את המאפיין MINT.SUMMARY_CUSTOM_ATTRIBUTES לארגון.

כדי להשתמש בתכונה הזו, צריך לחשוב ולתכנן קצת, לכן כדאי לעיין בשיקולים הבאים.

לקוחות Cloud צריכים לפנות אל התמיכה של Apigee Edge כדי להגדיר את המאפיין. לקוחות Apigee Edge לענן פרטי צריכים להגדיר את הדגל באמצעות בקשת 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 באופן סינכרוני או באופן אסינכרוני.

• בדוח סינכרוני, מפעילים את בקשת הדוח והבקשה חסומה עד ששרת הניתוח מספק תשובה. עם זאת, יכול להיות שדוח יצטרך לעבד כמות גדולה של נתונים (לדוגמה, מאות ג'יגה-בייט), ולכן דוח סינכרוני עלול להיכשל בגלל זמן קצוב לתפוגה.

  ברמת הדוח סיכום יש תמיכה רק ביצירה סינכרונית.

• בדוח אסינכרוני, מפעילים את הבקשה לדוח ומאחזרים את התוצאות במועד מאוחר יותר. עיבוד שאילתות אסינכרוני יכול להיות חלופה טובה במצבים הבאים:

  • ניתוח יצירת דוחות שמתפרסים על פני מרווחי זמן ארוכים.
  • ניתוח נתונים באמצעות מגוון מאפייני קיבוץ ואילוצים אחרים שמוסיפים מורכבות לשאילתה.
  • ניהול שאילתות כשאתם מגלים שהנפח של הנתונים גדל באופן משמעותי אצל משתמשים או ארגונים מסוימים.

  ברמת הדוח מפורט יש תמיכה ביצירה אסינכרונית.

כדי ליצור ולהוריד דוח בפורמט CSV או קובץ zip, מבצעים אחת מהמשימות הבאות:

1. נכנסים לדף הדוחות.
2. מציבים את הסמן מעל הדוח שרוצים להוריד.

3. בעמודה Modified, לוחצים על אחת מהאפשרויות הבאות:

   1. הסמל או הסמל (לדוח סיכום). הדוח נשמר באופן סינכרוני בקובץ CSV או בקובץ zip.
   2. Submit job (לדוח מפורט). המשימה האסינכרונית מתחילה.

      1. עוקבים אחרי סטטוס המשימה בעמודה Modified.

         סמל הדיסק מופיע כשהדוח מוכן להורדה:

         
      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.

אפשר להעביר את פרמטרים השאילתה הבאים כדי לסנן ולמיין את התוצאות:

לדוגמה, הפקודה הבאה מחזירה הגדרות של דוחות לארגון ומגבילה את אחזור ההגדרות לחמש הגדרות דוחות לכל היותר:

$ 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.

לדוגמה, הדוגמה הבאה כוללת שלושה מאפיינים מותאמים אישית, 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

בהמשך מוצגת דוגמה לפלט הדוח שכולל ערכים לשני המאפיינים המותאמים אישית:

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 אחד או יותר שבוצעו לגביו עסקאות.
• החודש והשנה של העסקאות לחיוב.
• המפתחים שהנפיקו את העסקה.
• סוג העסקה, כמו רכישה ודמי הגדרה.
• סטטוס העסקה, כמו הצלחה וכישלון.

רשימה מלאה של הקריטריונים מופיעה במאמר אפשרויות להגדרת קריטריונים.

לדוגמה, השאילתה הבאה מחזירה עסקאות שהנפיק מפתח ספציפי בחודש החיוב יוני 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",
    ...
]