‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

נהל דוחות

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

מבוא

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

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

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

דיווח	תיאור
חיוב	לראות את הפעילות של המפתחים בחודש חיוב מסוים ולוודא שהתוכניות לתמחור הוחלו בצורה נכונה.
היתרה מההפקדה	לראות את הטעינות של היתרה שבוצעו על ידי מפתח עם מינוי בתשלום מראש בחודש חיוב או בחודש פתוח נוכחי, כדי שתוכלו לבצע התאמה עם התשלומים שהתקבלו ממעבד התשלומים.
הכנסה	אפשר לראות את הפעילות וההכנסות שנוצרו על ידי מפתחים בטווח תאריכים מסוים, כדי שתוכלו לנתח את הביצועים של חבילות מוצרי ה-API והמוצרים שלכם בקרב המפתחים (והאפליקציות שלהם). הערות: דוח הכנסות כולל נתונים שנאספו עד סוף היום שלפני תאריך הסיום שצוין באפשרות ההגדרה `toDate`. נתוני הדוח שנאספו בתאריך הסיום שצוין לא ייכללו בדוח. שם המפתח בדוח הכנסות הוא השם החוקי של המפתח. אפשר להגדיר את השם החוקי של המפתח באמצעות המאפיין המותאם אישית `MINT_DEVELOPER_LEGAL_NAME`, כמו שמתואר במאמר הגדרת מאפייני מונטיזציה. אם השם החוקי של המפתח לא זמין, Apigee מגדיר את שם המפתח כשם המפתח (שם פרטי + שם משפחה). נניח שגם שם המפתח לא צוין. במקרה כזה, Apigee מגדיר את שם המפתח כ-`NA`.
שונות	השימוש בדוחות שונות הופסק ואפשר להגדיר אותם רק באמצעות ממשק המשתמש הקלאסי של Edge. דוחות השונות יצאו משימוש בגרסה עתידית. השוואה בין הפעילות וההכנסות שנוצרו על ידי מפתחים בשני טווחי תאריכים, כדי שתוכלו לנתח מגמות של עלייה או ירידה בביצועים של חבילות ה-API והמוצרים שלכם בקרב המפתחים (והאפליקציות שלהם).

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

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

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

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

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

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

Edge

כדי לגשת לדף 'דוחות' באמצעות ממשק המשתמש של Edge:

נכנסים לחשבון בכתובת apigee.com/edge.
בסרגל הניווט הימני, בוחרים באפשרות פרסום > מונטיזציה > דוחות.

יוצג הדף 'דוחות'.

כפי שמודגש באיור, בדף הדוחות אפשר:

הצגת פרטי סיכום של כל הדוחות, כולל השם והתיאור, סוג הדוח וטווח התאריכים, והתאריך שבו בוצע השינוי האחרון
הגדרת דוח
יצירה והורדה של דוח בפורמט CSV או כקובץ ZIP
עריכת דוח
מחיקת דוח
חיפוש ברשימת הדוחות

‫Classic Edge (ענן פרטי)

כדי לגשת לדף 'דוחות' באמצעות ממשק המשתמש הקלאסי של Edge:

מתחברים אל http://ms-ip:9000, כאשר ms-ip היא כתובת ה-IP או שם ה-DNS של צומת שרת הניהול.
בסרגל הניווט העליון, בוחרים באפשרות מונטיזציה > דוחות מונטיזציה.

יוצג הדף 'דוחות'.

צפייה ברשימת הדוחות הנוכחית
הגדרת דוח
יצירה והורדה של דוח בפורמט CSV
עריכת דוח
מחיקת דוח

הגדרת דוח

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

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

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

Edge

כדי להגדיר דוח באמצעות ממשק המשתמש של Edge:

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

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

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

מגדירים את שאר פרטי הדוח בהתאם לסוג הדוח שנבחר, כמו שמתואר בקטעים הבאים:
אחרי שמזינים את הפרטים בחלון הדוח, אפשר:
- לוחצים על שמירת הדוח כדי לשמור את הגדרות הדוח.
- בדוח מפורט בלבד, לוחצים על שליחת משימה כדי להריץ את הדוח באופן אסינכרוני ולקבל את התוצאות במועד מאוחר יותר. מידע נוסף זמין במאמר בנושא יצירה והורדה של דוח.
- לוחצים על שמירה כקובץ CSV או על שמירה כקובץ ZIP כדי להוריד את הדוח שנוצר למחשב המקומי כקובץ CSV או כקובץ ZIP דחוס שמכיל את קובץ ה-CSV. מומלץ להוריד דוחות גדולים כקובץ zip, כי כך ההורדה תהיה יעילה יותר.

‫Classic Edge (ענן פרטי)

כדי ליצור דוח באמצעות ממשק המשתמש הקלאסי של Edge:

