שינוי הגדרת התצורה מרחוק באופן פרוגרמטי

Config templates using the Admin SDK, REST API, and Firebase CLI. page_type: guide

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

באמצעות ה-API בארכיטקטורת REST של Remote Config, Admin SDKs או ה-CLI של Firebase שמתוארים במדריך הזה, אתם יכולים לעקוף את ניהול התבנית במסוף Firebase כדי לשלב ישירות את השינויים ב-Remote Config בתהליכים שלכם. לדוגמה, באמצעות ממשקי API לקצה העורפי של Remote Config, אתם יכולים:

  • תזמון עדכונים של Remote Config. אפשר להשתמש בקריאות ל-API בשילוב עם משימת cron כדי לשנות את הערכים של Remote Config באופן קבוע.
  • ייבוא של ערכי הגדרות בכמות גדולה כדי לעבור ביעילות מהמערכת הקניינית שלכם אל Firebase Remote Config.
  • משתמשים ב-Remote Config עם Cloud Functions for Firebase, ומשנים ערכים באפליקציה על סמך אירועים שמתרחשים בצד השרת. לדוגמה, אתם יכולים להשתמש ב-Remote Config כדי לקדם תכונה חדשה באפליקציה, ואז להשבית את הקידום באופן אוטומטי אחרי שזיהיתם שמספיק אנשים השתמשו בתכונה החדשה.

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

בקטעים הבאים במדריך מתוארות הפעולות שאפשר לבצע באמצעות ממשקי ה-API לקצה העורפי של Remote Config.

משנים את Remote Config באמצעות Firebase Admin SDK

‫Admin SDK הוא קבוצה של ספריות שרת שמאפשרות לכם ליצור אינטראקציה עם Firebase מסביבות עם הרשאות. בנוסף לעדכונים ב-Remote Config, ה-Admin SDK מאפשר ליצור ולאמת אסימוני אימות של Firebase, ולקרוא ולכתוב מ-Realtime Database. במאמר הוספת Firebase Admin SDK לשרת מוסבר איך להגדיר את Admin SDK ומה הדרישות המוקדמות.

כדי לבדוק קוד לדוגמה שמבצע את המשימות האלה באמצעות Admin SDK, אפשר לעיין באחת מהאפליקציות הבאות למתחילים:

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

הפעלה של ה-SDK ואישור בקשות API

