מסמך עזר של ביטוי מותנה של הגדרת תצורה מרחוק

בדף הזה מופיע מידע עזר בנושא יצירה של ביטויים מותנים באמצעות ממשקי API לקצה העורפי של Remote Config או באמצעות מסוף Firebase. מידע נוסף על הגדרה ושימוש בממשקי ה-API לקצה העורפי זמין במאמר שינוי של Remote Config באופן פרוגרמטי.

רכיבים המשמשים ליצירת תנאים

ב-API ל-REST של Remote Config יש תמיכה באותם הרכיבים שבהם אפשר להשתמש כדי ליצור תנאים כשמגדירים את Remote Config באמצעות מסוף Firebase:

רכיב תיאור
&&

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

הערה: צריך להוסיף רווח לפני ואחרי תווי אמפרסנד (&). לדוגמה: element1 && element2.

app.build

הפונקציה מקבלת את הערך TRUE או FALSE על סמך הערך של מספר ה-build של האפליקציה.

הערה: התכונה הזו זמינה רק במכשירי Apple ו-Android. ל-Apple, משתמשים בערך של CFBundleVersion, ול-Android משתמשים בערך של versionCode.

app.version

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

הערה: במכשירי Android, משתמשים בערך של versionName, ובמכשירי Apple משתמשים בערך של CFBundleShortVersionString.

app.id רכיב שמבוסס על מזהה האפליקציה ב-Firebase של האפליקציה
app.audiences רכיב שמקבל את הערך TRUE או FALSE בהתאם לנוכחות או להיעדר של המשתמש בקהל אחד או יותר ב-Firebase Analytics.
app.firstOpenTimestamp רכיב שמבוסס על הפעם הראשונה שבה המשתמש מפעיל אפליקציה, שמתקבל מהאירוע Google Analytics first_open. פורמט התאריך הוא לפי תקן ISO, עם אפשרות לציין אזור זמן קבוע. לדוגמה: app.firstOpenTimestamp >= ('2022-10-31T14:37:47', 'America/Los_Angeles'). אם לא צוין אזור זמן, המערכת תשתמש ב-GMT.
app.userProperty רכיב שהערך שלו הוא TRUE או FALSE על סמך הערך המספרי או המחרוזת של מאפיין משתמש של Firebase Analytics.
app.operatingSystemAndVersion

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

הערה: התכונה הזו זמינה רק לאפליקציות אינטרנט.

app.browserAndVersion

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

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