בסרגל הניווט העליון, בוחרים באפשרות מונטיזציה > דוחות מונטיזציה.
בתפריט הנפתח, בוחרים את סוג הדוח שרוצים ליצור. מידע על סוגי דוחות המונטיזציה
לוחצים על + דוח.
מגדירים את פרטי הדוח בהתאם לסוג החיוב שנבחר, כמו שמתואר בקטעים הבאים:
- הגדרת דוח חיוב
- הגדרת דוח על היתרה מההפקדה
- הגדרת דוח הכנסות
- הגדרת דוח שונות (הוצא משימוש)
אחרי שמזינים את הפרטים בחלון הדוח, אפשר:
- לוחצים על שמירה בשם ... כדי לשמור את הגדרות הדוח ולהוריד אותו מאוחר יותר.
- בדוח מפורט בלבד, לוחצים על שליחת משימה כדי להריץ את הדוח באופן אסינכרוני ולקבל את התוצאות במועד מאוחר יותר. מידע נוסף זמין במאמר בנושא יצירה והורדה של דוח.
- לוחצים על הורדת CSV כדי ליצור את הדוח ולהוריד אותו למחשב המקומי כקובץ CSV לצפייה.

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

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

שדה	תיאור
חודש החיוב	חודש החיוב של הדוח.
רמת הדיווח	רמת הדיווח. הערכים התקפים כוללים: מפורט: כל עסקה מוצגת בשורה נפרדת, ואפשר לבדוק שתוכניות התמחור הוחלו בצורה נכונה. אין סיכום. הערה: עסקאות מסוג חיוב לא נכללות בדוחות מפורטים בגלל המספר הגדול הפוטנציאלי של עסקאות. סיכום: סיכום של סך ההכנסות מכל מוצר API ומכל מפתח. הערה: אי אפשר להשתמש במאפיינים מותאמים אישית בדוחות של סיכום החיוב.
חבילות מוצרים	הערה: בממשק המשתמש של Classic Edge, חבילות של מוצרי API נקראות חבילות API. בוחרים את חבילות מוצרי ה-API שרוצים לכלול בדוח. אם לא בוחרים אף חבילת מוצרים, כל חבילות המוצרים של ה-API נכללות בדוח. הדוח כולל שורה נפרדת לכל חבילת מוצרי API שנבחרה. בדוח סיכום, אפשר לסמן את התיבה Do not display באפשרויות התצוגה של הסיכום. במקרה כזה, בדוח מוצג מידע מצטבר על כל חבילות מוצרי ה-API (או על חבילות נבחרות), ולא מוצג מידע על כל חבילת מוצרי API בנפרד.
מוצרים	בוחרים את מוצרי ה-API שרוצים לכלול בדוח. אם לא בוחרים אף מוצר, כל מוצרי ה-API נכללים בדוח. הדוח כולל שורה נפרדת לכל מוצר API שנבחר. בדוח סיכום, אפשר לסמן את התיבה Do not display באפשרויות התצוגה של הסיכום. במקרה כזה, בדוח מוצג מידע מצטבר על כל המפתחים (או על המפתחים שנבחרו), ולא מוצג מידע על כל מפתח בנפרד.
חברות	בוחרים את החברות שרוצים לכלול בדוח. אם לא נבחרות חברות, כל החברות נכללות בדוח.
תוכנית תמחור	תוכניות התמחור שייכללו בדוח. צריך לבחור אחת מהאפשרויות הבאות: ‫All rate plans: כולל את כל תוכניות התמחור בדוח. תוכניות תמחור רגילות: הדוח יכלול רק תוכניות תמחור רגילות. תוכניות תמחור ספציפיות למפתחים: הדוח כולל רק תוכניות למפתחים.

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

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

שדה

תיאור

חודש החיוב

חודש החיוב של הדוח.

רמת הדיווח

רמת הדיווח. הערכים התקפים כוללים:

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

חברות

בוחרים את החברות שרוצים לכלול בדוח. אם לא נבחרות חברות, כל החברות נכללות בדוח.

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

הערות:

דוח הכנסות כולל נתונים שנאספו עד סוף היום שלפני תאריך הסיום שצוין באפשרות ההגדרה toDate. נתוני הדוח שנאספו בתאריך הסיום שצוין לא ייכללו בדוח.
שם המפתח בדוח הכנסות הוא השם החוקי של המפתח. אפשר להגדיר את השם החוקי של המפתח באמצעות המאפיין המותאם אישית MINT_DEVELOPER_LEGAL_NAME, כמו שמתואר במאמר הגדרת מאפייני מונטיזציה. אם השם החוקי של המפתח לא זמין, Apigee מגדיר את שם המפתח כשם המפתח (שם פרטי + שם משפחה). נניח שגם שם המפתח לא צוין. במקרה כזה, Apigee מגדיר את שם המפתח כ-NA.

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

