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

iOS+ Android Web Flutter Unity C++

مهم: این بخش مراحل پیکربندی Remote Config را با مشتریان موبایل و وب توضیح می دهد. برای محیط های سرور، استفاده 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 اضافه کنید. کتابخانه برای اندروید توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌سازی کتابخانه استفاده کنید.

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

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.3.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.0.0")
       implementation("com.google.firebase:firebase-analytics:22.1.0")
   }

   به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

توجه: از آنجایی که Android SDK به Remote Config REST API وابسته است، مطمئن شوید که API را که به طور پیش‌فرض در یک پروژه معمولی فعال است، غیرفعال نکنید .

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

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

Kotlin+KTX

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 تنظیم نشده باشد، در دسترس باشند.

مهم: داده های محرمانه را در کلیدها یا مقادیر پارامتر Remote Config ذخیره نکنید. داده‌های Remote Config در حین انتقال رمزگذاری می‌شوند، اما کاربران نهایی می‌توانند به هر پارامتر پیش‌فرض یا واکشی Remote Config که برای نمونه برنامه مشتری آنها در دسترس است دسترسی داشته باشند.

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+KTX

   remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

   Java

   mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

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

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

• getBoolean()
• getDouble()
• getLong()
• getString()

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

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

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

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

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

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

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

   Kotlin+KTX

   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 مراجعه کنید.

توجه: اگر برنامه شما با Gradle ساخته نمی شود، باید به صورت دستی منبع رشته google_app_id صحیح را به برنامه خود اضافه کنید تا Remote Config بتواند مقداردهی اولیه شود. افزونه google-services Gradle معمولاً این را به صورت خودکار اضافه می کند، اما می توانید مقدار مناسب را در فایل google-services.json که از کنسول Firebase دانلود می کنید، پیدا کنید. برای اطلاعات بیشتر در مورد دریافت مقدار google_app_id از فایل google-services.json ، به پردازش فایل JSON مراجعه کنید.

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

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

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

مهم: Real-time Remote Config همچنین به Firebase Remote Config Realtime API نیاز دارد که باید از قبل برای شما فعال باشد. برای تأیید، کنسول Google Cloud را باز کنید، پروژه خود را انتخاب کنید و صفحه APIs and Services را باز کنید. API باید به صورت فعال ظاهر شود. اگر موجود نیست یا فعال نیست، روی Enable APIs & Services کلیک کنید، Firebase Remote Config Realtime API را جستجو کنید و آن را فعال کنید.

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

   Kotlin+KTX

   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 دقیقه ای بود (نسخه های جدید محدودیت های مجاز بیشتری دارند).

نکته: با شروع Android SDK نسخه 21.3.0+ ( Firebase BoM v31.3.0+)، می‌توانید از Remote Config برای دریافت خودکار مقادیر پارامترهای به‌روزرسانی شده از پشتیبان Remote Config به محض انتشار استفاده کنید، و از حداقل واکشی دور بزنید. تنظیم فاصله برای اطلاعات بیشتر، به گوش دادن به به‌روزرسانی‌ها در زمان واقعی مراجعه کنید.

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

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

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

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

به خاطر داشته باشید که این تنظیم باید فقط برای توسعه استفاده شود، نه برای برنامه‌ای که در حال تولید است. اگر فقط برنامه خود را با یک تیم توسعه ده نفره کوچک آزمایش می‌کنید، بعید است که محدودیت‌های سهمیه خدمات ساعتی را رعایت کنید. اما اگر برنامه خود را به هزاران کاربر آزمایشی با حداقل فاصله واکشی بسیار کم منتقل کنید، برنامه شما احتمالاً به این حد نصاب خواهد رسید.

مراحل بعدی

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

• نسخه های قالب Remote Config را مدیریت کنید
• پیکربندی استراتژی های بارگیری

،

iOS+ Android Web Flutter Unity C ++

