透過程式輔助方式修改遠端設定

使用 Admin SDK、REST API 和 Firebase CLI 設定範本。 page_type: guide

本文說明如何以程式輔助方式讀取及修改一組 JSON 格式的參數和條件，也就是Remote Config範本。這樣一來，您就能在後端變更範本，用戶端應用程式則可使用用戶端程式庫擷取範本。

使用本指南所述的 Remote Config REST API、Admin SDKs 或 Firebase CLI，您可以略過在 Firebase 控制台中管理範本的步驟，直接將 Remote Config 變更整合到自己的程序中。舉例來說，您可以透過 Remote Config 後端 API 執行下列操作：

• 排定Remote Config更新時間。搭配使用 API 呼叫和 Cron 工作，即可定期變更 Remote Config 值。
• 批次匯入設定值，從自有專屬系統有效轉換至 Firebase Remote Config。
• 搭配 Cloud Functions for Firebase 使用 Remote Config，根據伺服器端發生的事件變更應用程式中的值。舉例來說，您可以運用 Remote Config 宣傳應用程式的新功能，並在偵測到有足夠的使用者與新功能互動後，自動關閉宣傳活動。

本指南的以下章節說明如何使用 Remote Config 後端 API 執行作業。

使用 Firebase Admin SDK 修改 Remote Config

Admin SDK 是一組伺服器程式庫，可讓您從具備權限的環境與 Firebase 互動。除了更新 Remote Config，Admin SDK 還能產生及驗證 Firebase 驗證權杖，以及從 Realtime Database 讀取和寫入資料。如要進一步瞭解Admin SDK必要條件和設定，請參閱「在伺服器中新增 Firebase Admin SDK」。

如要查看使用 Admin SDK 執行這些工作的程式碼範例，請參閱下列其中一個快速入門應用程式：

• Firebase Remote Config Java 快速入門導覽課程
• Firebase Remote Config Node.js 快速入門
• Firebase Remote Config Python 快速入門導覽課程

在典型的 Remote Config 流程中，您可能會取得目前的範本、修改部分參數或參數群組和條件、驗證範本，然後發布範本。發出這些 API 呼叫前，您必須授權 SDK 的要求。

初始化 SDK 並授權 API 要求

