遠端設定範本和版本管理

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 控制台

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

每個儲存版本顯示的詳細資料都包含資訊，包括各項變更是否源自於主控台、使用 REST API、復原為復原，或者是這些變更是否因強制儲存範本而遞增。

Firebase CLI

firebase remoteconfig:versions:list

使用 --limit 選項會限制傳回的版本數量。傳遞「0」即可擷取所有版本。

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 參數的類似 get 要求會擷取目前使用中的範本。

Firebase 控制台

根據預設，「變更記錄」分頁中的詳細資料窗格會顯示目前使用中的範本。如要查看清單中其他版本的詳細資料，請從右側選單中選取。

如要查看目前選取版本和其他儲存版本的詳細差異，請將滑鼠遊標懸停在任何未選取版本的內容選單上，然後選取「Compare with selected version」(與所選版本比較)。

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

您可以選擇使用 -o, FILENAME 將輸出內容寫入指定檔案。

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

如要復原回已儲存的遠端設定範本，請使用自訂方法 :rollback 發出 HTTP POST，然後在要求主體中指定要套用的特定版本。例如：

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 控制台

如果先前範本版本符合復原條件，「變更記錄」頁面的右上方會顯示復原至該版本的選項按鈕。除非您確定要復原至該版本，並「立即」為所有應用程式和使用者使用這些值，否則請勿點選並確認這項操作。

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

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 檔案。

Firebase 控制台

1. 在「Remote Config Parameters or Conditions」分頁中，開啟 more_vert「Menu」，然後選取「Download current config file」。
2. 出現提示時，按一下「Download config file」(下載設定檔)，選擇要儲存檔案的位置，然後按一下「Save」(儲存)。

Firebase CLI

firebase remoteconfig:get -o filename

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)。

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 指令的內容。

Firebase 控制台

1. 在「Remote Config Parameters or Conditions」分頁中，開啟 more_vert「Menu」，然後選取「Publish from a file」。
2. 出現提示時，請按一下「Browse」(瀏覽)，前往並選取要發布的遠端設定檔，然後按一下「Select」(選取)。
3. 檔案會經過驗證，如果成功，您就可以按一下「Publish」(發布)，讓應用程式和使用者立即使用設定。

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「Menu」，然後選取「Download default value」。
2. 出現提示時，按一下與要下載的檔案格式對應的圓形按鈕，然後點選「Download file」(下載檔案)。