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

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

מבוא

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

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

תיבת כלים

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

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

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

  1. לחץ על 'הוסף' בקטע 'התראות' שבדף 'הוספת מגבלה'. הקטע 'התראות' ייפתח.

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

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

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

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

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

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

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

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

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

    • תיבת הסימון 'הפסק את הביצוע' מסומנת.
    • רמת ההתראה היא 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
    

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

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

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

    • לוחצים על Edit (עריכה) מימין לתבנית.
    • הוספה של ${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

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

השלבים הבאים

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