初始化 Admin SDK 時，如果沒有任何參數，SDK 會使用 Google 應用程式預設憑證，並從 FIREBASE_CONFIG 環境變數讀取選項。如果 FIREBASE_CONFIG 變數的內容開頭為 {，系統會將其剖析為 JSON 物件。否則，SDK 會假設該字串是包含選項的 JSON 檔案名稱。

例如：

const admin = require('firebase-admin');
admin.initializeApp();

FileInputStream serviceAccount = new FileInputStream("service-account.json");
FirebaseOptions options = FirebaseOptions.builder()
        .setCredentials(GoogleCredentials.fromStream(serviceAccount))
        .build();
FirebaseApp.initializeApp(options);

取得目前的 Remote Config 範本

使用Remote Config範本時，請注意範本有版本限制，且每個版本都有生命週期限制，從建立時間到您以更新版本取代為止，最多為 90 天，且最多只能儲存 300 個版本。詳情請參閱「範本和版本管理」。

您可以使用後端 API，以 JSON 格式取得 Remote Config 範本的目前有效版本。

在 A/B Testing 實驗中專門建立為變數的參數和參數值，不會納入匯出的範本。

如要取得範本，請按照下列步驟操作：

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

修改 Remote Config 參數

您可以透過程式輔助方式修改及新增 Remote Config 參數和參數群組。舉例來說，您可以為名為「new_menu」的現有參數群組新增參數，控管季節性資訊的顯示方式：

function addParameterToGroup(template) {
  template.parameterGroups['new_menu'].parameters['spring_season'] = {
    defaultValue: {
      useInAppDefault: true
    },
    description: 'spring season menu visibility.',
  };
}

template.getParameterGroups().get("new_menu").getParameters()
        .put("spring_season", new Parameter()
                .setDefaultValue(ParameterValue.inAppDefault())
                .setDescription("spring season menu visibility.")
        );

您可以使用 API 建立新的參數和參數群組，或修改預設值、條件值和說明。無論如何，修改範本後都必須明確發布。

修改 Remote Config 條件

您可以透過程式輔助方式修改及新增 Remote Config 條件和條件值。舉例來說，如要新增條件，請按照下列步驟操作：

function addNewCondition(template) {
  template.conditions.push({
    name: 'android_en',
    expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']',
    tagColor: 'BLUE',
  });
}

template.getConditions().add(new Condition("android_en",
        "device.os == 'android' && device.country in ['us', 'uk']", TagColor.BLUE));

無論如何，修改範本後都必須明確發布。

Remote Config後端 API 提供多種條件和比較運算子，可用於變更應用程式的行為和外觀。如要進一步瞭解條件和這些條件支援的運算子，請參閱「條件運算式參考資料」。

驗證 Remote Config 範本

如要先驗證更新內容再發布，請按照下圖操作：

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

這項驗證程序會檢查錯誤，例如參數和條件的重複鍵、無效的條件名稱或不存在的條件，或是格式錯誤的 etag。舉例來說，如果要求包含超過允許的鍵數 (2000 個)，就會傳回 Param count too large 錯誤訊息。

發布「Remote Config」範本

擷取範本並根據更新內容進行修訂後，即可發布。如本節所述發布範本時，系統會以更新後的檔案取代整個現有設定範本，並為新的有效範本指派的版本號碼，會比取代的範本大一號。

如有必要，您可以使用 REST API 復原至先前版本。如要降低更新發生錯誤的風險，可以先驗證再發布。

Remote Config下載的範本會包含個人化設定和條件，因此嘗試發布至其他專案時，請務必留意下列限制：

• 個人化設定無法從一個專案匯入另一個專案。

  舉例來說，如果您在專案中啟用個人化功能，並下載及編輯範本，可以將範本發布至同一個專案，但除非刪除範本中的個人化設定，否則無法發布至其他專案。

• 您可以將條件從一個專案匯入另一個專案，但請注意，發布前，目標專案中必須存在任何特定條件值 (例如應用程式 ID 或目標對象)。

  舉例來說，如果您有使用條件的 Remote Config 參數，指定平台值為 iOS，範本可以發布至其他專案，因為任何專案的平台值都相同。不過，如果條件依據的特定應用程式 ID 或使用者目標對象不存在於目標專案，驗證就會失敗。

• 如果您打算發布的範本包含依賴 Google Analytics 的條件，則必須在目標專案中啟用 Analytics。

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

使用 REST API 修改 Remote Config

本節說明 Remote Config REST API 的主要功能，網址為 https://firebaseremoteconfig.googleapis.com。如需完整詳細資料，請參閱「API 參考資料」。

取得存取權杖，驗證及授權 API 要求

Firebase 專案支援 Google 服務帳戶，您可以使用這類帳戶，從應用程式伺服器或信任的環境呼叫 Firebase 伺服器 API。如果您在本機開發程式碼，或是在地端部署應用程式，可以使用透過這個服務帳戶取得的憑證，授權伺服器要求。

如要查看 Firebase 專案的所有服務帳戶，請前往「設定」settings >「服務帳戶」分頁。

如要驗證服務帳戶並授權存取 Firebase 服務，您必須產生 JSON 格式的私密金鑰檔案。

如要為服務帳戶產生私密金鑰檔案，請按照下列步驟操作：

1. 在 Firebase 控制台中，依序前往 「settings 設定」> 「服務帳戶」分頁。

2. 按一下「產生新的私密金鑰」，然後點選「產生金鑰」確認。

3. 妥善儲存內含金鑰的 JSON 檔案。

透過服務帳戶授權時，您可以選擇兩種方式，將憑證提供給應用程式。您可以設定 GOOGLE_APPLICATION_CREDENTIALS 環境變數，也可以在程式碼中明確傳遞服務帳戶金鑰的路徑。第一個選項較安全，因此我們強烈建議您採用。

如要設定環境變數：

將環境變數 GOOGLE_APPLICATION_CREDENTIALS 設為包含服務帳戶金鑰的 JSON 檔案路徑。這個變數只會套用到目前的殼層工作階段，因此如果開啟新的工作階段，請再次設定變數。

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

完成上述步驟後，應用程式預設憑證 (ADC) 就能隱含地判斷您的憑證，讓您在非 Google 環境中測試或執行時，使用服務帳戶憑證。

使用 Firebase 憑證和偏好語言的 Google Auth Library，擷取短期有效的 OAuth 2.0 存取權杖：

 function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
}
index.js

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token
configure.py

