Параметры и условия удаленной настройки

Вы можете настроить шаблоны как для клиентских, так и для серверных приложений. Клиентские шаблоны передаются любым экземплярам приложений, реализующим клиентские SDK Firebase для Remote Config , включая приложения Android, Apple, Web, Unity, Flutter и C++. Параметры и значения Remote Config из серверных шаблонов передаются реализациям Remote Config (включая Cloud Run и Cloud Functions), использующим следующие серверные среды:

• Firebase Admin Node.js SDK v12.1.0+
• Firebase Admin Python SDK v6.7.0+

При использовании консоли Firebase или API бэкенда Remote Config вы определяете один или несколько параметров (пар «ключ-значение») и указываете для них значения по умолчанию в приложении. Вы можете переопределить значения по умолчанию в приложении, определив значения параметров. Ключи и значения параметров являются строками, но значения параметров могут быть преобразованы в другие типы данных при использовании этих значений в приложении.

Используя консоль Firebase , Admin SDK или REST API Remote Config REST API) , вы можете создавать новые значения по умолчанию для параметров, а также условные значения, используемые для целевых групп экземпляров приложения. Каждый раз при обновлении конфигурации в консоли Firebase , Firebase создает и публикует новую версию шаблона Remote Config . Предыдущая версия сохраняется, что позволяет при необходимости восстановить ее или откатить. Эти операции доступны в консоли Firebase , Firebase Admin SDK и REST API и более подробно описаны в разделе Управление версиями шаблона Remote Config .

В этом руководстве объясняются параметры, условия, правила, условные значения и то, как значения различных параметров приоритизируются в бэкенде Remote Config и в вашем приложении. Также подробно описываются типы правил, используемых для создания условий.

Условия, правила и условные значения

Условие используется для определения группы экземпляров приложения. Условия состоят из одного или нескольких правил, все из которых должны быть true , чтобы условие было true для данного экземпляра приложения. Если значение правила не определено (например, если значение отсутствует), это правило будет иметь значение false .

Например, параметр, определяющий стартовую страницу приложения, может отображать разные изображения в зависимости от типа ОС, используя правило if device_os = Android :

Или можно использовать временное условие для управления отображением в приложении специальных рекламных материалов.

Параметр может иметь несколько условных значений, использующих разные условия, и параметры могут использовать одни и те же условия в рамках проекта. На вкладке «Параметры» консоли Firebase можно просмотреть процент выборки для условных значений каждого параметра. Эта метрика показывает процент запросов за последние 24 часа, получивших каждое значение.

Приоритет значения параметра

С параметром может быть связано несколько условных значений. Следующие правила определяют, какое значение извлекается из шаблона Remote Config и какое значение используется в данном экземпляре приложения в конкретный момент времени:

1. Во-первых, условные значения применяются к любым условиям, которые оцениваются как true для данного клиентского запроса. Если несколько условий оцениваются как true , приоритет имеет первое (верхнее) условие, отображаемое в интерфейсе консоли Firebase , и условные значения, связанные с этим условием, предоставляются при получении приложением данных из бэкэнда. Вы можете изменить приоритет условий, перетаскивая их на вкладке «Условия» .

2. Если условные значения с условиями, которые оцениваются как true , отсутствуют, при получении значений из бэкенда приложением предоставляется значение по умолчанию Remote Config . Если параметр отсутствует в бэкенде или для него установлено значение по умолчанию Use in-app default , то при получении значений приложением значение для этого параметра не предоставляется.

В вашем приложении значения параметров возвращаются методами get в соответствии со следующим списком приоритетов.

1. Если значение было извлечено из бэкенда, а затем активировано, приложение использует извлеченное значение. Активированные значения параметров являются постоянными.

2. Если из бэкэнда не было извлечено ни одного значения или если значения, извлеченные из бэкэнда Remote Config не были активированы, приложение использует встроенное в приложение значение по умолчанию.

   Дополнительную информацию о получении и настройке значений по умолчанию см. в разделе Загрузка шаблонов Remote Config по умолчанию .

3. Если в приложении не установлено значение по умолчанию, приложение использует статическое значение типа (например, 0 для int и false для boolean ).

На этом рисунке показано, как значения параметров приоритетны в бэкэнде Remote Config и в вашем приложении:

Типы данных значений параметров

Remote Config позволяет выбрать тип данных для каждого параметра и проверяет все значения Remote Config на соответствие этому типу перед обновлением шаблона. Тип данных сохраняется и возвращается в запросе getRemoteConfig .

Поддерживаемые типы данных:

• String
• Boolean
• Number
• JSON

В пользовательском интерфейсе консоли Firebase тип данных можно выбрать из раскрывающегося списка рядом с ключом параметра. В REST API типы данных можно задать с помощью поля value_type в объекте параметра.

Группы параметров

Remote Config позволяет группировать параметры для более организованного пользовательского интерфейса и повышения удобства использования.

Например, вам нужно включить или отключить три разных типа аутентификации при внедрении новой функции входа. С помощью Remote Config вы можете создать три параметра для включения нужных типов, а затем объединить их в группу под названием «Новый вход» без необходимости добавлять префиксы или использовать специальную сортировку.

Вы можете создавать группы параметров с помощью консоли Firebase или REST API Remote Config . Каждая создаваемая группа параметров имеет уникальное имя в шаблоне Remote Config . При создании групп параметров учитывайте следующее:

• Параметры могут быть включены только в одну группу одновременно, и ключ параметра должен быть уникальным для всех параметров.
• Длина имени группы параметров ограничена 256 символами.
• Если вы используете и REST API, и консоль Firebase , убедитесь, что вся логика REST API обновлена для обработки групп параметров при публикации.

