Szablony Zdalnej konfiguracji i obsługa wersji

Konsola Firebase

Na karcie Parametry kliknij ikonę zegara w prawym górnym rogu. Spowoduje to otwarcie strony Historia zmian, na której w menu po prawej stronie znajdziesz wszystkie przechowywane wersje szablonu.

Szczegóły wyświetlane w przypadku każdej zapisanej wersji obejmują informacje o tym, czy zmiany zostały wprowadzone za pomocą Konsoli, interfejsu REST API, cofnięcia zmian czy czy były to zmiany przyrostowe po wymuszeniu zapisania szablonu.

Interfejs wiersza poleceń Firebase

firebase remoteconfig:versions:list

Aby ograniczyć liczbę zwracanych wersji, użyj opcji --limit. Aby pobrać wszystkie wersje, prześlij wartość „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

Konsola Firebase

Domyślnie na karcie Historia zmian w panelu szczegółów wyświetlany jest aktualny aktywny szablon. Aby wyświetlić szczegóły innej wersji na liście, wybierz ją w menu po prawej stronie.

Aby wyświetlić szczegółowe porównanie bieżącej wersji z inną zapisaną wersją, najedź kursorem na menu kontekstowe dowolnej niewybranej wersji i wybierz Porównaj z wybraną wersją.

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

Opcjonalnie możesz zapisać dane wyjściowe w określonym pliku za pomocą polecenia -o, FILENAME.

Node.js

Aby pobrać najnowszą wersję szablonu, prześlij getTemplate() bez żadnych argumentów. Aby pobrać konkretną wersję, użyj 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

Parametr adresu URL ?version_number jest prawidłowy tylko w przypadku operacji GET. Nie można go użyć do określenia numerów wersji na potrzeby aktualizacji. Podobne żądanie bez parametru ?version_number pobiera aktualny aktywny szablon.

Konsola Firebase

W przypadku poprzednich wersji szablonów, które można cofnąć, w prawym górnym rogu strony Historia zmian wyświetlany jest przycisk opcji umożliwiający przywrócenie do tej wersji. Kliknij i potwierdź tylko wtedy, gdy masz pewność, że chcesz przywrócić tę wersję i użyć tych wartości natychmiast we wszystkich aplikacjach i dla wszystkich użytkowników.

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

Aby przywrócić zapisany szablon Remote Config, wyślij żądanie HTTP POST z metodą niestandardową :rollback, a w treści żądania wskaż konkretną wersję do zastosowania. Przykład:

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}'

Odpowiedź zawiera zawartość obecnie aktywnego przechowywanego szablonu wraz z metadanymi jego nowej wersji.

Konsola Firebase

1. Na karcie Remote Config Parametry lub Warunki otwórz more_vertMenu i wybierz Pobierz bieżący plik konfiguracji.
2. Gdy pojawi się odpowiedni komunikat, kliknij Pobierz plik konfiguracji, wybierz miejsce, w którym chcesz zapisać plik, a następnie kliknij Zapisz.

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

To polecenie wyprowadza ładunek JSON do jednego pliku, a nagłówki (w tym ETag) do oddzielnego pliku 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

Zweryfikuj aktualizacje szablonu, dołączając do żądania publikacji parametr adresu 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

Jeśli szablon został zweryfikowany, polecenie curl zwraca przesłany szablon JSON. W zapisanym pliku headers znajdziesz stan HTTP/2 200 i zaktualizowany tag ETag z sufiksem -0. Jeśli Twój szablon nie został zweryfikowany, w odpowiedzi JSON zobaczysz błąd weryfikacji, a plik headers będzie zawierał odpowiedź inną niż 200 (i nie będzie zawierać ETag).

Konsola Firebase

1. Na karcie Parametry lub warunki Remote Config otwórz more_vertmenu i wybierz Opublikuj z pliku.
2. Gdy pojawi się komunikat, kliknij Przeglądaj, przejdź do pliku Remote Config, który chcesz opublikować, i wybierz go, a następnie kliknij Wybierz.
3. Plik zostanie sprawdzony. Jeśli operacja się uda, możesz kliknąć Opublikuj, aby natychmiast udostępnić konfigurację aplikacjom i użytkownikom.

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

W tym poleceniu curl możesz określić zawartość, używając znaku „@”, a następnie nazwy pliku.

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'

Jako wartości format użyj XML, PLIST lub JSON w zależności od formatu pliku, który chcesz pobrać.

Konsola Firebase

1. Na karcie Parametry otwórz more_vertmenu i wybierz Pobierz wartości domyślne.
2. Gdy pojawi się taka opcja, kliknij przycisk opcji odpowiadający formatowi pliku, który chcesz pobrać, a następnie kliknij Pobierz plik.