با Firebase Remote Config شروع کنید


شما می توانید از Firebase Remote Config برای تعریف پارامترها در برنامه خود و به روز رسانی مقادیر آنها در فضای ابری استفاده کنید و به شما امکان می دهد ظاهر و رفتار برنامه خود را بدون توزیع به روز رسانی برنامه تغییر دهید. این راهنما شما را از طریق مراحل شروع به کار راهنمایی می کند و نمونه کدی را ارائه می دهد که همگی برای شبیه سازی یا دانلود از مخزن firebase/quickstart-android GitHub در دسترس هستند.

مرحله 1: Firebase و Remote Config SDK را به برنامه خود اضافه کنید

  1. اگر قبلاً این کار را نکرده‌اید، Firebase را به پروژه Android خود اضافه کنید .

  2. برای Remote Config ، Google Analytics برای هدف‌گیری مشروط نمونه‌های برنامه برای ویژگی‌های کاربر و مخاطبان مورد نیاز است. مطمئن شوید که Google Analytics در پروژه خود فعال کرده اید.

  3. در فایل Gradle ماژول (سطح برنامه) خود (معمولا <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle )، وابستگی را برای کتابخانه Remote Config برای Android اضافه کنید. توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌سازی کتابخانه استفاده کنید.

    همچنین، به عنوان بخشی از تنظیم Analytics ، باید Firebase SDK برای Google Analytics را به برنامه خود اضافه کنید. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.14.0"))

    // Add the dependencies for the Remote Config and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-config")
    implementation("com.google.firebase:firebase-analytics")
}

    با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخه‌های سازگار کتابخانه‌های Firebase Android استفاده می‌کند.

    (جایگزین) وابستگی های کتابخانه Firebase را بدون استفاده از BoM اضافه کنید

    اگر تصمیم گرفتید از Firebase BoM استفاده نکنید، باید هر نسخه کتابخانه Firebase را در خط وابستگی آن مشخص کنید.

    توجه داشته باشید که اگر از چندین کتابخانه Firebase در برنامه خود استفاده می کنید، ما قویاً توصیه می کنیم از BoM برای مدیریت نسخه های کتابخانه استفاده کنید، که تضمین می کند همه نسخه ها سازگار هستند. 

    dependencies {
    // Add the dependencies for the Remote Config and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-config:22.1.2")
    implementation("com.google.firebase:firebase-analytics:22.4.0")
}
     به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

مرحله 2: شئ Remote Config singleton را دریافت کنید

یک نمونه شی Remote Config دریافت کنید و حداقل فاصله واکشی را تنظیم کنید تا امکان تازه کردن مکرر وجود داشته باشد:

Kotlin

val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)
MainActivity.kt

Java

FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
MainActivity.java

شی singleton برای ذخیره مقادیر پارامترهای پیش‌فرض درون برنامه، واکشی مقادیر پارامترهای به‌روزشده از باطن، و کنترل زمانی که مقادیر واکشی شده در دسترس برنامه شما قرار می‌گیرد، استفاده می‌شود.

در طول توسعه، توصیه می شود حداقل فاصله واکشی نسبتاً کم را تنظیم کنید. برای اطلاعات بیشتر Throttling را ببینید.

مرحله 3: مقادیر پارامترهای پیش فرض درون برنامه را تنظیم کنید