שדה	תיאור
טווח תאריכים	טווח התאריכים של הדוח. צריך לבחור אחת מהאפשרויות הבאות: הגדרה קבועה מראש: בוחרים אחד מטווח התאריכים הסטנדרטיים (כמו 'החודש הקלנדרי האחרון') מהתפריט הנפתח. מותאם אישית: בוחרים תאריך התחלה ותאריך סיום לטווח מלוח השנה הקופץ.
צריך לבחור מטבע	המטבע שמוצג בדוח. הערכים התקפים כוללים: מטבע מקומי: כל שורה בדוח מוצגת לפי תוכנית התמחור הרלוונטית. המשמעות היא שאם למפתחים יש תוכניות שמשתמשות במטבעות שונים, יכול להיות שיופיעו כמה מטבעות בדוח אחד. אירו: העסקאות במטבע המקומי בדוח מומרות ומוצגות באירו. לירה שטרלינג בבריטניה: עסקאות במטבע המקומי בדוח מומרות ומוצגות בלירות שטרלינג. דולר ארה"ב: העסקאות במטבע המקומי בדוח מומרות ומוצגות בדולרים. הערה: אם בוחרים מטבע ספציפי, כל העסקאות בדוח מוצגות במטבע הזה, על סמך שער החליפין שהיה בתוקף בתאריך העסקה.
רמת הדיווח	רמת הדיווח. הערכים התקפים כוללים: מפורט: כל עסקה מוצגת בשורה נפרדת. אין סיכום. הערה: עסקאות מסוג חיוב לא נכללות בדוחות מפורטים בגלל המספר הגדול הפוטנציאלי של עסקאות. סיכום: סיכום ההכנסות הכוללות מכל מוצר API ומכל מפתח, בהתאם לפרמטרים שתבחרו.
חבילות מוצרים	הערה: בממשק המשתמש של Classic Edge, חבילות של מוצרי API נקראות חבילות API. בוחרים את חבילות מוצרי ה-API שרוצים לכלול בדוח. אם לא בוחרים אף חבילת מוצרים, כל חבילות המוצרים של ה-API נכללות בדוח. הדוח כולל שורה נפרדת לכל חבילת מוצרי API שנבחרה. בדוח סיכום, אפשר לסמן את התיבה Do not display באפשרויות התצוגה של הסיכום. במקרה כזה, בדוח מוצג מידע מצטבר על כל חבילות מוצרי ה-API (או על חבילות נבחרות), ולא מוצג מידע על כל חבילת מוצרי API בנפרד.
מוצרים	בוחרים את מוצרי ה-API שרוצים לכלול בדוח. אם לא בוחרים אף מוצר, כל מוצרי ה-API נכללים בדוח. הדוח כולל שורה נפרדת לכל מוצר API שנבחר. בדוח סיכום, אפשר לסמן את התיבה Do not display באפשרויות התצוגה של הסיכום. במקרה כזה, בדוח מוצג מידע מצטבר על כל המפתחים (או על המפתחים שנבחרו), ולא מוצג מידע על כל מפתח בנפרד.
חברות	בוחרים את החברות שרוצים לכלול בדוח. אם לא נבחרות חברות, כל החברות נכללות בדוח. בדוח סיכום, אפשר לסמן את התיבה Do not display בקטע Summary Display Options. במקרה הזה, בדוח מוצג מידע מצטבר על כל החברות (או על החברות שנבחרו), ולא מוצג מידע על כל חברה בנפרד.
אפליקציות	בוחרים את האפליקציות שרוצים לכלול בדוח. אם לא נבחרות אפליקציות, כל האפליקציות נכללות בדוח. הדוח כולל שורה נפרדת לכל אפליקציה שנבחרה. בדוח סיכום, אפשר לסמן את התיבה Do not display בקטע Summary Display Options. במקרה כזה, בדוח מוצג מידע מצטבר מכל האפליקציות (או מהאפליקציות שנבחרו), ולא מוצג מידע בנפרד על כל אפליקציה שנבחרה.
אפשרויות תצוגה של סיכומים	הסדר שבו העמודות מקובצות ומוצגות בדוח. בוחרים מספר שמציין את הסדר היחסי של הקטע בקיבוץ (1 הוא הקיבוץ הראשון). לדוגמה, בדוח הבא, הקיבוץ מתבצע קודם לפי חבילות, אחר כך לפי מוצרים, אחר כך לפי מפתחים ולבסוף לפי אפליקציות. אם לא רוצים להציג קטע מסוים, בוחרים באפשרות לא להציג, ואז בוחרים את השדות הנותרים לפי הסדר. הסדר מתעדכן אוטומטית כשמשנים את הסדר היחסי של קטע מסוים או כשבוחרים לא להציג קטע בדוח.

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

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

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

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