نکته مهم: در این بخش مراحل پیکربندی Remote Config با مشتری های تلفن همراه و وب توضیح داده شده است. برای محیط های سرور ، به استفاده از 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 اضافه کنید. کتابخانه برای اندروید توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌سازی کتابخانه استفاده کنید.

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

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.3.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.0.0")
       implementation("com.google.firebase:firebase-analytics:22.1.0")
   }

   به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

توجه: از آنجا که Android SDK وابستگی به API Remote Config Rest دارد ، حتماً آن API را غیرفعال نکنید ، که به طور پیش فرض در یک پروژه معمولی فعال می شود.

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

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

Kotlin+KTX

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 ، همانطور که در نظر گرفته شده است رفتار می کند ، و در صورت تنظیم هیچ یک در قسمت پس زمینه ، مقادیر پیش فرض در دسترس است.

مهم: داده های محرمانه را در کلیدها یا مقادیر پارامتر Remote Config ذخیره نکنید. داده های Remote Config در Transit رمزگذاری می شوند ، اما کاربران نهایی می توانند به هر پارامتر 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. در برگه پارامترها ، منوی را باز کنید و مقادیر پیش‌فرض را دانلود کنید.

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

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

   Kotlin+KTX

   remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

   Java

   mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

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

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

• getBoolean()
• getDouble()
• getLong()
• getString()

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

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

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

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

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

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

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

   Kotlin+KTX

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

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

توجه: اگر برنامه شما با Gradle ساخته نمی شود ، باید به صورت دستی منبع صحیح google_app_id را به برنامه خود اضافه کنید تا Remote Config بتواند اولیه شود. افزونه google-services Gradle معمولاً این را به طور خودکار اضافه می کند ، اما می توانید مقدار مناسب را در پرونده google-services.json که از کنسول Firebase بارگیری می کنید ، پیدا کنید. برای اطلاعات بیشتر در مورد دریافت مقدار google_app_id از پرونده google-services.json ، به پردازش پرونده JSON مراجعه کنید.

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

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

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

نکته مهم: Remote Config در زمان واقعی همچنین به API RealTime Firebase Remote Config نیاز دارد ، که باید از قبل برای شما فعال شود. برای تأیید ، کنسول Google Cloud را باز کنید ، پروژه خود را انتخاب کرده و صفحه API و خدمات را باز کنید. API باید به صورت فعال ظاهر شود. اگر از دست رفته یا فعال نشده است ، روی Enable APIS & Services کلیک کنید ، API REALTIME Firebase Remote Config را جستجو کنید و آن را فعال کنید.

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

   Kotlin+KTX

   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 دقیقه ای بود (نسخه های جدیدتر محدودیت های مجاز بیشتری دارند).

نکته: شروع با Android SDK V21.3.0+ ( Firebase BoM v31.3.0+) ، می توانید از Remote Config Time Time استفاده کنید تا به طور خودکار مقادیر پارامتر به روز شده را به محض انتشار Remote Config استفاده کنید ، با عبور از هر حداقل FETCH تنظیم فاصله برای اطلاعات بیشتر ، به گوش دادن به روزرسانی در زمان واقعی مراجعه کنید.

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

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

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

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

به خاطر داشته باشید که این تنظیم فقط برای توسعه باید استفاده شود ، نه برای برنامه ای که در تولید کار می کند. اگر فقط برنامه خود را با یک تیم توسعه 10 نفره کوچک آزمایش می کنید ، بعید به نظر می رسد که به محدوده سهمیه خدمات ساعتی بپردازید. اما اگر برنامه خود را به هزاران کاربر آزمایشی با حداقل فاصله واکشی بسیار پایین سوق دهید ، برنامه شما احتمالاً به این سهمیه رسیده است.

مراحل بعدی

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:

• نسخه های قالب Remote Config را مدیریت کنید
• Config loading strategies

،

iOS+ Android Web Flutter Unity C++

Important: This section describes steps to configure Remote Config with mobile and web clients. For server environments, see Use Remote Config in server environments .

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, all of which is available to clone or download from the firebase/quickstart-android GitHub repository.

Step 1: Add Firebase and the Remote Config SDK to your app

1. If you haven't already, add Firebase to your Android project .