می‌توانید مقادیر پارامترهای پیش‌فرض درون برنامه‌ای را در شی Remote Config تنظیم کنید، به طوری که برنامه شما قبل از اتصال به پشتیبان Remote Config همانطور که می‌خواهید رفتار کند، و اگر مقادیر پیش‌فرض در backend تنظیم نشده باشد، در دسترس باشند.

  1. مجموعه ای از نام پارامترها و مقادیر پارامترهای پیش فرض را با استفاده از یک شی Map یا یک فایل منبع XML ذخیره شده در پوشه res/xml برنامه خود تعریف کنید. برنامه نمونه راه‌اندازی سریع Remote Config از یک فایل XML برای تعریف نام‌ها و مقادیر پارامترهای پیش‌فرض استفاده می‌کند.

    اگر قبلاً مقادیر پارامتر Backend Remote Config را پیکربندی کرده‌اید، می‌توانید یک فایل XML تولید شده را دانلود کنید که شامل تمام مقادیر پیش‌فرض است و آن را در فهرست res/xml برنامه خود ذخیره کنید:

    استراحت 

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

    کنسول Firebase

    1. در برگه پارامترها ، منوی را باز کنید و مقادیر پیش‌فرض را دانلود کنید .

    2. وقتی از شما خواسته شد، xml. را برای Android فعال کنید، سپس روی دانلود فایل کلیک کنید.

  2. این مقادیر را با استفاده از setDefaultsAsync(int) به شی Remote Config اضافه کنید، همانطور که نشان داده شده است:

    Kotlin

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

مرحله 4: مقادیر پارامتر را برای استفاده در برنامه خود دریافت کنید

اکنون می توانید مقادیر پارامتر را از شی Remote Config دریافت کنید. اگر مقادیری را در backend تنظیم کنید، آنها را واکشی کنید و سپس آنها را فعال کنید، این مقادیر برای برنامه شما در دسترس هستند. در غیر این صورت، مقادیر پارامتر درون برنامه را با استفاده از setDefaultsAsync(int) پیکربندی می‌کنید. برای دریافت این مقادیر، روش فهرست شده در زیر را فراخوانی کنید که با نوع داده مورد انتظار برنامه شما مطابقت دارد و کلید پارامتر را به عنوان آرگومان ارائه می دهد:

مرحله 5: مقادیر پارامتر را در باطن Remote Config تنظیم کنید

با استفاده از کنسول Firebase یا Remote Config Backend API ، می‌توانید مقادیر پیش‌فرض سمت سرور جدیدی ایجاد کنید که مقادیر درون‌برنامه را مطابق با منطق شرطی دلخواه یا هدف‌گذاری کاربر لغو می‌کند. این بخش مراحل کنسول Firebase برای ایجاد این مقادیر را توضیح می دهد.

  1. در کنسول Firebase ، پروژه خود را باز کنید.
  2. Remote Config از منو انتخاب کنید تا داشبورد Remote Config مشاهده کنید.
  3. پارامترهایی را با همان نام پارامترهایی که در برنامه خود تعریف کرده اید تعریف کنید. برای هر پارامتر، می‌توانید یک مقدار پیش‌فرض تنظیم کنید (که در نهایت مقدار پیش‌فرض درون برنامه مربوطه را لغو می‌کند)، و همچنین می‌توانید مقادیر شرطی را تنظیم کنید. برای کسب اطلاعات بیشتر، پارامترها و شرایط Remote Config ببینید.

  4. اگر از شرایط سیگنال سفارشی استفاده می کنید، ویژگی ها و مقادیر آنها را تعریف کنید. مثال‌های زیر نحوه تعریف یک شرط سیگنال سفارشی را نشان می‌دهند.

    Kotlin

        val customSignals = customSignals {
        put("city", "Tokyo")
        put("preferred_event_category", "sports")
    }

    remoteConfig.setCustomSignals(customSignals)

    Java

        CustomSignals customSignals = new CustomSignals.Builder()
        .put("city", "Tokyo")
        .put("preferred_event_category", "sports")
        .build();

    mFirebaseRemoteConfig.setCustomSignals(customSignals);