app.firebaseInstallationId רכיב שמבוסס על המזהים של התקנות במכשירים ספציפיים. הפונקציה מבצעת הערכה ל-TRUE כאשר מזהה ההתקנה תואם לאחד ממזהי ההתקנה שצוינו.
device.country רכיב שמבוסס על האזור או המדינה שבהם המכשיר נמצא, לפי תקן ISO 3166-1 alpha-2 (לדוגמה, ארה"ב או בריטניה). הפונקציה מקבלת את הערך TRUE כשמדינה תואמת לקוד מדינה צפוי.
device.dateTime רכיב שמבוסס על השעה של האחזור האחרון שהמכשיר ביצע. פורמט תאריך ISO עם אפשרות לציין אזור זמן קבוע, לדוגמה dateTime('2017-03-22T13:39:44', 'America/Los_Angeles').
device.language רכיב שמבוסס על השפה שנבחרה במכשיר. השפה מיוצגת באמצעות תג שפה של IETF, כמו es-ES, ‏ pt-BR או en-US. הפונקציה מבצעת הערכה לערך TRUE כאשר שפה תואמת לקוד שפה צפוי.
device.os רכיב שמבוסס על מערכת ההפעלה שבה נעשה שימוש במכשיר (Apple או Android). הפונקציה מקבלת את הערך TRUE כשמערכת ההפעלה של המכשיר היא מהסוג הצפוי.
percent ההערכה היא באמצעות TRUE על סמך הכללת המשתמש באחוז עשרוני שמוקצה באופן אקראי (עם גודל הדגימה קטן עד 0.000001%).

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

  1. name מוגדר באופן שרירותי (עד 100 תווים)
  2. ביטוי מותנה ששווה ל-TRUE או ל-FALSE, שמורכב מהרכיבים שמוצגים למעלה.
  3. (אופציונלי) tagColor, שיכול להיות 'BLUE', 'BROWN', 'CYAN', 'DEEP_ORANGE', 'GREEN', 'INDIGO', 'LIME', 'ORANGE', 'PINK', 'PURPLE' או 'TEAL'. הצבע לא תלוי אותיות רישיות ומשפיע רק על האופן שבו התנאים מוצגים במסוף Firebase.

אופרטורים נתמכים

לדוגמה, הפונקציה app.build.notContains([123, 456]) מחזירה את הערך TRUE אם גרסת build האפליקציה בפועל היא 123 או 492, אבל מחזירה את הערך FALSE אם גרסת build האפליקציה בפועל היא 999. לדוגמה, הפונקציה app.version.notContains([123, 456]) מחזירה את הערך TRUE אם גרסת האפליקציה בפועל היא 123 או 492, אבל מחזירה את הערך FALSE אם גרסת האפליקציה בפועל היא 999.
רכיב אופרטורים נתמכים תיאור
app.audiences .inAtLeastOne([...]) הפונקציה מחזירה את הערך TRUE אם הקהל בפועל תואם לפחות לשם אחד של קהל ברשימה.
לדוגמה:

app.audiences.inAtLeastOne(['Audience 1', 'Audience 2'])

app.audiences .notInAtLeastOne([...]) הפונקציה מחזירה את הערך TRUE אם הקהל בפועל לא תואם לפחות לשם אחד של קהל ברשימה.
app.audiences .inAll([...]) הפונקציה מחזירה את הערך TRUE אם הקהל בפועל הוא חבר בכל שם של קהל ברשימה.
app.audiences .notInAll([...]) הפונקציה מחזירה את הערך TRUE אם הקהל בפועל לא חבר באף קהל ברשימה.
app.firstOpenTimestamp <=, > הפונקציה משווה בין השעה של האירוע first_open לשעה שצוינה בתנאים, ומחזירה את הערך TRUE או FALSE בהתאם לאופרטורים.
דוגמה לשימוש:
app.firstOpenTimestamp >= ('2022-10-31T14:37:47', 'America/Los_Angeles').
כדי לציין טווח:
app.firstOpenTimestamp >= ('2022-11-01T00:00:00') && app.firstOpenTimestamp < ('2022-12-01T00:00:00') אם לא צוין אזור זמן, משתמשים באזור הזמן GMT.
app.userProperty <, <=, ==, !=, >=, > הפונקציה מחזירה את הערך TRUE אם מאפיין המשתמש בפועל תואם באופן מספרי לערך שצוין, בהתאם לאופרטור.
app.userProperty .contains([...]) הפונקציה מחזירה את הערך TRUE אם אחד מערכי היעד הוא מחרוזת משנה של מאפיין המשתמש בפועל.
app.userProperty .notContains([...]) הפונקציה מחזירה את הערך TRUE אם אף אחד מערכי היעד לא הוא מחרוזת משנה של מאפיין המשתמש בפועל.
app.userProperty .exactlyMatches([...]) הפונקציה מחזירה את הערך TRUE אם מאפיין המשתמש בפועל תואם בדיוק (תלוי אותיות רישיות) אחד מערכי היעד ברשימה.
app.userProperty .matches([...]) הפונקציה מחזירה את הערך TRUE אם אחד מהביטויים הרגולטוריים של היעד ברשימה תואם למחרוזת משנה של הערך בפועל, או לערך כולו. כדי לאלץ התאמה של המחרוזת כולה, מוסיפים לתחילת הביטוי הרגולרי את התו "^" ולסוף שלו את התו "$". המערכת משתמשת בתחביר של RE2.
app.id == הפונקציה מחזירה את הערך TRUE אם הערך שצוין תואם למזהה האפליקציה.
app.build <, <=, ==, !=, >=, > הפונקציה מחזירה את הערך TRUE אם גרסת ה-build של האפליקציה בפועל משווה מבחינה מספרית לערך שצוין באופן שתואם לאופרטור.
app.build .contains([...]) הפונקציה מחזירה את הערך TRUE אם אחד מערכי היעד הוא מחרוזת משנה של גרסה בפועל של האפליקציה. לדוגמה, "a" ו-"bc" הם מחרוזות משנה של "abc".
app.build .notContains([...]) הפונקציה מחזירה את הערך TRUE אם אף אחד מערכי היעד לא הוא מחרוזת משנה של גרסה build בפועל של האפליקציה.
app.build .exactlyMatches([...]) הפונקציה מחזירה את הערך TRUE אם גרסת ה-build בפועל של האפליקציה תואמת בדיוק לאחד מערכי היעד ברשימה.
app.build .matches([...]) הפונקציה מחזירה את הערך TRUE אם ביטוי רגולרי כלשהו ברשימה תואם למחרוזת משנה של הערך בפועל או את הערך כולו. כדי לבצע התאמה לפי הגדרת האדמין של כל המחרוזת, כדאי להוסיף את הביטוי הרגולרי "^" לפני ואחרי הביטוי "$". לשם כך, צריך להשתמש בתחביר RE2.
app.version <, <=, ==, !=, >=, > הפונקציה מחזירה את הערך TRUE אם גרסת האפליקציה בפועל משווה מבחינה מספרית לערך שצוין באופן שתואם לאופרטור.
app.version .contains([...]) הפונקציה מחזירה את הערך TRUE אם אחד מערכי היעד הוא מחרוזת משנה של גרסת האפליקציה בפועל. לדוגמה, "a" ו-"bc" הם מחרוזות משנה של "abc".
app.version .notContains([...]) הפונקציה מחזירה את הערך TRUE אם אף אחד מערכי היעד אינו מחרוזת משנה של גרסת האפליקציה בפועל.
app.version .exactlyMatches([...]) הפונקציה מחזירה את הערך TRUE אם גרסת האפליקציה בפועל תואמת במדויק לאחד מערכי היעד ברשימה.
app.version .matches([...]) הפונקציה מחזירה את הערך TRUE אם אחד מהביטויים הרגולריים של היעד ברשימה תואם למחרוזת משנה של הערך בפועל, או לערך כולו. כדי לאלץ התאמה של המחרוזת כולה, מוסיפים לביטוי הרגולרי את התו '^' בתחילת הביטוי ואת התו '$' בסוף הביטוי. המערכת משתמשת בתחביר של RE2.
app.operatingSystemAndVersion .inOne([...]) הפונקציה מחזירה את הערך TRUE אם מערכת ההפעלה והגרסה תואמים לאחד מהערכים של היעד ברשימה.
לדוגמה:

    app.operatingSystemAndVersion.inOne([operatingSystemName('Macintosh').version.==('10.15')])
    

app.browserAndVersion .inOne([...]) הפונקציה מחזירה את הערך TRUE אם הדפדפן והגרסה תואמים לכל אחד מערכות היעד ברשימה.
לדוגמה:

    app.browserAndVersion.inOne([browserName('Chrome').anyVersion])
    

app.firebaseInstallationId in [...] הפונקציה מחזירה את הערך TRUE אם מזהה ההתקנה תואם לאחד מהפריטים ברשימה. שימוש לדוגמה: app.firebaseInstallationId in ['eyJhbGciOiJFUzI1N_iIs5', 'eapzYQai_g8flVQyfKoGs7']
device.country in [...] הפונקציה מחזירה את הערך TRUE אם המדינה של המכשיר תואמת לאחת מהמדינות שצוינו ברשימה. דוגמה לשימוש: device.country in ['gb', 'us']. קוד המדינה של המכשיר נקבע לפי כתובת ה-IP של המכשיר בבקשה, או לפי קוד המדינה שנקבע על ידי Firebase Analytics (אם נתוני Analytics משותפים עם Firebase).
device.dateTime <=, > הפונקציה משווה בין השעה הנוכחית לבין השעה היעד של התנאי, ומחזירה את הערך TRUE או FALSE בהתאם לאופרטור. שימוש לדוגמה: dateTime < dateTime('2017-03-22T13:39:44').
device.language in [...] הפונקציה מחזירה את הערך TRUE אם אחת מהשפות של האפליקציה תואמת לשפה כלשהי ברשימה. דוגמה לשימוש: device.language in ['en-UK', 'en-US'].
device.os ==, != הפונקציה מחזירה את הערך TRUE אם מערכת ההפעלה של המכשיר משווה את הערך בשדה הזה לערך התואם לאופרטור.
percent <=,‏ >,‏ between הפונקציה מחזירה את הערך TRUE אם הערך בשדה percent תואם לערך שהוקצה באופן אקראי בהתאם לאופרטור.

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

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

percent('keyName') <= 10

כדי להגדיר טווח ספציפי, אפשר להשתמש באופרטור between. כדי להגדיר טווח של משתמשים בין 20 ל-60 באמצעות seed שמוגדר כברירת מחדל:

percent between 20 and 60

כדי להגדיר טווח של משתמשים בין 60 ל-80 באמצעות מקור מותאם אישית:

percent('seedName') between 60 and 80