リモート構成テンプレートとバージョン管理

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

ジャワ

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

残り

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 コンソール

[パラメータ] タブで、右上に表示されている「時計」アイコンを選択します。これにより、変更履歴ページが開き、保存されているすべてのテンプレート バージョンが右側のリスト メニューに一覧表示されます。

保存された各バージョンについて表示される詳細には、変更がコンソールで発生したか、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);
  });

ジャワ

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

残り

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操作に対してのみ有効です。更新のバージョン番号を指定するために使用することはできません。 ?version_numberパラメーターを指定しない同様の get 要求は、現在アクティブなテンプレートを取得します。

Firebase コンソール

デフォルトでは、[変更履歴] タブの詳細ペインに現在アクティブなテンプレートが表示されます。リスト内の別のバージョンの詳細を表示するには、右側のメニューから選択します。

選択されていないバージョンのコンテキスト メニューにカーソルを合わせ、[選択したバージョンと比較] を選択すると、現在選択されているバージョンと保存されている他のバージョンの詳細な差分を表示できます。

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

ジャワ

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

残り

保存されている Remote Config テンプレートにロールバックするには、カスタム メソッド: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);
      });
}

ジャワ

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

残り

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

このコマンドは、JSON ペイロードを 1 つのファイルに出力し、ヘッダー (ETag を含む) を別のheadersファイルに出力します。

Firebase コンソール

1. [ Remote Config Parameters or Conditions ] タブから、[ more_vert Menu ] を開き、[ Download current config file ] を選択します。
2. プロンプトが表示されたら、[設定ファイルのダウンロード] をクリックし、ファイルを保存する場所を選択して、[保存] をクリックします。

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

ジャワ

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

残り

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 とサフィックス-0が付いた更新された ETag を見つけます。テンプレートが検証されなかった場合、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);
      });
}

ジャワ

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

残り

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 パラメーターまたは条件] タブから、[ more_vertメニュー] を開き、[ファイルから公開] を選択します。
2. プロンプトが表示されたら、[参照] をクリックし、公開する Remote Config ファイルに移動して選択し、[選択] をクリックします。
3. ファイルが検証され、成功した場合は [発行] をクリックして、構成をアプリとユーザーがすぐに利用できるようにします。

残り

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

ダウンロードするファイル形式に応じて、 formatの値としてXML 、 PLIST 、またはJSONを使用します。

Firebase コンソール

1. [パラメーター] タブで、[ more_vertメニュー] を開き、[既定値のダウンロード] を選択します。
2. プロンプトが表示されたら、ダウンロードするファイル形式に対応するラジオ ボタンをクリックし、[ファイルのダウンロード] をクリックします。