public static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refreshAccessToken();
  return googleCredentials.getAccessToken().getTokenValue();
}
FirebaseRemoteConfigSnippets.java

存取權杖過期後，系統會自動呼叫權杖更新方法，以擷取更新後的存取權杖。

如要授權存取 Remote Config，請要求範圍 https://www.googleapis.com/auth/firebase.remoteconfig。

修改 Remote Config 範本

使用Remote Config範本時，請注意範本有版本控制機制，且每個版本都有生命週期限制，從建立到更新取代為止，最多為 90 天，最多可儲存 300 個版本。詳情請參閱「範本和版本管理」。

取得目前的 Remote Config 範本

您可以使用後端 API，以 JSON 格式取得 Remote Config 範本的目前有效版本。

在 A/B Testing 實驗中專門建立為變數的參數和參數值，不會納入匯出的範本。

請使用下列指令：

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

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/my-project-id/remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

驗證 Remote Config 範本

您也可以先驗證更新內容，再發布。 在發布要求中附加網址參數 ?validate_only=true，驗證範本更新。 在回應中，狀態碼 200 和更新後的 etag (後方加上 -0) 表示更新已通過驗證。如果回應不是 200，表示 JSON 資料含有錯誤，您必須先修正錯誤才能發布。

更新 Remote Config 範本

擷取範本並使用更新內容修訂 JSON 內容後，即可發布範本。如本節所述發布範本時，系統會以更新後的檔案取代整個現有設定範本，並為新的有效範本指派的版本號碼，會比取代的範本大一號。

如有必要，您可以使用 REST API 復原至先前版本。如要降低更新發生錯誤的風險，可以先驗證再發布。

Remote Config下載的範本會包含個人化設定和條件，因此嘗試發布至其他專案時，請務必留意下列限制：

• 個人化設定無法從一個專案匯入另一個專案。

  舉例來說，如果您在專案中啟用個人化功能，並下載及編輯範本，可以將範本發布至同一個專案，但除非刪除範本中的個人化設定，否則無法發布至其他專案。

• 您可以將條件從一個專案匯入另一個專案，但請注意，發布前，目標專案中必須存在任何特定條件值 (例如應用程式 ID 或目標對象)。

  舉例來說，如果您有使用條件的 Remote Config 參數，指定平台值為 iOS，範本可以發布至其他專案，因為任何專案的平台值都相同。不過，如果條件依據的特定應用程式 ID 或使用者目標對象不存在於目標專案，驗證就會失敗。

• 如果您打算發布的範本包含依賴 Google Analytics 的條件，則必須在目標專案中啟用 Analytics。

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

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

修改 Remote Config 條件

您可以透過程式輔助方式修改 Remote Config 條件和條件值。使用 REST API 時，您必須直接編輯範本，才能在發布範本前修改條件。

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all
      capital letters."
    }
  }
}

上述程式碼片段中的修改內容會先定義一組條件，然後為每個參數定義預設值和以條件為準的參數 (條件值) 值。他們也會為每個元素新增選填說明；與程式碼註解一樣，這些說明僅供開發人員使用，不會顯示在應用程式中。此外，系統也會提供 ETag，用於版本控管。

