תבניות הגדרת תצורה מרחוק וניהול גרסאות

Firebase מסוף

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

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

Firebase CLI

firebase remoteconfig:versions:list

אפשר להשתמש באפשרות --limit כדי להגביל את מספר הגרסאות שיוחזרו. כדי לאחזר את כל הגרסאות, מעבירים את הערך '0'.

Node.js

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Java

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

REST

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

Firebase מסוף

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

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

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

אפשר גם לכתוב את הפלט לקובץ מסוים באמצעות -o, FILENAME.

Node.js

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

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

REST

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

הפרמטר של כתובת ה-URL ?version_number תקף רק לפעולות GET. אי אפשר להשתמש בו כדי לציין מספרי גרסאות של עדכונים. בקשת get דומה ללא הפרמטר ?version_number תשחזר את התבנית הפעילה הנוכחית.

Firebase מסוף

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

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

Node.js

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Java

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

REST

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

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

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

Firebase מסוף

1. בכרטיסייה Remote Config Parameters or Conditions, פותחים את more_vertMenu ובוחרים באפשרות Download current config file.
2. כשמופיעה בקשה, לוחצים על Download config file, בוחרים את המיקום שבו רוצים לשמור את הקובץ ולוחצים על Save.

Firebase CLI

firebase remoteconfig:get -o filename

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());

REST

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

הפקודה הזו מפיקה את עומס העבודה של ה-JSON לקובץ אחד, ואת הכותרות (כולל ה-ETag) לקובץ headers נפרד.

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());
  }
}

REST

כדי לאמת את עדכוני התבנית, מוסיפים את פרמטר כתובת ה-URL ?validate_only=true לבקשת הפרסום:

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?validate_only=true -d @filename

אם התבנית אומתה, הפקודה curl תחזיר את תבנית ה-JSON ששלחתם, ובקובץ headers שנשמר יופיע סטטוס HTTP/2 200 ו-ETag מעודכן עם הסיומת -0. אם התבנית לא אומתה, תקבלו את הודעת השגיאה של האימות בתגובת ה-JSON, וקובץ headers יכיל תגובה שאינה 200 (וללא ETag).

Firebase מסוף

1. בכרטיסייה Remote Config Parameters or Conditions, פותחים את more_vertMenu ובוחרים באפשרות Publish from a file.
2. כשמופיעה בקשה לכך, לוחצים על Browse, עוברים לקובץ Remote Config שרוצים לפרסם ובוחרים אותו. לאחר מכן לוחצים על Select.
3. הקובץ יאומת, ואם התהליך יסתיים בהצלחה, תוכלו ללחוץ על פרסום כדי שההגדרות יהיו זמינות באופן מיידי לאפליקציות ולמשתמשים שלכם.

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());
  }
}

REST

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 הזו, אפשר לציין את התוכן באמצעות התו "@" ואחריו שם הקובץ.

REST

curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=file_format'

משתמשים ב-XML, ב-PLIST או ב-JSON בתור הערך של format, בהתאם לפורמט הקובץ שרוצים להוריד.

Firebase מסוף

1. בכרטיסייה Parameters, פותחים את more_vertMenu ובוחרים באפשרות Download default values.
2. כשמופיעה בקשה, לוחצים על לחצן הבחירה שתואם לפורמט הקובץ שרוצים להוריד, ואז לוחצים על הורדת הקובץ.