Параметры и условия Remote Config в шаблонах клиентов

Вы можете передавать параметры и значения Remote Config из шаблонов клиентов в любые экземпляры приложений, в которых реализованы клиентские SDK Firebase для Remote Config, включая приложения Apple, Android, Web, Flutter, Unity и C++.

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

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

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

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

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

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

А условие времени можно использовать, чтобы показывать в приложении специальные рекламные товары.

У параметра может быть несколько условных значений, которые используют разные условия, а параметры могут использовать общие условия в рамках проекта. В консоли Firebase перейдите на страницу DevOps & Engagement (DevOps и вовлечение) > Remote Config > Parameters (Параметры), чтобы посмотреть процент получения условных значений каждого параметра. Этот показатель отражает процент запросов за последние 24 часа, которые получили каждое значение.

Как добавлять, изменять, перемещать и удалять условия в консоли Firebase

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

1. В консоли Firebase перейдите в раздел DevOps & Engagement (DevOps и вовлечение) > Remote Config (Удаленная конфигурация) > Conditions (Условия) или выберите Manage conditions (Управление условиями) на странице Parameters (Параметры).
2. Добавить условие. Нажмите Добавить условие (или Создать первое условие), введите название, которое определяет цель таргетинга, и выберите одно или несколько правил таргетинга.
3. Изменить условие. Нажмите на название условия или значок редактирования, измените правила и нажмите Сохранить.
4. Изменить приоритет условий. На странице Условия перетащите условия за маркеры, чтобы изменить их порядок. Условия, расположенные выше в списке, имеют приоритет над условиями, расположенными ниже.
5. Удалить условие. Нажмите на значок удаления рядом с нужным условием. Если на условие ссылается какой-либо параметр, то при удалении условия также удаляются связанные с ним условные значения.

Сохранив изменения, опубликуйте шаблон, нажав Опубликовать изменения.

Ограничение IPv6 при управлении доступом на основе IP-адресов

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

• Доступ к консоли. Вы не сможете использовать некоторые функции Remote Config в консоли Firebase, например загружать данные или настраивать таргетинг.
• Доступ клиентов. Клиентские приложения могут сталкиваться с ошибками PERMISSION_DENIED.

Чтобы избежать этих проблем, настройте сеть на использование IPv4 или добавьте необходимые диапазоны IP-адресов Firebase в белый список организации.

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

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

1. Сначала применяются условные значения для всех условий, которые оцениваются как true для данного запроса клиента. Если несколько условий оцениваются как true, приоритет имеет верхнее условие, показанное в интерфейсе консоли Firebase, и условные значения, связанные с этим условием, предоставляются, когда приложение извлекает значения из серверной части. Приоритет условий можно изменить, перетащив их на странице Условия.

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

В приложении значения параметров возвращаются методами 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. В консоли Firebase перейдите на страницу DevOps & Engagement (DevOps и взаимодействие) > Remote Config (Удаленная конфигурация) > Parameters (Параметры).
2. Выберите Управление группами.
3. Установите флажки рядом с нужными параметрами и нажмите Переместить в группу.
4. Выберите существующую группу или создайте новую, указав название и описание и нажав Создать группу. После сохранения группы ее можно опубликовать с помощью кнопки Опубликовать изменения.

Как создавать группы программно

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

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

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

Ниже приведен пример фрагмента измененного шаблона, в который добавлена группа параметров "new menu" с одним параметром 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: 11.8.0 или более поздней версии.
• Android: 22.1.0 или более поздней версии (Firebase BoM 33.8.0 или более поздней версии).
• Веб: 11.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 специальных сигналов для каждого экземпляра приложения. Чтобы отменить специальный сигнал, задайте для него значение null.
• Название особого сигнала. Название каждого особого сигнала может содержать не более 250 символов.
• Значение специального сигнала. Каждое значение может содержать до 500 символов. При использовании регулярных выражений ограничение составляет 250 символов.

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

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

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

Вы можете искать ключи параметров, значения параметров и условия в консоли Firebase, используя окно поиска в верхней части страницы DevOps & Engagement (DevOps и вовлечение) > Remote Config > Parameters (Параметры).

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

В проекте Firebase может быть до 3000 параметров и до 2000 условий. Ключи параметров могут содержать до 256 символов, должны начинаться с символа подчеркивания или буквы английского алфавита (A–Z, a–z) и могут включать цифры. Общая длина строк со значениями параметров в проекте не может превышать 1 000 000 символов. Кроме того, правила условий, основанные на свойствах пользователей, могут включать до 100 значений свойств пользователей. Полный список ограничений приведен в разделе Квоты и ограничения.

Как посмотреть изменения параметров и условий

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

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

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

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

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

В консоли Firebase перейдите на страницу DevOps & Engagement (DevOps и взаимодействие) > Remote Config (Удаленная конфигурация) > Parameters (Параметры). В столбце Последняя публикация указано, кто последним изменил параметр и когда это произошло.

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

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

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

В консоли Firebase перейдите в раздел DevOps & Engagement (DevOps и вовлечение) > Remote Config (Удаленная конфигурация) > Conditions (Условия). Рядом с каждым условием в разделе Последнее изменение указано, кто и когда его изменил.

Дальнейшие действия

Чтобы настроить проект и приложение Firebase для использования Remote Config, ознакомьтесь со статьей Начало работы с Firebase Remote Config.