Создание или изменение групп параметров с помощью консоли Firebase

Вы можете сгруппировать параметры на вкладке «Параметры» консоли Firebase . Чтобы создать или изменить группу:

1. Выберите Управление группами .
2. Установите флажки для параметров, которые вы хотите добавить, и выберите Переместить в группу .
3. Выберите существующую группу или создайте новую, введя имя и описание, а затем выбрав «Создать новую группу» . После сохранения группы её можно опубликовать с помощью кнопки «Опубликовать изменения» .

Создавайте группы программно

REST API Remote Config предоставляет автоматизированный способ создания и публикации групп параметров. Если вы знакомы с REST и настроены на авторизацию запросов к API, вы можете выполнить следующие шаги для программного управления группами:

1. Получить текущий шаблон
2. Добавьте объекты JSON для представления групп параметров.
3. Опубликуйте группы параметров с помощью HTTP-запроса PUT.

Объект parameterGroups содержит групповые ключи с вложенным описанием и списком сгруппированных параметров. Обратите внимание, что каждый групповой ключ должен быть глобально уникальным.

Например, вот отрывок из версии шаблона, в которую добавлена группа параметров «новое меню» с одним параметром, pumpkin_spice_season :

{
  "parameters": {},
  "version": {
    "versionNumber": "1",

    …

  },
  "parameterGroups": {
    "new menu": {
      "description": "New Menu",
      "parameters": {
        "pumpkin_spice_season": {
          "defaultValue": {
            "value": "true"
          },
          "description": "Whether it's pumpkin spice season."
        }
      }
    }
  }
}

Пользовательские условия сигнала

Пользовательские условные значения сигналов можно использовать для сопоставления произвольных сигналов, определяемых и отправляемых в приложении, с условиями, создаваемыми на основе сигналов в Remote Config . Это позволяет адаптировать взаимодействие с приложением или клиентом.

Пользовательские условия сигнала доступны для следующих клиентских сред:

• iOS: v11.8.0 или выше
• Android: v22.1.0 или выше (Firebase BoM v33.8.0 или выше)
• Веб: v11.2.0 или выше
• Flutter: Flutter BoM версии 3.6.0 или выше

Например, предположим, что вы работаете над приложением для продажи билетов и хотите разместить баннер на главном экране. Вы можете использовать клиентские условия сигналов, чтобы персонализировать эти баннеры в зависимости от местоположения и интересов пользователя. Можно сделать следующее:

1. Добавьте параметры banner_image_url и banner_link в шаблон клиента Remote Config . Они представляют изображение баннера и страницу мероприятия, связанную с этим изображением.
2. Установите пользовательские сигналы из вашего приложения со значениями city и preferred_event_category .
3. Добавьте значения по умолчанию в шаблон Remote Config клиента и создайте условные значения на основе пользовательских сигналов, которые вы задали на предыдущем шаге.
4. Добавьте значения по умолчанию в шаблон Remote Config клиента, а также условные значения для каждого определенного вами условия.
5. Обновите код приложения, чтобы задать и использовать пользовательские условия сигнала.

Теперь ваше приложение может загружать соответствующие banner_image_url и banner_link при получении этих параметров с сервера Remote Config .

Пределы

При создании пользовательских условий сигнала необходимо соблюдать следующие ограничения:

• Количество пользовательских сигналов: вы можете создать до 100 пользовательских условий сигналов.
• Имя пользовательского сигнала: Имя каждого пользовательского сигнала может содержать не более 250 символов.
• Значение пользовательского сигнала: Каждое значение пользовательского сигнала может содержать до 500 символов. При использовании регулярных выражений ограничение составляет 250 символов.

Типы правил условий

В консоли Firebase поддерживаются следующие типы правил. Аналогичные функции доступны в REST API Remote Config , как подробно описано в справочнике по условным выражениям .

Параметры и условия поиска

Вы можете выполнить поиск ключей параметров, значений параметров и условий вашего проекта из консоли Firebase , используя поле поиска в верхней части вкладки «Параметры Remote Config .

Ограничения на параметры и условия

В проекте Firebase можно создать до 3000 параметров и до 2000 условий. Ключи параметров могут содержать до 256 символов, должны начинаться с символа подчёркивания или английской буквы (AZ, az) и могут содержать цифры. Общая длина строк значений параметров в проекте не может превышать 1 000 000 символов.

Просмотр изменений параметров и условий

Вы можете просмотреть последние изменения в шаблонах Remote Config в консоли Firebase . Для каждого отдельного параметра и условия вы можете:

• Просмотр имени пользователя, который последним изменил параметр или условие.

• Если изменение произошло в течение того же дня, просмотрите количество минут или часов, прошедших с момента публикации изменения в активном шаблоне Remote Config .

• Если изменение произошло один или несколько дней назад, просмотрите дату публикации изменения в активном шаблоне Remote Config .

История изменений параметров

На странице «Параметры Remote Config в столбце «Последняя публикация» отображается последний пользователь, изменивший каждый параметр, и последняя дата публикации изменения:

• Чтобы просмотреть метаданные изменений для сгруппированных параметров, разверните группу параметров.

• Чтобы отсортировать по дате публикации в порядке возрастания или убывания, щелкните заголовок столбца Последняя публикация .

История изменений условий

На странице «Условия Remote Config вы можете увидеть последнего пользователя, изменившего условие, и дату его изменения рядом с полем «Последнее изменение» для каждого условия.

Следующие шаги