כשמפעילים את Admin SDK בלי פרמטרים, ה-SDK משתמש בApplication Default Credentials וקורא את האפשרויות ממשתנה הסביבה FIREBASE_CONFIG. אם התוכן של המשתנה FIREBASE_CONFIG מתחיל ב-{, הוא ינותח כאובייקט JSON. אחרת, ה-SDK מניח שהמחרוזת היא השם של קובץ JSON שמכיל את האפשרויות.

לדוגמה:

Node.js

const admin = require('firebase-admin');
admin.initializeApp();

Java

FileInputStream serviceAccount = new FileInputStream("service-account.json");
FirebaseOptions options = FirebaseOptions.builder()
        .setCredentials(GoogleCredentials.fromStream(serviceAccount))
        .build();
FirebaseApp.initializeApp(options);

הורדת התבנית הנוכחית של Remote Config

כשעובדים עם תבניות Remote Config, חשוב לזכור שיש להן גרסאות, ולכל גרסה יש משך חיים מוגבל מרגע היצירה ועד שמחליפים אותה בעדכון: 90 יום, עם מגבלה כוללת של 300 גרסאות מאוחסנות. מידע נוסף זמין במאמר תבניות וניהול גרסאות.

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

פרמטרים וערכי פרמטרים שנוצרו במיוחד כווריאציות בניסוי ב-A/B Testing לא נכללים בתבניות שמייצאים.

כדי לקבל את התבנית:

Node.js

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

שינוי של Remote Config פרמטרים

אתם יכולים לשנות ולהוסיף פרמטרים וקבוצות פרמטרים של Remote Config באופן פרוגרמטי. לדוגמה, לקבוצת פרמטרים קיימת בשם "new_menu" אפשר להוסיף פרמטר שישלוט בהצגת מידע עונתי:

Node.js

function addParameterToGroup(template) {
  template.parameterGroups['new_menu'].parameters['spring_season'] = {
    defaultValue: {
      useInAppDefault: true
    },
    description: 'spring season menu visibility.',
  };
}

Java

template.getParameterGroups().get("new_menu").getParameters()
        .put("spring_season", new Parameter()
                .setDefaultValue(ParameterValue.inAppDefault())
                .setDescription("spring season menu visibility.")
        );

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

שינוי Remote Config תנאים

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

Node.js

function addNewCondition(template) {
  template.conditions.push({
    name: 'android_en',
    expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']',
    tagColor: 'BLUE',
  });
}

Java

template.getConditions().add(new Condition("android_en",
        "device.os == 'android' && device.country in ['us', 'uk']", TagColor.BLUE));

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

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

אימות התבנית של Remote Config

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

Node.js

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

Java

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

בתהליך האימות נבדקות שגיאות כמו מפתחות כפולים של פרמטרים ותנאים, שמות לא חוקיים של תנאים או תנאים שלא קיימים, או תגי ישות (etag) בפורמט שגוי. לדוגמה, אם בקשה מכילה יותר מ-2,000 מפתחות (המספר המותר), תוחזר הודעת השגיאה Param count too large.

פרסום התבנית של Remote Config

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

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

התבניות שאתם מורידים כוללות את ההתאמות האישיות והתנאים של Remote Config, ולכן חשוב לשים לב למגבלות הבאות כשמנסים לפרסם בפרויקט אחר:

  • אי אפשר לייבא התאמות אישיות מפרויקט לפרויקט.

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

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

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

  • אם התבנית שאתם מתכננים לפרסם מכילה תנאים שמסתמכים על Google Analytics, צריך להפעיל את Analytics בפרויקט היעד.

Node.js

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

Java

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

שינוי של Remote Config באמצעות API בארכיטקטורת REST

בקטע הזה מתוארות היכולות העיקריות של ה-API בארכיטקטורת REST של Remote Config ב-https://firebaseremoteconfig.googleapis.com. לפרטים מלאים, קראו את מאמרי העזרה של ה-API.

קבלת טוקן גישה לאימות בקשות API ומתן הרשאה להן

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

אפשר לראות את כל חשבונות השירות של הפרויקט ב-Firebase בכרטיסייה Settings > Service accounts.

כדי לאמת חשבון שירות ולתת לו הרשאת גישה לשירותי Firebase, צריך ליצור קובץ מפתח פרטי בפורמט JSON.

כדי ליצור קובץ מפתח פרטי לחשבון השירות:

  1. במסוף Firebase, נכנסים לכרטיסייה Settings > Service accounts.

  2. לוחצים על Generate New Private Key ואז על Generate Key כדי לאשר.

  3. שומרים באופן מאובטח את קובץ ה-JSON שמכיל את המפתח.

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

כדי להגדיר את משתנה הסביבה:

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

Linux או macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_FILE_PATH"

Windows

באמצעות PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_FILE_PATH"

אחרי שתבצעו את הפעולות שלמעלה, Application Default Credentials ‏(ADC) יוכל לקבוע באופן משתמע את פרטי הכניסה שלכם, וכך תוכלו להשתמש בפרטי כניסה לחשבון שירות כשאתם בודקים או מריצים בסביבות שהן לא של Google.

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

node.js

 function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
}

בדוגמה הזו, ספריית הלקוח של Google API מאמתת את הבקשה באמצעות אסימון אינטרנט מסוג JSON, או JWT. מידע נוסף מופיע במאמר אסימוני אינטרנט מסוג JSON.

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

Java

public static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refreshAccessToken();
  return googleCredentials.getAccessToken().getTokenValue();
}

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

כדי לאשר גישה אל Remote Config, צריך לבקש את ההיקף https://www.googleapis.com/auth/firebase.remoteconfig.

שינוי התבנית Remote Config

כשעובדים עם תבניות של Remote Config, חשוב לזכור שלכל גרסה יש משך חיים מוגבל מרגע היצירה ועד שמחליפים אותה בעדכון: 90 יום, עם מגבלה כוללת של 300 גרסאות מאוחסנות. מידע נוסף זמין במאמר תבניות וניהול גרסאות.

הורדת התבנית הנוכחית של Remote Config

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