مرحله 6: مقادیر را واکشی و فعال کنید

  1. برای واکشی مقادیر پارامتر از باطن Remote Config ، متد fetch() فراخوانی کنید. هر مقداری که در backend تنظیم می کنید در شی Remote Config واکشی و ذخیره می شود.

  2. برای در دسترس قرار دادن مقادیر پارامترهای واکشی شده برای برنامه خود، متد activate() فراخوانی کنید.

    برای مواردی که می‌خواهید مقادیر را در یک تماس واکشی و فعال کنید، می‌توانید از یک درخواست fetchAndActivate() برای واکشی مقادیر از Remote Config استفاده کنید و آنها را در دسترس برنامه قرار دهید:

    Kotlin

    remoteConfig.fetchAndActivate()
    .addOnCompleteListener(this) { task ->
        if (task.isSuccessful) {
            val updated = task.result
            Log.d(TAG, "Config params updated: $updated")
            Toast.makeText(
                this,
                "Fetch and activate succeeded",
                Toast.LENGTH_SHORT,
            ).show()
        } else {
            Toast.makeText(
                this,
                "Fetch failed",
                Toast.LENGTH_SHORT,
            ).show()
        }
        displayWelcomeMessage()
    }

    Java

    mFirebaseRemoteConfig.fetchAndActivate()
        .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                if (task.isSuccessful()) {
                    boolean updated = task.getResult();
                    Log.d(TAG, "Config params updated: " + updated);
                    Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                            Toast.LENGTH_SHORT).show();

                } else {
                    Toast.makeText(MainActivity.this, "Fetch failed",
                            Toast.LENGTH_SHORT).show();
                }
                displayWelcomeMessage();
            }
        });

از آنجایی که این مقادیر پارامتر به روز شده بر رفتار و ظاهر برنامه شما تأثیر می گذارد، باید مقادیر واکشی شده را در زمانی فعال کنید که تجربه یکنواختی را برای کاربر شما تضمین کند، مانند دفعه بعد که کاربر برنامه شما را باز می کند. برای اطلاعات بیشتر و مثال‌ها، به استراتژی‌های بارگیری Remote Config مراجعه کنید.

مرحله ۷: به‌روزرسانی‌ها را در زمان واقعی گوش دهید

پس از واکشی مقادیر پارامتر، می‌توانید Remote Config بی‌درنگ برای گوش دادن به به‌روزرسانی‌های Remote Config استفاده کنید. زمانی که به‌روزرسانی‌ها در دسترس هستند Remote Config به دستگاه‌های متصل سیگنال می‌دهد و پس از انتشار نسخه Remote Config جدید، به‌طور خودکار تغییرات را واکشی می‌کند.

به‌روزرسانی‌های بی‌درنگ توسط Firebase SDK برای Android نسخه 21.3.0+ ( Firebase BoM v31.2.4+) پشتیبانی می‌شوند.

  1. در برنامه خود، از addOnConfigUpdateListener() برای شروع گوش دادن به به‌روزرسانی‌ها و دریافت خودکار مقادیر پارامترهای جدید استفاده کنید. برای فعال کردن پیکربندی به روز شده، فراخوانی onUpdate() اجرا کنید.

    Kotlin

    remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
    override fun onUpdate(configUpdate : ConfigUpdate) {
       Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys);

       if (configUpdate.updatedKeys.contains("welcome_message")) {
           remoteConfig.activate().addOnCompleteListener {
               displayWelcomeMessage()
           }
       }
    }

    override fun onError(error : FirebaseRemoteConfigException) {
        Log.w(TAG, "Config update error with code: " + error.code, error)
    }
})

    Java

    mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
    @Override
    public void onUpdate(ConfigUpdate configUpdate) {
        Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
        mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                displayWelcomeMessage();
            }
        });
    }
    @Override
    public void onError(FirebaseRemoteConfigException error) {
        Log.w(TAG, "Config update error with code: " + error.getCode(), error);
    }
});

  2. دفعه بعد که نسخه جدیدی از Remote Config خود را منتشر می کنید، دستگاه هایی که برنامه شما را اجرا می کنند و به تغییرات گوش می دهند ConfigUpdateListener صدا می کنند.

گاز دادن