שדה	תיאור
טווח תאריכים	טווח התאריכים של הדוח. צריך לבחור אחת מהאפשרויות הבאות: הגדרה קבועה מראש: בוחרים אחד מטווח התאריכים הסטנדרטיים (כמו 'החודש הקלנדרי האחרון') מהתפריט הנפתח. מותאם אישית: בוחרים תאריך התחלה ותאריך סיום לטווח מלוח השנה הקופץ.
חבילות	חבילות ה-API שייכללו בדוח. צריך לבחור אחת מהאפשרויות הבאות: ‫All: כולל את כל חבילות ה-API בדוח. נבחר: מוצגת רשימה שממנה אפשר לבחור את חבילות ה-API שייכללו בדוח. אם לא בוחרים חבילות, כל החבילות נכללות בדוח. הדוח כולל שורה נפרדת לכל חבילת API שנבחרה. בדוח סיכום, אפשר לסמן את התיבה Don't Display (Packages) בקטע Summary Display Options. במקרה כזה, בדוח מוצג מידע מצטבר על כל חבילות ה-API (או על חבילות ה-API שנבחרו), ולא מוצג מידע על כל חבילת API בנפרד.
מוצרים	מוצרי ה-API שייכללו בדוח. צריך לבחור אחת מהאפשרויות הבאות: ‫All: כולל את כל מוצרי ה-API בדוח. נבחר: מוצגת רשימה שממנה אפשר לבחור את המוצרים שייכללו בדוח. אם לא תבחרו מוצרים, כל המוצרים ייכללו בדוח. הדוח כולל שורה נפרדת לכל מוצר API שנבחר. בדוח סיכום, אפשר לסמן את התיבה 'לא להציג (מוצרים)' בקטע 'אפשרויות תצוגה'. במקרה כזה, הדוח מסכם את המידע מכל מוצרי ה-API (או ממוצרי ה-API שנבחרו), ולא מציג את המידע של כל מוצר API בנפרד.
חברות	החברות שייכללו בדוח. צריך לבחור אחת מהאפשרויות הבאות: הכול: כולל את כל החברות בדוח. נבחר: מוצגת רשימה שממנה אפשר לבחור את החברות שייכללו בדוח. אם לא בוחרים חברות, כל החברות נכללות בדוח. הדוח כולל שורה נפרדת לכל חברה שנבחרה. בדוח סיכום, אפשר לסמן את התיבה Don't Display (Companies) בקטע Summary Display Options. במקרה הזה, בדוח מוצג מידע מצטבר על כל החברות (או על החברות שנבחרו), ולא מוצג מידע על כל חברה בנפרד.
אפליקציות	האפליקציות שייכללו בדוח. צריך לבחור אחת מהאפשרויות הבאות: ‫All: כולל את כל האפליקציות בדוח. Selected: מוצגת רשימה שממנה אפשר לבחור את האפליקציות שייכללו בדוח. אם לא תבחרו אפליקציות, כל האפליקציות ייכללו בדוח. הדוח כולל שורה נפרדת לכל אפליקציה שנבחרה. בדוח סיכום, אפשר לסמן את התיבה 'אל תציג (אפליקציות)' בקטע 'אפשרויות תצוגה של סיכום'. במקרה כזה, בדוח מוצג מידע מצטבר מכל האפליקציות (או מהאפליקציות שנבחרו), ולא מוצג מידע בנפרד על כל אפליקציה שנבחרה.
מטבע	המטבע שמוצג בדוח. הערכים התקפים כוללים: מטבע מקומי: כל שורה בדוח מוצגת לפי תוכנית התמחור הרלוונטית. המשמעות היא שאם למפתחים יש תוכניות שמשתמשות במטבעות שונים, יכול להיות שיופיעו כמה מטבעות בדוח אחד. ‫EUR: עסקאות במטבע המקומי בדוח מומרות ומוצגות באירו. ‫GPB: עסקאות במטבע המקומי בדוח מומרות ומוצגות בלירות שטרלינג. דולר ארה"ב: העסקאות במטבע המקומי בדוח מומרות ומוצגות בדולרים. הערה: אם בוחרים באפשרות EUR, ‏ GBP או USD, בדוח מוצגות כל העסקאות במטבע הזה, על סמך שער החליפין שהיה בתוקף בתאריך העסקה.
אפשרויות תצוגה של סיכומים	הסדר שבו העמודות מקובצות ומוצגות בדוח. בוחרים מספר שמציין את הסדר היחסי של הקטע בקיבוץ (1 הוא הקיבוץ הראשון). לדוגמה, בדוח הבא, הקיבוץ מתבצע קודם לפי חבילות, אחר כך לפי מוצרים, אחר כך לפי מפתחים ולבסוף לפי אפליקציות. אם לא רוצים להציג קטע מסוים, בוחרים באפשרות לא להציג, ואז בוחרים את השדות הנותרים לפי הסדר. הסדר מתעדכן אוטומטית כשמשנים את הסדר היחסי של קטע מסוים או כשבוחרים לא להציג קטע בדוח.

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

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

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

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

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