פרמטרים וערכי פרמטרים שנוצרו במיוחד כווריאציות בניסוי ב-A/B Testing לא נכללים בתבניות שמייצאים.

משתמשים בפקודות הבאות:

cURL

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

הפקודה הזו מוציאה את המטען הייעודי (payload) של ה-JSON לקובץ אחד, ואת הכותרות (כולל ה-Etag) לקובץ נפרד.

בקשת HTTP גולמית

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/my-project-id/remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

הקריאה הזו ל-API מחזירה את ה-JSON הבא, יחד עם כותרת נפרדת שכוללת ETag שמשמש לבקשה הבאה.

אימות התבנית של Remote Config

אם רוצים, אפשר לאמת את העדכונים לפני שמפרסמים אותם. כדי לאמת את העדכונים בתבנית, מוסיפים לבקשת הפרסום את הפרמטר ?validate_only=true של כתובת ה-URL. אם בתגובה מופיע קוד סטטוס 200 ו-etag מעודכן עם הסיומת -0, סימן שהעדכון אומת בהצלחה. כל תגובה שהיא לא 200 מציינת שנתוני ה-JSON מכילים שגיאות שצריך לתקן לפני הפרסום.

עדכון התבנית Remote Config

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

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

התבניות שאתם מורידים כוללות את ההתאמות האישיות והתנאים של Remote Config, ולכן חשוב לשים לב למגבלות הבאות כשמנסים לפרסם בפרויקט אחר:

  • אי אפשר לייבא התאמות אישיות מפרויקט לפרויקט.

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

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

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

  • אם התבנית שאתם מתכננים לפרסם מכילה תנאים שמסתמכים על Google Analytics, צריך להפעיל את Analytics בפרויקט היעד.

cURL

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

בפקודה curl, אפשר לציין את התוכן באמצעות התו "@" ואחריו שם הקובץ.

בקשת HTTP גולמית

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

מכיוון שזו בקשת כתיבה, הפקודה הזו משנה את ה-ETag, ו-ETag מעודכן מופיע בכותרות התגובה של הפקודה הבאה של PUT.

שינוי Remote Config תנאים

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

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all
      capital letters."
    }
  }
}

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

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

קודי שגיאה של HTTP

קוד סטטוס משמעות
200 העדכון בוצע בהצלחה
400 הייתה שגיאה באימות. לדוגמה, בקשה שמכילה יותר ממספר המפתחות המותר (2,000) תחזיר את השגיאה ‎400 (Bad Request)‎ עם הודעת השגיאה Param count too large. בנוסף, קוד הסטטוס הזה של HTTPS יכול להופיע בשני המצבים הבאים:
  • אירעה שגיאה של חוסר התאמה בין גרסאות כי קבוצת הערכים והתנאים עודכנה מאז שאחזרתם לאחרונה ערך ETag. כדי לפתור את הבעיה, צריך להשתמש בפקודה GET כדי לקבל תבנית חדשה וערך ETag חדש, לעדכן את התבנית ואז לשלוח את התבנית עם ערך ה-ETag החדש.
  • בוצעה פקודת PUT (בקשה לעדכון תבנית Remote Config) בלי לציין כותרת If-Match.
401 אירעה שגיאת הרשאה (לא סופק טוקן גישה או ש-Firebase Remote Config API בארכיטקטורת REST לא נוסף לפרויקט שלכם במסוף Cloud Developer)
403 אירעה שגיאת אימות (סופק טוקן גישה שגוי)
500 אירעה שגיאה פנימית. אם השגיאה הזו מתרחשת, שלחו כרטיס תמיכה של Firebase.

קוד סטטוס 200 מציין שהתבנית Remote Config (הפרמטרים, הערכים והתנאים של הפרויקט) עודכנה, ועכשיו היא זמינה לאפליקציות שמשתמשות בפרויקט הזה. קודי סטטוס אחרים מציינים שהתבנית Remote Config שהייתה קיימת קודם עדיין בתוקף.

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

שימוש ב-ETag ועדכונים כפויים

‫Remote Config API בארכיטקטורת REST משתמש בתג ישות (ETag) כדי למנוע מרוץ תהליכים ועדכונים חופפים למשאבים. מידע נוסף על תגי ETag זמין במאמר ETag – HTTP.