2. For Remote Config , Google Analytics is required for the conditional targeting of app instances to user properties and audiences. Make sure that you enable Google Analytics in your project.

3. In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle ), add the dependency for the Remote Config کتابخانه برای اندروید توصیه می‌کنیم از Firebase Android BoM برای کنترل نسخه‌سازی کتابخانه استفاده کنید.

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

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.3.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.0.0")
       implementation("com.google.firebase:firebase-analytics:22.1.0")
   }

   به دنبال یک ماژول کتابخانه خاص کاتلین هستید؟ از اکتبر 2023 ( Firebase BoM 32.5.0) ، توسعه دهندگان Kotlin و Java می توانند به ماژول کتابخانه اصلی وابسته باشند (برای جزئیات، به سؤالات متداول در مورد این ابتکار مراجعه کنید).

Note: Because the Android 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 a Remote Config object instance and set the minimum fetch interval to allow for frequent refreshes:

Kotlin+KTX

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

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

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.

1. Define a set of parameter names and default parameter values using a Map object or an XML resource file stored in your app's res/xml folder. The Remote Config quickstart sample app uses an XML file to define default parameter names and values.

   If you have already configured Remote Config backend parameter values, you can download a generated XML file that includes all default values and save it to your app's res/xml directory:

   استراحت

   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. When prompted, enable .xml for Android , then click Download file .

2. Add these values to the Remote Config object using setDefaultsAsync(int) , as shown:

   Kotlin+KTX

   remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

   Java

   mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Step 4: Get parameter values to use in your app

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 setDefaultsAsync(int) . 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:

• getBoolean()
• getDouble()
• getLong()
• getString()

Step 5: Set parameter values in the Remote Config backend

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

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:

   Kotlin+KTX

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

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.

Note: If your app doesn't build with Gradle, you must manually add the correct google_app_id string resource to your app so that Remote Config can initialize. The google-services Gradle plugin normally adds this automatically, but you can find the appropriate value in the google-services.json file that you download from the Firebase console. For more information on getting the google_app_id value from the google-services.json file, see Processing the JSON file .

Step 7: Listen for updates in real time

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.

Real-time updates are supported by the Firebase SDK for Android v21.3.0+ ( Firebase BoM v31.2.4+).

Important: Real-time Remote Config also requires the Firebase Remote Config Realtime API, which should already be enabled for you. To verify, open the Google Cloud console , select your project, and open the APIs and Services page. The API should appear as enabled. If it's missing or not enabled, click Enable APIs & Services , search for Firebase Remote Config Realtime API , and enable it.

1. In your app, use addOnConfigUpdateListener() to start listening for updates and automatically fetch any new parameter values. Implement the onUpdate() callback to activate the updated config.

   Kotlin+KTX

   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. The next time you publish a new version of your Remote Config , devices that are running your app and listening for changes will call the ConfigUpdateListener .

گاز دادن

If an app fetches too many times in a short time period, fetch calls are throttled and the SDK returns FirebaseRemoteConfigFetchThrottledException . Before SDK version 17.0.0, the limit was 5 fetch requests in a 60 minute window (newer versions have more permissive limits).

Tip: Starting with Android SDK v21.3.0+ ( Firebase BoM v31.3.0+), you can use real-time Remote Config to automatically fetch updated parameter values from the Remote Config backend as soon as they're published, bypassing any minimum fetch interval setting. For more information, see Listen for updates in real time .

During app development, 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. Real-time Remote Config updates automatically bypass the cache when the config is updated on the server. To accommodate rapid iteration on a project with up to 10 developers, you can temporarily set a FirebaseRemoteConfigSettings object with a low minimum fetch interval ( setMinimumFetchIntervalInSeconds ) in your app.

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. Specifically, the minimum fetch interval is determined in this following order:

1. The parameter in fetch(long)
2. The parameter in FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
3. The default value of 12 hours

To set the minimum fetch interval to a custom value, use FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

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.

مراحل بعدی

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:

• نسخه های قالب Remote Config را مدیریت کنید
• Config loading strategies