יצירת דוחות מונטיזציה

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

הערה: אי אפשר ליצור דוחות בהתאמה אישית ב-Apigee hybrid. בעיה מוכרת: 355714868

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

• הוספת דוח בהתאמה אישית באמצעות ממשק המשתמש של Apigee
• ‫Stats API
• ‫Queries API (ממשק API אסינכרוני של דוחות בהתאמה אישית)

מדדים ומאפיינים של מונטיזציה

‫Apigee מספק את מדדי המונטיזציה והמאפיינים הבאים:

• מדדים ומאפיינים של עסקאות באמצעות proxy ל-API
• מדדים ומאפיינים של עסקאות בתשלום

מדדים ומאפיינים של עסקאות באמצעות proxy ל-API

בטבלאות הבאות מפורטים x_apigee_mintng_*המדדים והמאפיינים שזמינים לטרנזקציות באמצעות proxy ל-API:

• מדדים

  שם בממשק המשתמש	שם ב-API	תיאור
  מכפיל מחיר של API	x_apigee_mintng_price_multiplier	הפקטור (המכפיל) שבו מכפילים את העלות לכל עסקה.
  חלקם של המפתחים בהכנסות	x_apigee_mintng_dev_share	החלק של מפתח האפליקציה או של קבוצת האפליקציות בהכנסות מעסקה.
  מחיר המונטיזציה	x_apigee_mintng_price	ההכנסה הכוללת מעסקה.
  שיעורי מונטיזציה	x_apigee_mintng_rate	התעריף שחויב על עסקה.

• מאפיינים

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

הערה:

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

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

בטבלאות הבאות מפורטים המדדים והמאפיינים שזמינים רק לטרנזקציות בתשלום:

• מדדים

  שם בממשק המשתמש	שם ב-API	תיאור
  עמלות	עמלות	סכום העמלה.

• מאפיינים

  שם בממשק המשתמש	שם ב-API	תיאור
  שם קבוצת האפליקציות	app_group_name	השם של קבוצת האפליקציות שעליה חלות העמלות, אם רלוונטי. למפתחי אפליקציות, השדה הזה ריק.
  סוג העמלה	fees_type	סוג העמלה: עמלת הקמה, עמלה חוזרת, טעינת יתרה בתשלום מראש או החזר כספי. המאפיין הזה יהיה null כשמשתמשים בו עם מדד כלשהו מלבד fees.
  המועד שבו נוצר החיוב	ההגדרות האישיות נוצרו	חותמת זמן של Unix שבה העמלה נוספה למפתח האפליקציה ולמוצר ה-API. המאפיין הזה null כשמשתמשים בו עם מדד כלשהו מלבד fees.
  מטבע ההכנסות	x_apigee_mintng_currency	מטבע העמלה.
  כתובת האימייל של המפתח	developer_email	מפתח האפליקציה או AppGroup שיחויבו בדמי ההגדרה, בדמי המינוי או בטעינת יתרה בתשלום מראש.
  מזהה המפַתח / מזהה קבוצת האפליקציות	מפתח	המזהה של מפתח האפליקציה או של קבוצת האפליקציות שרשומים ב-Apigee, שאליהם מתייחסות העמלות. אפשר להשתמש בערך הזה לחישובים לצורך חיוב.
  מוצר API	api_product	מוצר API שמתאים לתוכנית התמחור שעליה חל התשלום. הערך ריק עבור סוגים מסוימים של עמלות, כמו טעינת יתרה בתשלום מראש.
  מזהה תוכנית תמחור	x_apigee_mintng_rate_plan_id	שיעור המונטיזציה למפתח האפליקציה. הערך ריק עבור סוגים מסוימים של עמלות, כמו טעינת יתרה בתשלום מראש.
  תחילת התקופה	period_start	תחילת התקופה שעליה נגבות עמלות חוזרות. לדוגמה, אם יש לכם תשלום חודשי, זה היום הראשון של החודש. המאפיין הזה הוא null כשמשתמשים בו עם מדד כלשהו מלבד fees.
  סוף התקופה	period_end	סוף התקופה שעליה נגבות עמלות חוזרות. לדוגמה, אם יש לכם חיוב חודשי, זה יהיה ביום האחרון של החודש. המאפיין הזה הוא null כשמשתמשים בו עם מדד כלשהו מלבד fees.

תיאורים מפורטים של המדדים והמאפיינים האלה זמינים במאמר הפניה למדדים, למאפיינים ולמסננים ב-Analytics.

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

בדוגמה של כל אפליקציה למפתחים מוצגת העלות הכוללת של כל העסקאות מ-1-Apr-2021 to 15-Apr-2021. העלות מחושבת על סמך תמחור מבוסס-צריכה, כפי שהוגדר בתוכנית התמחור שלכם. שימו לב שבדוגמה הזו, המדד (x_apigee_mintng_rate) הוא שדה מונטיזציה, אבל המאפיין (developer_app) הוא שדה שאינו שדה מונטיזציה. לכן, בהתאם לדרישות שלכם, אתם יכולים ליצור דוחות עם שילוב של שדות שקשורים למונטיזציה ושדות שלא קשורים למונטיזציה.

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

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

ייצוא נתוני ניתוח של מונטיזציה

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

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

חשוב: צוות Apigee מוסיף מדי פעם שדות חדשים, ולכן מומלץ לא לכתוב קוד תלוי שייפסק לפעול אם יתווספו שדות חדשים.

• client_received_start_timestamp
• period_end
• period_start
• x_apigee_mintng_currency
• x_apigee_mintng_dev_share
• x_apigee_mintng_price
• x_apigee_mintng_price_multiplier
• x_apigee_mintng_rate
• x_apigee_mintng_rate_plan_id
• x_apigee_mintng_tx_success