הגדרת התראות על מגבלות

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

מבוא

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

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

תיבת כלים

אפשר להגדיר התראות אוטומטיות על הגבלות באמצעות ממשק הניהול או Monetization API. אם משתמשים בממשק המשתמש, אפשר להגדיר התראות אוטומטיות בדף 'התראות'.

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

הגדרת התראות על הגעה למכסה באמצעות ממשק המשתמש

1. בקטע 'התראות' בדף 'הוספת מגבלה', לוחצים על 'הוספה'. ייפתח הקטע Notification (התראה).

   

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

   לדוגמה, אם הגדרתם תקרת הוצאות של 100 $והגדרתם את ההתראה על 90% ומעלה, ההתראה תישלח כשתגיעו ל-90% מהתקרה (90$) או כשתחרגו ממנה.

   

3. בשדה 'שליחת אימייל', בוחרים מפתח אחד או יותר, או בוחרים משתמש אחד או יותר בארגון. הודעה תישלח למפתחים או למשתמשים שהעדכון הזה משפיע עליהם.

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

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

   כדי להוסיף כתובות אימייל של משתמשים בארגון, בוחרים באפשרות 'משתמשים' בכרטיסייה 'אדמין'.

   תבניות אימייל: תבנית אימייל תוצג אחרי שתבחרו בשדה 'שליחת אימייל' באפשרות 'מפתח נבחר (כלשהו)' או בכתובות אימייל של משתמשים בארגון (או בשתי האפשרויות).מה שיופיע בתבנית תלוי בדברים הבאים:

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

   לדוגמה, אם כל התנאים הבאים מתקיימים:

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

   התבנית נראית כך:

   

   נניח ששם החברה של המפתח הוא XYZ company, שמגבלת נפח העסקאות מוגדרת ל-50 עבור חבילת API בשם X Package ומוצר API בשם Y Product, ושמועד התפוגה מוגדר ל-30 בספטמבר 2013. הודעת האימייל שתישלח תיראה כך:

   Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

   אם כתובת האימייל היא 'מפתח נבחר (כלשהו)', התבנית תופיע כך:

   

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

   אם ההגבלה היא על 'כל' או על אפליקציה ספציפית ועל 'כל' או על משתמש ספציפי, צריך גם להוסיף משתנים לאפליקציות ולמשתמשים לתבנית. כך עושים את זה:

   • לוחצים על סמל העריכה מימין לתבנית.
   • הוספה של ${user.name} user, depending on whether the limit is for application and/or user.

   תבנית שעברה עריכה ל'כל' או לאפליקציה ספציפית מוצגת בהמשך.

   

   אם לא מסומנת האפשרות 'הפסקת הביצוע', או אם רמת ההתראה גדולה מ-100% או שווה לה, התבנית של מפתח נבחר תיראה כך:

   

   שוב, אם המגבלה היא על 'כל' אפליקציה (או על אפליקציה ספציפית) או על 'כל' משתמש (או על משתמש ספציפי), צריך לערוך את התבנית ואז להוסיף ${application.name} אפליקציה ו/או ${user.name} משתמש, בהתאם לסוג המגבלה – על אפליקציה, על משתמש או על שניהם.

   משתני תבנית: כשעורכים את ההודעה בתבנית אימייל, אפשר לכלול כל אחד מהמשתנים הבאים.

   משתנה	תיאור
   ${developer.name}	שם המפתח.
   ${developer.legalName}	שם החברה של המפתח.
   ${ratePlan.monetizationPackage.displayName}	השם של חבילת ה-API.
   ${application.name}	שם האפליקציה.
   ${USER}	שם המשתמש.
   ${USAGE}	השימוש הנוכחי (ההכנסה הכוללת או החיובים, או הנפח).
   ${PERCENT}	אחוז המכסה שהשימוש הנוכחי ניצל.
   ${QUOTA_TYPE}	סוג המגבלה (נפח עסקאות, מגבלת הוצאות או חשיפה לעמלות).
   ${QUOTA_UNIT}	היחידה הבסיסית של המגבלה: מטבע (למגבלת הוצאות) או שיחות (לתקרת התשלומים).
   ${QUOTA_LIMIT}	סכום המגבלה.
   ${EXPIRY_DATE}	התאריך או השעה שבהם המגבלה פגה או מתאפסת.

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

   ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.

4. מוסיפים התראות לפי הצורך לרמות נוספות. כדי להוסיף עוד רמה, לוחצים על 'הוספה'. הפעולה הזו מוסיפה את האזורים 'רמה', 'שליחת אימייל' ו'תבנית אימייל' לקטע 'התראות' בדף. אתם יכולים להוסיף עד 6 רמות לתזכורות. לדוגמה, אם תגדירו את ההתראה כגדולה מ-70%, 80%, 90%, 100%, תישלח התראה כשתגיעו לכל אחת מהרמות האלה.
5. אחרי שמוסיפים את כל ההתראות, לוחצים על 'שמירה' (כדי לשמור ולפרסם את ההתראות בתאריך מאוחר יותר), על 'שמירה ופרסום' (כדי לפרסם עכשיו) או על 'ביטול' (כדי לבטל).

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

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

השלבים הבאים

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