Remote Config後端 API 提供多種條件和比較運算子，可用於變更應用程式的行為和外觀。如要進一步瞭解條件和這些條件支援的運算子，請參閱「條件運算式參考資料」。

HTTP 錯誤代碼

狀態碼 200 表示 Remote Config 範本 (專案的參數、值和條件) 已更新，現在可供使用這個專案的應用程式使用。其他狀態碼表示先前存在的 Remote Config 範本仍有效。

提交範本更新後，請前往 Firebase 控制台，確認變更是否如預期顯示。這點至關重要，因為條件的順序會影響評估方式 (系統會採用第一個評估結果為 true 的條件)。

ETag 用法和強制更新

Remote Config REST API 會使用實體標記 (ETag)，避免競爭狀況和資源更新重疊。如要進一步瞭解 ETag，請參閱「ETag - HTTP」。

如果是 REST API，Google 建議您快取最新 GET 指令提供的 ETag，並在發出 PUT 指令時，將該 ETag 值用於 If-Match 要求標頭。如果 PUT 指令傳回 HTTPS 狀態碼 409，請發出新的 GET 指令，取得新的 ETag 和範本，以便用於下一個 PUT 指令。

您可以強制更新 Remote Config 範本，藉此規避 ETag 及其提供的保護措施，方法如下： If-Match: *。不過，如果多個用戶端更新 Remote Config 範本，可能會導致 Remote Config 範本更新遺失，因此不建議採用這種做法。如果有多個用戶端使用 API，或是 API 用戶端和Firebase控制台使用者更新的內容有衝突，就可能發生這類衝突。

如需管理Remote Config範本版本的指引，請參閱「Remote Config範本和版本管理」。

使用 Firebase CLI 修改 Remote Config

您可以使用 Firebase CLI 檢查、管理及復原範本，也可以直接透過指令列列出、檢查及刪除實驗和推出作業。Remote ConfigRemote Config

事前準備和設定

1. 安裝 Firebase CLI 或更新至最新版本。

2. 登入 Firebase：

   firebase login

3. 設定有效專案，或在每個指令中指定 --project PROJECT_ID：

   firebase use PROJECT_ID

確認帳戶或服務帳戶具備必要的 IAM 權限：

• 如要檢查、下載或還原 Remote Config 範本，以及管理推出作業，您需要Firebase Remote Config 管理員角色 (roles/cloudconfig.admin) (或權限 cloudconfig.configs.get、cloudconfig.configs.update、cloudconfig.rollouts.get、cloudconfig.rollouts.list 和 cloudconfig.rollouts.archive)。如要執行僅供檢視的操作，Firebase Remote Config 檢視者角色 (roles/cloudconfig.viewer) (cloudconfig.configs.get、cloudconfig.rollouts.get 和 cloudconfig.rollouts.list) 就已足夠。
• 如要管理 A/B Testing 實驗，您需要Firebase A/B Testing 管理員角色 (roles/firebaseabt.admin) (或權限 firebaseabt.experiments.get、firebaseabt.experiments.list 和 firebaseabt.experiments.delete)。如要執行僅供檢視的操作，Firebase A/B Testing 檢視者角色 (roles/firebaseabt.viewer) 就已足夠。

CLI 指令摘要

修改 Remote Config 範本和版本

使用下列指令檢查、下載及復原Remote Config範本及其版本記錄：

• 列出範本版本
• 取得範本
• 復原範本

列出範本版本

預設會列出 Remote Config 範本的最新 10 個版本，包括版本號碼、更新時間、更新來源、更新類型和 updateUser。

firebase remoteconfig:versions:list [--limit NUMBER_OF_VERSIONS]

• --limit NUMBER_OF_VERSIONS：要傳回的版本數量上限。指定 0 即可傳回所有現有版本 (最多 300 個儲存版本)。

範例：

• 列出最近 10 個版本：

  firebase remoteconfig:versions:list

• 列出所有可用版本：

  firebase remoteconfig:versions:list --limit 0