اگر یک برنامه در مدت زمان کوتاهی بارها واکشی شود، تماس‌های واکشی قطع می‌شوند و SDK FirebaseRemoteConfigFetchThrottledException برمی‌گرداند. قبل از SDK نسخه 17.0.0، حد مجاز 5 درخواست واکشی در یک پنجره 60 دقیقه ای بود (نسخه های جدید محدودیت های مجاز بیشتری دارند).

در طول توسعه برنامه، ممکن است بخواهید پیکربندی‌ها را به‌طور مکرر واکشی و فعال کنید (در هر ساعت چند بار) تا به شما اجازه دهد در حین توسعه و آزمایش برنامه‌تان به سرعت تکرار کنید. هنگامی که پیکربندی در سرور به روز می شود، به روز رسانی های Remote Config به طور خودکار از حافظه پنهان عبور می کنند. برای تطبیق تکرار سریع در پروژه‌ای با حداکثر 10 توسعه‌دهنده، می‌توانید به طور موقت یک شی FirebaseRemoteConfigSettings با حداقل فاصله واکشی کم ( setMinimumFetchIntervalInSeconds ) در برنامه خود تنظیم کنید.

حداقل فاصله واکشی پیش‌فرض برای Remote Config 12 ساعت است، به این معنی که پیکربندی‌ها بیش از یک بار در یک پنجره 12 ساعته از پشتیبان دریافت نمی‌شوند، صرف نظر از اینکه واقعاً چند تماس واکشی انجام شده است. به طور خاص، حداقل فاصله واکشی به ترتیب زیر تعیین می شود:

  1. پارامتر در fetch(long)
  2. پارامتر در FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. مقدار پیش فرض 12 ساعت

برای تنظیم حداقل فاصله واکشی روی یک مقدار سفارشی، از FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) استفاده کنید.

مراحل بعدی

اگر قبلاً این کار را نکرده اید ، موارد استفاده Remote Config را کاوش کنید و به برخی از مفاهیم کلیدی و مستندات استراتژی های پیشرفته ، از جمله:

،


برای تعریف پارامترها در برنامه خود می توانید از Firebase Remote Config استفاده کنید و مقادیر آنها را در ابر به روز کنید و به شما امکان می دهد بدون توزیع به روزرسانی برنامه ، ظاهر و رفتار برنامه خود را تغییر دهید. این راهنما شما را از طریق مراحل شروع کار می کند و برخی از کد های نمونه را ارائه می دهد ، که همه آنها برای کلون یا بارگیری از مخزن GitHub Firebase/QuickStart-Android در دسترس است.

مرحله 1: Firebase و پیکربندی Remote SDK را به برنامه خود اضافه کنید

  1. اگر قبلاً این کار را نکرده اید ، Firebase را به پروژه Android خود اضافه کنید .

  2. برای Remote Config ، Google Analytics برای هدف قرار دادن مشروط نمونه های برنامه به خصوصیات کاربر و مخاطبان مورد نیاز است. اطمینان حاصل کنید که Google Analytics در پروژه خود فعال کرده اید.

  3. در پرونده Gradle ماژول (سطح برنامه) خود (معمولاً <project>/<app-module>/build.gradle.kts یا <project>/<app-module>/build.gradle ) ، وابستگی را برای کتابخانه Remote Config برای Android اضافه کنید. توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌سازی کتابخانه استفاده کنید.

    همچنین ، به عنوان بخشی از تنظیم Analytics ، باید Firebase SDK را برای Google Analytics به برنامه خود اضافه کنید. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.14.0"))

    // Add the dependencies for the Remote Config and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-config")
    implementation("com.google.firebase:firebase-analytics")
}

    با استفاده از Firebase Android BoM ، برنامه شما همیشه از نسخه‌های سازگار کتابخانه‌های Firebase Android استفاده می‌کند.

    (جایگزین) وابستگی های کتابخانه Firebase را بدون استفاده از BoM اضافه کنید

    اگر تصمیم دارید از Firebase BoM استفاده نکنید ، باید هر نسخه کتابخانه Firebase را در خط وابستگی آن مشخص کنید.

    توجه داشته باشید که اگر از چندین کتابخانه Firebase در برنامه خود استفاده می کنید، ما قویاً توصیه می کنیم از BoM برای مدیریت نسخه های کتابخانه استفاده کنید، که تضمین می کند همه نسخه ها سازگار هستند. 

    dependencies {
    // Add the dependencies for the Remote Config and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-config:22.1.2")
    implementation("com.google.firebase:firebase-analytics:22.4.0")
}
     به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