נכנסים לדף הדוחות.
מציבים את הסמן מעל הדוח שרוצים להוריד.
בעמודה שונה, לוחצים על אחת מהאפשרויות הבאות:
1. הסמל או הסמל (לדוח סיכום). הדוח נשמר כקובץ CSV או כקובץ ZIP באופן סינכרוני.
2. שליחת משימה (לדוח מפורט). העבודה האסינכרונית מתחילה.
  1. עוקבים אחרי הסטטוס של העבודה בעמודה שונה.
    
    סמל הדיסק מופיע כשהדוח מוכן להורדה:
  2. אחרי שהעבודה מסתיימת, לוחצים על סמל הדיסק כדי להוריד את הדוח.

הדוגמה הבאה מציגה קובץ CSV של דוח סיכום חיוב.

עריכת דוח

כדי לערוך דוח:

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

מחיקת דוח

כדי למחוק דוח:

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

ניהול דוחות מונטיזציה באמצעות ה-API

בקטעים הבאים מוסבר איך לנהל דוחות על מונטיזציה באמצעות ה-API.

הגדרת דוח באמצעות ה-API

כדי להגדיר דוח לכל הארגון, שולחים בקשת POST אל /organizations/{org_name}/report-definitions.

כדי להגדיר דוח למפתח ספציפי, שולחים בקשת POST אל /organizations/{org_name}/developers/{dev_id}/report-definitions, כאשר {dev_id} הוא מזהה המפתח.

כששולחים את הבקשה, צריך לציין את השם והסוג של הדוח. הסוג הוא אחד מהערכים הבאים: BILLING, REVENUE, VARIANCE (הוצא משימוש) או PREPAID_BALANCE. בנוסף, אפשר לציין קריטריונים במאפיין mintCriteria כדי להגדיר עוד את הדוח. יש מגוון רחב של קריטריונים שאפשר לציין. כך יש לכם גמישות רבה בהגדרת הדוח. אלה כמה דברים שאפשר לציין כקריטריונים:

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

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

לדוגמה, הפקודה הבאה יוצרת דוח הכנסות שמסכם את פעילות העסקאות בחודש יולי 2015. הדוח כולל מגוון סוגי עסקאות שצוינו במאפיין transactionTypes, והוא רלוונטי במיוחד לחבילת המוצרים Payment API ולמוצר Payment API. הדוח חל על כל המפתחים והאפליקציות, כי לא צוינו מפתח או אפליקציה ספציפיים בהגדרת הדוח. מכיוון שהנכס currencyOption מוגדר ל-LOCAL, כל שורה בדוח תוצג במטבע של תוכנית התמחור הרלוונטית. בנוסף, המאפיין groupBy מציין שהעמודות בדוח יקובצו בסדר הבא: PACKAGE,‏ PRODUCT,‏ DEVELOPER,‏ APPLICATION ו-RATEPLAN (כולל שם תוכנית התמחור ומזהה בתוכנית בדוח).

הערה: התאריכים והשעות בדוחות fromDate ו-toDate הם ב-UTC/GMT ויכולים לכלול שעות.

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

הפקודה הבאה יוצרת דוח חיוב מפורט שמציג את הפעילות של מפתח DEV FIVE בחודש יוני 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

הצגת הגדרות של דוחות באמצעות ה-API

אתם יכולים לראות הגדרת דוח ספציפית או את כל הגדרות הדוחות של הארגון. אפשר גם לראות את הגדרות הדוח של מפתח ספציפי.

כדי להציג הגדרה ספציפית של דוח לארגון, שולחים בקשת GET אל /organizations/{org_name}/report-definitions/{report_definition_id}, כאשר {report_definition_id} הוא מזהה ההגדרה הספציפית של הדוח (המזהה מוחזר בתשובה כשיוצרים את הגדרת הדוח). לדוגמה:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

כדי לראות את כל הגדרות הדוחות של הארגון, שולחים בקשת GET אל /organizations/{org_name}/report-definitions.

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

