Get Started

{# This content gets published to the following location: #} {# https://firebase.google.com/docs/remote-config/get-started?platform=flutter #}

You can use Firebase Remote Config to define parameters in your app and update their values in the cloud, allowing you to modify the appearance and behavior of your app without distributing an app update. This guide walks you through the steps to get started and provides some sample code.

Step 1: Add Firebase and the Remote Config SDK to your app {: #add-firebase }

1. Install and initialize the Firebase SDKs for Flutter if you haven't already done so.

2. For Remote Config, Google Analytics is required for the conditional targeting of app instances to user properties and audiences. Make sure that you <a href="https://support.google.com/firebase/answer/9289399#linkga" class="external">enable Google Analytics</a> in your project.

3. From the root directory of your Flutter project, run the following command to install the Remote Config plugin:

   bashCopy

   flutter pub add firebase_remote_config
   

   Also, as part of setting up Remote Config, you need to add the Firebase SDK for Google Analytics to your app:

   bashCopy

   flutter pub add firebase_analytics
   

4. Rebuild your project:

   bashCopy

   flutter run
   

5. If you're using Remote Config on macOS, enable Keychain Sharing in Xcode.

Note: Because the Remote Config SDK has a dependency on the Remote Config REST API, make sure that you do not disable that API, which is enabled by default in a typical project.

Step 2: Get the Remote Config singleton object {: #get-remote-config }

Get a Remote Config object instance and set the minimum fetch interval to allow for frequent refreshes:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

The singleton object is used to store in-app default parameter values, fetch updated parameter values from the backend, and control when fetched values are made available to your app.

During development, it's recommended to set a relatively low minimum fetch interval. See Throttling for more information.

Step 3: Set in-app default parameter values {: #default-parameter }

You can set in-app default parameter values in the Remote Config object, so that your app behaves as intended before it connects to the Remote Config backend, and so that default values are available if none are set in the backend.

Important: Don't store confidential data in Remote Config parameter keys or values. Remote Config data is encrypted in transit, but end users can access any default or fetched Remote Config parameter that is available to their client app instance.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Step 4: Get parameter values to use in your app {: #get-parameter }

Now you can get parameter values from the Remote Config object. If you set values in the backend, fetch them, and then activate them, those values are available to your app. Otherwise, you get the in-app parameter values configured using setDefaults().

To get these values, call the method listed below that maps to the data type expected by your app, providing the parameter key as an argument:

• getBool()
• getDouble()
• getInt()
• getString()

Step 5: Set parameter values in the Remote Config backend {: #set-parameter }

Using the Firebase console or the Remote Config backend APIs, you can create new server-side default values that override the in-app values according to your desired conditional logic or user targeting. This section describes the Firebase console steps to create these values.

1. In the Firebase console, open your project.
2. Select Remote Config from the menu to view the Remote Config dashboard.
3. Define parameters with the same names as the parameters that you defined in your app. For each parameter, you can set a default value (which will eventually override the corresponding in-app default value), and you can also set conditional values. To learn more, see Remote Config Parameters and Conditions.

Step 6: Fetch and activate values {: #fetch-values }

1. To fetch parameter values from the Remote Config backend, call the fetch() method. Any values that you set in the backend are fetched and stored in the Remote Config object.

2. To make fetched parameter values available to your app, call the activate() method.

   For cases where you want to fetch and activate values in one call, you can use a fetchAndActivate() request to fetch values from the Remote Config backend and make them available to the app:

   dartCopy

   await remoteConfig.fetchAndActivate();
   

Because these updated parameter values affect the behavior and appearance of your app, you should activate the fetched values at a time that ensures a smooth experience for your user, such as the next time that the user opens your app. See Remote Config loading strategies for more information and examples.

Step 7: Listen for updates in real time {: #add-real-time-listener }

After you fetch parameter values, you can use real-time Remote Config to listen for updates from the Remote Config backend. Real-time Remote Config signals to connected devices when updates are available and automatically fetches the changes after you publish a new Remote Config version.

Note that real-time Remote Config is not available for Web.

1. In your app, use onConfigUpdated to start listening for updates and automatically fetch any new parameter values.

   dartCopy

    remoteConfig.onConfigUpdated.listen((event) async {
      await remoteConfig.activate();
   
      // Use the new config values here.
    });
   

2. The next time you publish a new version of your Remote Config, devices that are running your app and listening for changes will activate the new config.

Tip: Check out the Flutterfire Remote Config example for an example implementation.

Throttling {: #throttling }

If an app fetches too many times in a short time period, fetch calls will be throttled and the value of FirebaseRemoteConfig's lastFetchStatus property will be RemoteConfigFetchStatus.throttle.

The default minimum fetch interval for Remote Config is 12 hours, which means that configs won't be fetched from the backend more than once in a 12 hour window, regardless of how many fetch calls are actually made.

During app development, if you're not using real-time Remote Config (which we recommend), you might want to fetch and activate configs very frequently (many times per hour) to let you rapidly iterate as you develop and test your app. To accommodate rapid iteration on a project with up to 10 developers, you can temporarily set a low minimum fetch interval with setConfigSettings().

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Caution: Keep in mind that this setting should be used for development only, not for an app running in production. If you're just testing your app with a small 10-person development team, you are unlikely to hit the hourly service-side quota limits. But if you pushed your app out to thousands of test users with a very low minimum fetch interval, your app would probably hit this quota.