مرحله 2: از Remote Config Singleton Object را دریافت کنید

یک نمونه شیء Remote Config دریافت کنید و حداقل فاصله واکشی را تنظیم کنید تا امکان تازه کردن مکرر فراهم شود:

Kotlin

val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)
MainActivity.kt

Java

FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
MainActivity.java

از شیء Singleton برای ذخیره مقادیر پارامتر پیش فرض در برنامه استفاده می شود ، مقادیر پارامتر به روز شده را از پس زمینه دریافت می کند و هنگامی که مقادیر واکشی در دسترس برنامه شما قرار می گیرد ، کنترل می شود.

در حین توسعه ، توصیه می شود فاصله کمتری نسبتاً کم تنظیم کنید. برای کسب اطلاعات بیشتر به لرزش مراجعه کنید.

مرحله 3: مقادیر پارامتر پیش فرض درون برنامه را تنظیم کنید

شما می توانید مقادیر پارامتر پیش فرض درون برنامه را در شیء Remote Config تنظیم کنید ، به طوری که برنامه شما قبل از اتصال به پس زمینه Remote Config ، همانطور که در نظر گرفته شده است رفتار می کند ، و در صورت تنظیم هیچ یک در قسمت پس زمینه ، مقادیر پیش فرض در دسترس است.

  1. مجموعه ای از نام پارامترها و مقادیر پارامتر پیش فرض را با استفاده از یک شیء نقشه یا یک فایل منبع XML که در پوشه res/xml برنامه خود ذخیره شده است ، تعریف کنید. برنامه Remote Config QuickStart Sample از یک فایل XML برای تعریف نام و مقادیر پارامتر پیش فرض استفاده می کند.

    اگر قبلاً مقادیر پارامتر با پشتیبانی Remote Config را پیکربندی کرده اید ، می توانید یک فایل XML تولید شده را بارگیری کنید که شامل تمام مقادیر پیش فرض و ذخیره آن در فهرست برنامه res/xml برنامه شما است:

    استراحت 

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

    کنسول Firebase

    1. در برگه Parameters ، منوی را باز کنید و مقادیر Dealnd Dealue را انتخاب کنید.

    2. در صورت درخواست ، .xml را برای Android فعال کنید ، سپس روی فایل بارگیری کلیک کنید.

  2. این مقادیر را با استفاده از setDefaultsAsync(int) به شیء Remote Config اضافه کنید ، همانطور که نشان داده شده است:

    Kotlin

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

مرحله 4: مقادیر پارامتر را برای استفاده در برنامه خود دریافت کنید

اکنون می توانید مقادیر پارامتر را از شیء Remote Config دریافت کنید. اگر مقادیر را در پس زمینه تنظیم کنید ، آنها را واکشی کنید و سپس آنها را فعال کنید ، این مقادیر در دسترس برنامه شما هستند. در غیر این صورت ، مقادیر پارامتر درون برنامه را با استفاده از setDefaultsAsync(int) پیکربندی می کنید. برای به دست آوردن این مقادیر ، با روش ذکر شده در زیر آن نقشه ها را به نوع داده مورد انتظار برنامه خود فراخوانی کنید ، و کلید پارامتر را به عنوان یک آرگومان ارائه دهید:

مرحله 5: مقادیر پارامتر را در باکتری Remote Config تنظیم کنید

