נהל דוחות

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

מבוא

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

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

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

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

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

סקירת הדף 'דוחות מונטיזציה'

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

הגדרת דוח

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

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

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

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

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

הגדרת דוח יתרה מהפקדה

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

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

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

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

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

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

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

הגדרת דוח שונות (הוצא משימוש)

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

יצירה והורדה של דוח

לאחר יצירת דוח, ניתן להוריד את תוצאות הדוח בפורמט קובץ CSV או zip. אפשר ליצור את קובץ ה-CSV או ה-ZIP באופן סינכרוני או אסינכרוני.

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

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

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

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

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

כדי ליצור ולהוריד דוח בפורמט קובץ 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.

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

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

$ 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",
    ...
]