• 列出最近 5 個版本：

  firebase remoteconfig:versions:list --limit 5

取得範本

取得 Remote Config 範本，並輸出參數群組、參數、條件名稱和版本。根據預設，這項指令會擷取最新的有效版本，並在終端機中列印格式化摘要。

firebase remoteconfig:get [-v, --version_number VERSION_NUMBER] [-o, --output FILENAME]

• -v, --version_number VERSION_NUMBER：要擷取的範本版本號碼。如果省略，則預設為最新版本。
• -o, --output FILENAME：將範本 JSON 酬載直接寫入指定路徑，而非列印至標準輸出。

範例：

• 在終端機中顯示目前有效的範本：

  firebase remoteconfig:get

• 將目前使用的範本下載為 JSON 檔案：

  firebase remoteconfig:get -o remote_config_template.json

• 將特定歷史版本 (例如版本 12) 下載至檔案：

  firebase remoteconfig:get -v 12 -o remote_config_v12.json

復原範本

將有效 Remote Config 範本復原至先前的版本。這會建立新的有效版本，內容與目標版本相同。

firebase remoteconfig:rollback [-v, --version_number VERSION_NUMBER] [--force]

• -v, --version_number VERSION_NUMBER：要復原的目標版本號碼。如果省略，預設為緊接在前的版本 (目前版本減 1)。
• --force：立即執行復原作業，不會提示進行互動式確認 (Y/N)。適用於 CI/CD 管道和自動化指令碼。

範例：

• 使用互動式確認復原至前一版：

  firebase remoteconfig:rollback

• 復原至版本 8，且不顯示提示：

  firebase remoteconfig:rollback -v 8 --force

修改 A/B Testing 實驗

使用下列指令，直接透過 CLI 列出、檢查及刪除 Remote Config A/B Testing 實驗：

• 清單實驗
• 取得實驗詳細資料
• 刪除實驗

列出實驗

列出專案的所有 Remote Config 實驗，並提供選用的篩選和分頁功能。

firebase remoteconfig:experiments:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]

• --filter EXPRESSION：要套用至實驗清單的篩選運算式。
• --pageSize NUMBER：每頁要傳回的實驗數量 (預設為 10)。
• --pageToken TOKEN：擷取分頁結果時的頁面偏移權杖。

範例：

firebase remoteconfig:experiments:list

取得實驗詳細資料

取得指定 Remote Config 實驗的完整詳細資料。

firebase remoteconfig:experiments:get EXPERIMENT_ID

範例：

firebase remoteconfig:experiments:get exp_promo_discount_2026

刪除實驗

刪除指定的Remote Config實驗。

firebase remoteconfig:experiments:delete EXPERIMENT_ID

範例：

firebase remoteconfig:experiments:delete exp_promo_discount_2026

修改 Remote Config 推出作業

使用下列指令，直接透過 CLI 列出、檢查及刪除Remote Config推出作業：

• 清單推出
• 取得推出作業詳細資料
• 刪除推出作業

列出推出作業

列出專案的所有 Remote Config 推出作業，並提供篩選和分頁選項。

firebase remoteconfig:rollouts:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]

• --filter EXPRESSION：要套用至推出清單的篩選運算式。
• --pageSize NUMBER：每頁要傳回的推出次數 (預設為 10)。
• --pageToken TOKEN：擷取分頁結果時的頁面偏移權杖。

範例：

firebase remoteconfig:rollouts:list

取得推出作業詳細資料

取得指定 Remote Config 推出作業的完整詳細資料。

firebase remoteconfig:rollouts:get ROLLOUT_ID

範例：

firebase remoteconfig:rollouts:get rollout_new_checkout_flow

刪除推出作業

刪除指定的 Remote Config 推出作業。

firebase remoteconfig:rollouts:delete ROLLOUT_ID

範例：

firebase remoteconfig:rollouts:delete rollout_new_checkout_flow

如要進一步瞭解 Firebase CLI 指令，請參閱 Firebase CLI 參考資料。