با استفاده از کنسول Firebase یا API های Backend Remote Config ، می توانید مقادیر پیش فرض جدید سرور را ایجاد کنید که مقادیر درون برنامه را با توجه به منطق مشروط مورد نظر یا هدف قرار دادن کاربر غلبه می کند. در این بخش مراحل کنسول Firebase برای ایجاد این مقادیر توضیح داده شده است.

  1. در کنسول Firebase ، پروژه خود را باز کنید.
  2. برای مشاهده داشبورد Remote Config Remote Config از منو انتخاب کنید.
  3. پارامترها را با همان نام هایی با پارامترهایی که در برنامه خود تعریف کرده اید تعریف کنید. برای هر پارامتر ، می توانید یک مقدار پیش فرض (که در نهایت مقدار پیش فرض مربوط به برنامه را نادیده می گیرد) تنظیم کنید ، و همچنین می توانید مقادیر شرطی را تنظیم کنید. برای کسب اطلاعات بیشتر ، به پارامترها و شرایط Remote Config مراجعه کنید.

  4. در صورت استفاده از شرایط سیگنال سفارشی ، ویژگی ها و مقادیر آنها را تعریف کنید. مثالهای زیر نحوه تعریف یک وضعیت سیگنال سفارشی را نشان می دهد.

    Kotlin

        val customSignals = customSignals {
        put("city", "Tokyo")
        put("preferred_event_category", "sports")
    }

    remoteConfig.setCustomSignals(customSignals)

    Java

        CustomSignals customSignals = new CustomSignals.Builder()
        .put("city", "Tokyo")
        .put("preferred_event_category", "sports")
        .build();

    mFirebaseRemoteConfig.setCustomSignals(customSignals);

مرحله ششم: مقادیر را واکشی و فعال کنید

  1. برای واکشی مقادیر پارامتر از باکتری Remote Config ، با روش fetch() تماس بگیرید. هر مقداری که در پس زمینه تنظیم کرده اید ، در شیء Remote Config ذخیره می شود و ذخیره می شود.

  2. برای اینکه مقادیر پارامتر واکشی را در دسترس برنامه خود قرار دهید ، با روش activate() تماس بگیرید.

    برای مواردی که می خواهید مقادیر را در یک تماس واکشی و فعال کنید ، می توانید از یک درخواست fetchAndActivate() برای واکشی مقادیر از پس زمینه Remote Config استفاده کنید و آنها را در دسترس برنامه قرار دهید:

    Kotlin

    remoteConfig.fetchAndActivate()
    .addOnCompleteListener(this) { task ->
        if (task.isSuccessful) {
            val updated = task.result
            Log.d(TAG, "Config params updated: $updated")
            Toast.makeText(
                this,
                "Fetch and activate succeeded",
                Toast.LENGTH_SHORT,
            ).show()
        } else {
            Toast.makeText(
                this,
                "Fetch failed",
                Toast.LENGTH_SHORT,
            ).show()
        }
        displayWelcomeMessage()
    }

    Java

    mFirebaseRemoteConfig.fetchAndActivate()
        .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                if (task.isSuccessful()) {
                    boolean updated = task.getResult();
                    Log.d(TAG, "Config params updated: " + updated);
                    Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                            Toast.LENGTH_SHORT).show();

                } else {
                    Toast.makeText(MainActivity.this, "Fetch failed",
                            Toast.LENGTH_SHORT).show();
                }
                displayWelcomeMessage();
            }
        });

از آنجا که این مقادیر پارامتر به روز شده بر رفتار و ظاهر برنامه شما تأثیر می گذارد ، باید مقادیر واکشی را در زمانی فعال کنید که تجربه ای صاف را برای کاربر شما تضمین می کند ، مانند دفعه بعد که کاربر برنامه شما را باز می کند. برای اطلاعات بیشتر و مثال ، به استراتژی های بارگیری پیکربندی از راه دور مراجعه کنید.