ב-API בארכיטקטורת REST, מומלץ לשמור במטמון את ה-ETag שסופק על ידי הפקודה GET האחרונה, ולהשתמש בערך ה-ETag הזה בכותרת הבקשה If-Match כשמפעילים פקודות PUT. אם הפקודה PUT מחזירה את קוד הסטטוס 409 של HTTPS, צריך להריץ פקודת GET חדשה כדי לקבל ETag ותבנית חדשים לשימוש בפקודה PUT הבאה.

אפשר לעקוף את ה-ETag ואת ההגנה שהוא מספק, על ידי אילוץ עדכון של התבנית Remote Config באופן הבא: If-Match: *. עם זאת, הגישה הזו לא מומלצת כי היא עלולה לגרום לאובדן עדכונים בתבנית Remote Config אם כמה לקוחות מעדכנים את התבנית Remote Config. התנגשות כזו יכולה לקרות אם כמה לקוחות משתמשים ב-API, או אם יש עדכונים סותרים מלקוחות API וממשתמשים במסוף Firebase.

במאמר תבניות וניהול גרסאות ב-Remote Config מוסבר איך לנהל את גרסאות התבניות של Remote Config.

שינוי של Remote Config באמצעות ה-CLI של Firebase

ממשק שורת הפקודה של Firebase מאפשר לבדוק, לנהל ולהחזיר לגרסה קודמת תבניות של Remote Config, וגם להציג, לבדוק ולמחוק ניסויים והשקות של Remote Config ישירות משורת הפקודה.

דרישות מוקדמות והגדרה

  1. מתקינים את ה-CLI של Firebase או מעדכנים לגרסה העדכנית.

  2. כניסה אל Firebase:

    firebase login
  3. מגדירים את הפרויקט הפעיל או מציינים את --project PROJECT_ID בכל פקודה:

    firebase use PROJECT_ID

מוודאים שלחשבון או לחשבון השירות יש את הרשאות ה-IAM הנדרשות:

סיכום פקודות CLI

פקודה תיאור
firebase remoteconfig:versions:list רשימה של גרסאות התבניות האחרונות של Remote Config.
firebase remoteconfig:get מקבל תבנית Remote Config (אפשר גם לכתוב לקובץ).
firebase remoteconfig:rollback הפעולה הזו מחזירה את התבנית של Remote Config לגרסה קודמת.
firebase remoteconfig:experiments:list הצגת רשימה של כל הניסויים ב-Remote Config בפרויקט.
firebase remoteconfig:experiments:get הצגת פרטים של ניסוי ספציפי ב-Remote Config.
firebase remoteconfig:experiments:delete מחיקת ניסוי ספציפי ב-Remote Config.
firebase remoteconfig:rollouts:list הצגת רשימה של כל ההשקות של Remote Config בפרויקט.
firebase remoteconfig:rollouts:get קבלת פרטים על השקה ספציפית של Remote Config.
firebase remoteconfig:rollouts:delete מחיקת השקה ספציפית של Remote Config.

שינוי של תבניות וגרסאות של Remote Config

כדי לבדוק, להוריד ולחזור לגרסה קודמת של תבניות Remote Config והיסטוריית הגרסאות שלהן, משתמשים בפקודות הבאות:

הצגת רשימה של גרסאות התבנית

כברירת מחדל, מוצגות 10 הגרסאות האחרונות של התבנית Remote Config, כולל מספר הגרסה, זמן העדכון, מקור העדכון, סוג העדכון ו-updateUser.

firebase remoteconfig:versions:list [--limit NUMBER_OF_VERSIONS]
  • ‫--limit NUMBER_OF_VERSIONS: מספר הגרסאות המקסימלי שיוחזרו. מציינים את הערך 0 כדי להחזיר את כל הגרסאות הקיימות (עד למגבלה של 300 גרסאות מאוחסנות).

דוגמאות:

  • רשימה של 10 הגרסאות האחרונות:

    firebase remoteconfig:versions:list
  • רשימה של כל הגרסאות הזמינות:

    firebase remoteconfig:versions:list --limit 0
  • רשימה של 5 הגרסאות האחרונות:

    firebase remoteconfig:versions:list --limit 5

איך מורידים תבנית

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