פרמטר שאילתה	תיאור
`all`	דגל שמציין אם להחזיר את כל חבילות מוצרי ה-API. אם הערך הוא false, מספר חבילות המוצרים של ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה `size`. ברירת המחדל היא false.
`size`	מספר חבילות מוצרי ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה `all` מוגדר לערך `true`, המערכת מתעלמת מהפרמטר הזה.
`page`	מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה `all` מוגדר לערך `true`, המערכת מתעלמת מהפרמטר הזה.
`sort`	השדה שלפיו ימוין המידע. אם פרמטר השאילתה `all` מוגדר לערך `true`, המערכת מתעלמת מהפרמטר הזה. ברירת המחדל היא `UPDATED:DESC`.

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

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

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

הערה: התאריכים והשעות בדוחות fromDate ו-toDate הם בפורמט UTC/GMT ויכולים לכלול שעות.

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

כדי לראות מידע על פעילות של עסקאות, שולחים בקשת GET לאחד מהמשאבים הבאים:

משאב	החזרות
`/organizations/{org_name}/applications-with-transactions`	אפליקציות עם עסקאות
`/organizations/{org_name}/developers-with-transactions`	מפתחים עם עסקאות
`/organizations/{org_name}/products-with-transactions`	מוצרים עם עסקאות
`/organizations/{org_name}/packages-with-transactions`	חבילות של מוצרי API (או חבילות API) עם טרנזקציות

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

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

התשובה אמורה להיראות כך (מוצג רק חלק מהתשובה):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

אפשרויות להגדרת דוחות ב-API

אפשרויות ההגדרה הבאות של הדוחות זמינות ב-API:

שם	תיאור	ברירת מחדל	חובה?
`name`	שם הדוח.	לא רלוונטי	כן
`description`	תיאור של הדוח.	לא רלוונטי	לא
`mintCriteria`	הקריטריונים להגדרת דוח. פרטים נוספים זמינים במאמר אפשרויות להגדרת קריטריונים.	לא רלוונטי	לא
`type`	סוג הדוח. הערך יכול להיות אחד מהערכים הבאים: `BILLING` `REVENUE` `VARIANCE` `PREPAID_BALANCE`	לא רלוונטי	כן

אפשרויות להגדרת קריטריונים

אפשרויות ההגדרה הבאות זמינות לדוחות דרך הנכס mintCriteria:

שם	תיאור	ברירת מחדל	חובה?
`appCriteria`	המזהה והארגון של אפליקציה ספציפית שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל האפליקציות נכללות בדוח.	לא רלוונטי	לא
`billingMonth`	הערה: אי אפשר להשתמש במאפיין הזה בדוחות הכנסות. חודש החיוב של הדוח, כמו JULY.	לא רלוונטי	כן
`billingYear`	הערה: אי אפשר להשתמש במאפיין הזה בדוחות הכנסות. שנת החיוב של הדוח, למשל 2015.	לא רלוונטי	כן
`currCriteria`	המזהה והארגון של מטבע ספציפי שייכללו בדוח. אם לא מציינים את המאפיין הזה, כל המטבעות הנתמכים נכללים בדוח.	לא רלוונטי	לא
`currencyOption`	המטבע שמוצג בדוח. הערכים התקפים כוללים: ‫`LOCAL`. כל שורה בדוח מוצגת לפי תוכנית התמחור הרלוונטית. המשמעות היא שאם למפתחים יש תוכניות שמשתמשות במטבעות שונים, יכול להיות שיופיעו כמה מטבעות בדוח אחד. `EUR`. עסקאות במטבע מקומי מומרות ומוצגות באירו. `GPB`. עסקאות במטבע מקומי מומרות ומוצגות בלירה שטרלינג. ‫`USD`. עסקאות במטבע מקומי מומרות ומוצגות בדולר ארה"ב. הערה: אם בוחרים באפשרות EUR, ‏ GBP או USD, בדוח מוצגות כל העסקאות במטבע הזה, על סמך שער החליפין שהיה בתוקף בתאריך העסקה.	לא רלוונטי	לא
`devCriteria`	מזהה המפתח (כתובת אימייל) ושם הארגון של מפתח ספציפי שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל המפתחים נכללים בדוח. לדוגמה: "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"my_org"} ]	לא רלוונטי	לא
`devCustomAttributes`	הערה: המאפיין הזה רלוונטי רק לדוחות על הכנסות. מאפיינים מותאמים אישית שרוצים לכלול בדוח, אם הם הוגדרו למפתח. לדוגמה: "devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ] הערה: אל תציינו את המאפיינים המוגדרים מראש `MINT_` ו-`ADMIN_` במערך `devCustomAttributes`.	לא רלוונטי	לא
`fromDate`	הערה: המאפיין הזה רלוונטי רק לדוחות על הכנסות, שונות ופעילות עסקאות. תאריך ההתחלה של הדוח בפורמט UTC.	לא רלוונטי	חובה בדוחות הכנסות, לא חובה בסוגים אחרים של דוחות.
`groupBy`	הסדר שבו העמודות מקובצות בדוח. הערכים התקפים כוללים: `APPLICATION` `BALANCE` `DEVELOPER` `ORG` `PACKAGE` `PRODUCT` `RATEPLAN`	לא רלוונטי	לא
`monetizationPackageId`	מזהה של חבילת מוצרי API אחת או יותר שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל חבילות המוצרים של ה-API נכללות בדוח. הערה: המאפיין הזה לא תקף כשמציגים את פעילות העסקאות (`/transaction-search`).	לא רלוונטי	לא
`pkgCriteria`	המזהה והארגון של חבילת מוצרי API ספציפית שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל חבילות המוצרים של ה-API נכללות בדוח. אפשר לציין את המאפיין הזה במקום המאפיין `monetizationpackageIds`. הערה: המאפיין הזה לא תקף כשמציגים את פעילות העסקאות (`/transaction-search`).	לא רלוונטי	לא
`prevFromDate`	הערה: המאפיין הזה רלוונטי רק לדוחות שונות. תאריך ההתחלה של תקופה קודמת לפי שעון UTC. הפרמטר הזה משמש ליצירת דוח לתקופה קודמת לצורך השוואה לדוח הנוכחי.	לא רלוונטי	לא
`prevToDate`	הערה: המאפיין הזה רלוונטי רק לדוחות שונות. תאריך הסיום של תקופה קודמת בפורמט UTC. הפרמטר הזה משמש ליצירת דוח לתקופה קודמת לצורך השוואה לדוח הנוכחי.	לא רלוונטי	לא
`prodCriteria`	המזהה והארגון של מוצר API ספציפי שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל מוצרי ה-API נכללים בדוח. אפשר לציין את המאפיין הזה במקום המאפיין `productIds`. הערה: המאפיין הזה לא תקף כשמציגים את פעילות העסקאות (`/transaction-search`).	לא רלוונטי	לא
`productIds`	מזהה של מוצר API אחד או יותר שרוצים לכלול בדוח. אם לא מציינים את המאפיין הזה, כל מוצרי ה-API נכללים בדוח. מזהי מוצרי ה-API צריכים להיות מוגדרים כ-`org-name@@@product-name`. לדוגמה: `"productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]` חשוב: בדוחות סיכום בלבד, צריך להשמיט את החלק `org-name@@@` של מזהה המוצר. לדוגמה: `"productIds": ["myproduct", "myproduct2"]`. אחרת, מאפיינים מותאמים אישית לא יוצגו בדוח הסיכום.	לא רלוונטי	לא
`pricingTypes`	סוג התמחור של תוכנית המחירים שרוצים לכלול בדוח. הערכים התקפים כוללים: ‫`REVSHARE`. תוכנית לחלוקת הכנסות. ‫`REVSHARE_RATECARD`. תוכנית תשלומים של חלוקת הכנסות וכרטיס תעריפים. `RATECARD`. תוכנית מחירון. אם לא מציינים את המאפיין הזה, תוכניות מחירים מכל סוגי התמחור נכללות בדוח.	לא רלוונטי	לא
`ratePlanLevels`	סוג תוכנית התמחור שייכלל בדוח. הערכים התקפים כוללים: ‫`DEVELOPER`. תוכנית תעריפים למפתחים. ‫`STANDARD`. תוכנית תעריפים רגילה. אם לא מציינים את המאפיין הזה, גם תוכניות תמחור ספציפיות למפתחים וגם תוכניות תמחור רגילות נכללות בדוח.	לא רלוונטי	לא
`showRevSharePct`	דגל שמציין אם בדוח מוצגים אחוזים של חלוקת הכנסות. הערכים התקינים כוללים: `true`. הצגת אחוזים של חלוקת הכנסות. `false`. לא להציג את אחוז חלוקת ההכנסות.	לא רלוונטי	לא
`showSummary`	דגל שמציין אם הדוח הוא סיכום. הערכים התקפים כוללים: ‫`true`. הדוח הוא סיכום. ‫`false`. הדוח לא מסכם את הנתונים.	לא רלוונטי	לא
`showTxDetail`	הערה: המאפיין הזה רלוונטי רק לדוחות על הכנסות. דגל שמציין אם בדוח מוצגים פרטים ברמת העסקה. הערכים התקינים כוללים: `true`. הצגת פרטים ברמת העסקה. `false`. לא מוצגים פרטים ברמת העסקה.	לא רלוונטי	לא
`showTxType`	דגל שמציין אם בדוח מוצג סוג כל עסקה. הערכים התקינים כוללים: `true`. הצגת הסוג של כל טרנזקציה. `false`. לא להציג את הסוג של כל עסקה.	לא רלוונטי	לא
`toDate`	הערה: המאפיין הזה רלוונטי רק לדוחות על הכנסות, שונות ופעילות עסקאות. תאריך הסיום של הדוח בפורמט UTC. הדוח כולל נתונים שנאספו עד סוף היום שלפני התאריך שצוין. נתוני הדוח שנאספו בתאריך הסיום שצוין לא ייכללו בדוח. לדוגמה, אם רוצים להגדיר שתוקף תוכנית המחירים יפוג ב-31 בדצמבר 2016, צריך להגדיר את הערך של toDate ל-2017-01-01. במקרה כזה, הדוח יכלול נתונים עד סוף היום של 31 בדצמבר 2016, אבל לא יכלול נתונים מ-1 בינואר 2017.	לא רלוונטי	חובה בדוחות הכנסות, לא חובה בסוגים אחרים של דוחות.
`transactionStatus`	הסטטוס של הטרנזקציות שייכללו בדוח. הערכים התקפים כוללים: ‫`SUCCESS`. העסקה בוצעה בהצלחה. ‫`DUPLICATE`. עסקאות כפולות. אפשר להתעלם מהעסקאות האלה. לפעמים צינור הנתונים מ-Apigee runtime לשרת הדירוג יוצר עסקאות כפולות כדי להיות סובלני לתקלות, והמערכת למונטיזציה מזהה אותן ומסמנת אותן ככפולות. `FAILED`. העסקה נכשלה. הסטטוס הזה מופעל כשהאימות של תנאי מוקדם נכשל. לדוגמה: היה ניסיון לדרג למרות שהמפתח לא רכש תוכנית תמחור. זה יכול לקרות אם המדיניות 'בדיקת מגבלות המונטיזציה' לא מוגדרת. חריגה מהמכסה, אבל השיחות נמשכות. זה יכול לקרות אם המדיניות 'בדיקת מגבלות המונטיזציה' לא מוגדרת. נשלח ערך מאפיין שלילי עבור תוכנית שמבוססת על מאפיין מותאם אישית. ‫`INVALID_TSC`. העסקה לא חוקית. הסטטוס הזה מופעל כש`txProviderStatus` קריטריוני זמן הריצה לא תואמים לקריטריונים להצלחה שצוינו ברמת חבילת מוצרי ה-API. `REVIEW`. עסקאות שנדרשת בדיקה לגביהן. הסטטוס הזה מופעל בתוכניות עם שיעור גמיש של חלוקת ההכנסות אם הערך נמצא בטווח הכנסות שלא הוגדר. הערה: סטטוס `FINAL` כבר לא מוחזר על ידי המונטיזציה של Apigee.	לא רלוונטי	לא
`transactionCustomAttributes`	מאפייני עסקאות בהתאמה אישית שייכללו בדוחות סיכום ההכנסות. צריך להפעיל את התכונה הזו בארגון. מידע נוסף על הכללת מאפייני עסקאות מותאמים אישית בדוחות סיכום הכנסות	לא רלוונטי	לא
`transactionTypes`	סוג הטרנזקציות שייכללו בדוח. הערכים התקפים כוללים: ‫`PURCHASE`: המספר הכולל של העסקאות. רלוונטי רק לתוכניות לחלוקת הכנסות. ‫`CHARGE`: חיוב שמחושב על סמך תוכנית התמחור ומספר העסקאות במהלך תקופת הדיווח על השימוש, שמתחילה בתאריך שבו המפתח רכש את תוכנית התמחור. הערה: התקופה שמוצגת בדוחות השימוש שמשמשת לחישוב הערך של `CHARGE` לא זהה לתקופת החיוב. `REFUND`: החזרים כספיים שהונפקו. איך שולחים החזרים כספיים ‫`CREDIT`: קרדיטים שהונפקו. מידע נוסף על הנפקת קרדיטים ‫`BALANCE`: היתרה שנותרה בחשבונות בתשלום מראש. מידע נוסף זמין במאמר בנושא ניהול היתרות בחשבון בתשלום מראש. ‫`SETUPFEES`: הגדרת עמלות לחיוב. איך מגדירים עמלות לתוכנית תמחור ‫`TERMINATIONFEES`: עמלות על סיום מוקדם של החוזה. איך מגדירים עמלות לתוכנית תמחור ‫`RECURRINGFEES`: חיובים חוזרים שחויבו. אפשר לקרוא את המאמרים הגדרת חיובים בתוכנית תמחור באמצעות API ומתי מתבצע חיוב על עמלות חוזרות ומתי מתבצע איפוס של תוכניות חבילה?. ‫`TRUEUP`: עסקאות שמשמשות להתאמה מחדש של עסקאות שסווגו. הן מופעלות כשמתבצעים שינויים במס בחודש החיוב הקודם. אם לא מציינים את המאפיין הזה, כל סוגי העסקאות נכללים בדוח.	לא רלוונטי	לא