مرحله 7: به روزرسانی ها را در زمان واقعی گوش دهید

پس از واکشی مقادیر پارامتر ، می توانید از Remote Config Time برای گوش دادن به روزرسانی از Remote Config Backend استفاده کنید. سیگنال های Remote Config در زمان واقعی هنگامی که به روزرسانی ها در دسترس هستند و به طور خودکار تغییرات را پس از انتشار نسخه جدید Remote Config دریافت می کنند.

به روزرسانی های زمان واقعی توسط Firebase SDK برای Android V21.3.0+ ( Firebase BoM V31.2.4+) پشتیبانی می شود.

  1. در برنامه خود ، از addOnConfigUpdateListener() استفاده کنید تا گوش دادن به روزرسانی ها را شروع کرده و به طور خودکار مقادیر پارامتر جدیدی را بدست آورید. برای فعال کردن پیکربندی به روز شده ، پاسخ به تماس onUpdate() را پیاده سازی کنید.

    Kotlin

    remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
    override fun onUpdate(configUpdate : ConfigUpdate) {
       Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys);

       if (configUpdate.updatedKeys.contains("welcome_message")) {
           remoteConfig.activate().addOnCompleteListener {
               displayWelcomeMessage()
           }
       }
    }

    override fun onError(error : FirebaseRemoteConfigException) {
        Log.w(TAG, "Config update error with code: " + error.code, error)
    }
})

    Java

    mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
    @Override
    public void onUpdate(ConfigUpdate configUpdate) {
        Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
        mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() {
            @Override
            public void onComplete(@NonNull Task<Boolean> task) {
                displayWelcomeMessage();
            }
        });
    }
    @Override
    public void onError(FirebaseRemoteConfigException error) {
        Log.w(TAG, "Config update error with code: " + error.getCode(), error);
    }
});

  2. دفعه بعد که نسخه جدیدی از Remote Config خود را منتشر می کنید ، دستگاه هایی که برنامه شما را اجرا می کنند و به تغییرات گوش می دهند ، با ConfigUpdateListener تماس می گیرند.

گاز دادن

اگر یک برنامه در یک دوره زمانی کوتاه بارها و بارها واگذار شود ، تماس های واکشی از بین می روند و SDK FirebaseRemoteConfigFetchThrottledException را برمی گرداند. قبل از SDK نسخه 17.0.0 ، حد 5 درخواست در یک پنجره 60 دقیقه ای بود (نسخه های جدیدتر محدودیت های مجاز بیشتری دارند).

در حین توسعه برنامه ، ممکن است بخواهید پیکربندی ها را بسیار مکرر (چندین بار در ساعت) واکشی کنید و به شما امکان دهید تا هنگام تهیه و آزمایش برنامه خود به سرعت تکرار کنید. به روزرسانی های Remote Config Time Time به طور خودکار هنگام بروزرسانی پیکربندی روی سرور ، حافظه نهان را دور می زنند. برای قرار دادن تکرار سریع در یک پروژه با حداکثر 10 توسعه دهنده ، می توانید به طور موقت یک شیء FirebaseRemoteConfigSettings را با حداقل فاصله واکشی کم ( setMinimumFetchIntervalInSeconds ) در برنامه خود تنظیم کنید.

حداقل فاصله پیش فرض برای Remote Config 12 ساعت است ، به این معنی که پیکربندی ها بیش از یک بار در یک پنجره 12 ساعته ، بدون توجه به چند تماس واکشی در واقع از پس زمینه خارج نمی شوند. به طور خاص ، حداقل فاصله واکشی در این ترتیب زیر تعیین می شود:

  1. پارامتر در fetch(long)
  2. پارامتر در FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. مقدار پیش فرض 12 ساعت

برای تنظیم حداقل فاصله واکشی به یک مقدار سفارشی ، از FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) استفاده کنید.

مراحل بعدی

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including: