遠端設定範本和版本管理

Firebase 個控制台

在「Parameters」分頁中 選取「時鐘」右上方的圖示。系統隨即會開啟 變更記錄 頁面右側會列出所有儲存的範本版本。

為每個儲存的版本顯示的詳細資料，包括 透過 REST API 執行復原程序中的變更 還是因為強制儲存範本而進行增量變更

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

網址參數 ?version_number 只適用於 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 參數或條件 開啟「more_vert選單」分頁，然後 選取「Download current config file」。
2. 系統顯示提示時，請點選「下載設定檔」，選擇儲存位置 然後按一下「儲存」即可儲存檔案。

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

附加網址參數 ?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 參數或條件 開啟「選單」more_vert分頁， 然後選取「從檔案發布」。
2. 系統提示時，按一下「Browse」(瀏覽)，瀏覽至並選取 Remote Config 檔案並按一下「選取」。
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_vert，然後選取 下載預設值。
2. 在系統提示時，按一下與檔案對應的圓形按鈕 格式，然後點選「下載檔案」。