firebase remoteconfig:get [-v, --version_number VERSION_NUMBER] [-o, --output FILENAME]
  • ‫-v, --version_number VERSION_NUMBER: מספר הגרסה של התבנית שרוצים לאחזר. אם לא מציינים גרסה, ברירת המחדל היא הגרסה העדכנית.
  • ‫-o, --output FILENAME: כתיבת המטען הייעודי (payload) של התבנית ב-JSON ישירות לנתיב שצוין, במקום הדפסה ל-stdout.

דוגמאות:

  • מציגים את התבנית הפעילה הנוכחית בטרמינל:

    firebase remoteconfig:get
  • מורידים את התבנית הפעילה הנוכחית לקובץ JSON:

    firebase remoteconfig:get -o remote_config_template.json
  • הורדת גרסה היסטורית ספציפית (לדוגמה, גרסה 12) לקובץ:

    firebase remoteconfig:get -v 12 -o remote_config_v12.json

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

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

firebase remoteconfig:rollback [-v, --version_number VERSION_NUMBER] [--force]
  • ‫-v, --version_number VERSION_NUMBER: מספר גרסת היעד שאליה רוצים לחזור. אם לא מציינים גרסה, ברירת המחדל היא הגרסה הקודמת (הגרסה הנוכחית פחות 1).
  • ‫--force: מבצע את החזרה לגרסה הקודמת באופן מיידי בלי לבקש אישור אינטראקטיבי (Y/N). האפשרות הזו שימושית לפייפליינים של CI/CD ולסקריפטים אוטומטיים.

דוגמאות:

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

    firebase remoteconfig:rollback
  • חזרה לגרסה 8 בלי להציג בקשה:

    firebase remoteconfig:rollback -v 8 --force

שינוי של A/B Testing ניסויים

כדי להציג, לבדוק ולמחוק ניסויים של Remote Config A/B Testing ישירות באמצעות ה-CLI, משתמשים בפקודות הבאות:

רשימת ניסויים

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

firebase remoteconfig:experiments:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]
  • ‫--filter EXPRESSION: ביטוי סינון שיוחל על רשימת הניסויים.
  • ‫--pageSize NUMBER: מספר הניסויים שיוחזרו בכל דף (ברירת המחדל היא 10).
  • ‫--pageToken TOKEN: אסימון להיסט של הדף כשמאחזרים תוצאות עם חלוקה לדפים.

דוגמה:

firebase remoteconfig:experiments:list

קבלת פרטי הניסוי

הצגת הפרטים המלאים של ניסוי Remote Config שצוין.

firebase remoteconfig:experiments:get EXPERIMENT_ID

דוגמה:

firebase remoteconfig:experiments:get exp_promo_discount_2026

מחיקת ניסוי

מחיקת הניסוי שצוין ב-Remote Config.

firebase remoteconfig:experiments:delete EXPERIMENT_ID

דוגמה:

firebase remoteconfig:experiments:delete exp_promo_discount_2026

שינוי Remote Config השקות

כדי להציג, לבדוק ולמחוק השקות של Remote Config ישירות באמצעות ה-CLI, משתמשים בפקודות הבאות:

השקות של דפי אפליקציה

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

firebase remoteconfig:rollouts:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]
  • ‫--filter EXPRESSION: ביטוי סינון שיוחל על רשימת ההשקות.
  • ‫--pageSize NUMBER: מספר ההשקות שיוחזרו בכל דף (ברירת המחדל היא 10).
  • ‫--pageToken TOKEN: אסימון להיסט של הדף כשמאחזרים תוצאות עם חלוקה לדפים.

דוגמה:

firebase remoteconfig:rollouts:list

קבלת פרטים על ההשקה

הצגת הפרטים המלאים של השקה ספציפית של Remote Config.

firebase remoteconfig:rollouts:get ROLLOUT_ID

דוגמה:

firebase remoteconfig:rollouts:get rollout_new_checkout_flow

מחיקת השקה

מחיקת ההשקה שצוינה של Remote Config.

firebase remoteconfig:rollouts:delete ROLLOUT_ID

דוגמה:

firebase remoteconfig:rollouts:delete rollout_new_checkout_flow

מידע כללי נוסף על פקודות ה-CLI של Firebase זמין בחומר העזר בנושא ה-CLI של Firebase.