Изменить Remote Config программно

Настройка шаблонов с использованием Admin SDK, REST API и Firebase CLI. page_type: guide

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

Используя REST API Remote Config , Admin SDK или CLI Firebase , описанные в этом руководстве, вы можете обойтись без управления шаблоном в консоли Firebase и напрямую интегрировать изменения Remote Config в свои собственные процессы. Например, с помощью бэкэнд-API Remote Config вы можете:

• Планируйте обновления Remote Config . Используя вызовы API в сочетании с заданием cron, вы можете изменять значения Remote Config по расписанию.
• Пакетный импорт значений конфигурации позволит эффективно перейти с вашей собственной проприетарной системы на Firebase Remote Config .
• Используйте Remote Config с Cloud Functions for Firebase , изменяя значения в вашем приложении на основе событий, происходящих на стороне сервера. Например, вы можете использовать Remote Config для продвижения новой функции в вашем приложении, а затем автоматически отключить это продвижение, как только обнаружите, что достаточное количество людей взаимодействовало с новой функцией.

В следующих разделах данного руководства описаны операции, которые можно выполнять с помощью API-интерфейсов бэкэнда Remote Config .

Изменение Remote Config с помощью Firebase Admin SDK

Admin SDK — это набор серверных библиотек, позволяющих взаимодействовать с Firebase из привилегированных сред. Помимо обновления Remote Config , Admin SDK обеспечивает генерацию и проверку токенов аутентификации Firebase, а также чтение и запись из Realtime Database . Подробнее о предварительных требованиях и настройке Admin SDK см. в разделе «Добавление Firebase Admin SDK на ваш сервер» .

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

• Быстрый старт Firebase Remote Config Java
• Быстрый старт Firebase Remote Config Node.js
• Быстрый старт Firebase Remote Config на Python

В типичном процессе Remote Config вы можете получить текущий шаблон, изменить некоторые параметры или группы параметров и условия, проверить шаблон, а затем опубликовать его. Перед выполнением этих вызовов API необходимо авторизовать запросы из SDK.

Инициализируйте SDK и авторизуйте запросы к API.

При инициализации Admin SDK без параметров, SDK использует учетные данные Google Application Default Credentials и считывает параметры из переменной среды FIREBASE_CONFIG . Если содержимое переменной FIREBASE_CONFIG начинается с { , оно будет интерпретировано как объект JSON. В противном случае SDK предполагает, что строка является именем файла JSON, содержащего параметры.

Например:

const admin = require('firebase-admin');
admin.initializeApp();

FileInputStream serviceAccount = new FileInputStream("service-account.json");
FirebaseOptions options = FirebaseOptions.builder()
        .setCredentials(GoogleCredentials.fromStream(serviceAccount))
        .build();
FirebaseApp.initializeApp(options);

Получите текущий шаблон Remote Config

При работе с шаблонами Remote Config следует помнить, что они версионированы, и каждая версия имеет ограниченный срок действия с момента ее создания до момента замены обновлением: 90 дней, с общим лимитом в 300 сохраненных версий. Дополнительную информацию см. в разделе «Шаблоны и версионирование» .

Вы можете использовать API бэкэнда для получения текущей активной версии шаблона Remote Config в формате JSON.

Параметры и значения параметров, созданные специально в качестве вариантов в эксперименте A/B Testing не включаются в экспортируемые шаблоны.

Чтобы получить шаблон:

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

Изменение параметров Remote Config

Вы можете программно изменять и добавлять параметры и группы параметров Remote Config . Например, к существующей группе параметров с именем "new_menu" можно добавить параметр для управления отображением сезонной информации:

function addParameterToGroup(template) {
  template.parameterGroups['new_menu'].parameters['spring_season'] = {
    defaultValue: {
      useInAppDefault: true
    },
    description: 'spring season menu visibility.',
  };
}

template.getParameterGroups().get("new_menu").getParameters()
        .put("spring_season", new Parameter()
                .setDefaultValue(ParameterValue.inAppDefault())
                .setDescription("spring season menu visibility.")
        );

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

Изменение условий Remote Config

Вы можете программно изменять и добавлять условия и значения условий Remote Config . Например, чтобы добавить новое условие:

function addNewCondition(template) {
  template.conditions.push({
    name: 'android_en',
    expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']',
    tagColor: 'BLUE',
  });
}

template.getConditions().add(new Condition("android_en",
        "device.os == 'android' && device.country in ['us', 'uk']", TagColor.BLUE));

Во всех случаях после внесения изменений необходимо обязательно опубликовать шаблон.

API-интерфейсы бэкэнда Remote Config предоставляют несколько условий и операторов сравнения, которые можно использовать для изменения поведения и внешнего вида вашего приложения. Для получения дополнительной информации об условиях и поддерживаемых для них операторах см. справочник по условным выражениям .

Проверьте шаблон Remote Config .

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

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

В процессе проверки выявляются ошибки, такие как повторяющиеся ключи для параметров и условий, недопустимые имена условий или несуществующие условия, а также неправильно отформатированные etags. Например, запрос, содержащий больше допустимого количества ключей — 2000 — вернет сообщение об ошибке « Param count too large .

Опубликуйте шаблон Remote Config .

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

При необходимости вы можете использовать REST API для отката к предыдущей версии . Чтобы снизить риск ошибок при обновлении, вы можете выполнить проверку перед публикацией .

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

• Настройки персонализации нельзя импортировать из одного проекта в другой.

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

• Условия можно импортировать из проекта в проект, но обратите внимание, что любые конкретные значения условий (например, идентификаторы приложений или аудитории) должны существовать в целевом проекте до публикации.

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

• Если шаблон, который вы планируете опубликовать, содержит условия, зависящие от Google Analytics , Analytics необходимо включить в целевом проекте.

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

Изменение Remote Config с помощью REST API

В этом разделе описаны основные возможности REST API Remote Config по адресу https://firebaseremoteconfig.googleapis.com . Для получения более подробной информации см. справочник по API .

Получите токен доступа для аутентификации и авторизации запросов к API.

Проекты Firebase поддерживают сервисные учетные записи Google, которые можно использовать для вызова API сервера Firebase с вашего сервера приложений или доверенной среды. Если вы разрабатываете код локально или развертываете приложение локально, вы можете использовать учетные данные, полученные с помощью этой сервисной учетной записи, для авторизации запросов к серверу.

Вы можете просмотреть все учетные записи служб для вашего проекта Firebase в settings > Вкладка «Учетные записи служб» .

Для аутентификации учетной записи службы и предоставления ей доступа к сервисам Firebase необходимо сгенерировать файл закрытого ключа в формате JSON.

Чтобы сгенерировать файл закрытого ключа для вашей служебной учетной записи:

1. В консоли Firebase перейдите в... settings > Вкладка «Учетные записи служб» .

2. Нажмите «Сгенерировать новый закрытый ключ» , затем подтвердите, нажав «Сгенерировать ключ» .

3. Надежно сохраните JSON-файл, содержащий ключ.

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

Чтобы установить переменную среды:

Установите переменную среды GOOGLE_APPLICATION_CREDENTIALS на путь к JSON-файлу, содержащему ключ вашей учетной записи службы. Эта переменная применяется только к текущей сессии оболочки, поэтому, если вы откроете новую сессию, установите переменную снова.

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

После выполнения описанных выше шагов Application Default Credentials (ADC) сможет автоматически определять ваши учетные данные, что позволит вам использовать учетные данные сервисной учетной записи при тестировании или запуске в средах, отличных от Google.

Используйте свои учетные данные Firebase вместе с библиотекой Google Auth для предпочитаемого языка, чтобы получить кратковременный токен доступа OAuth 2.0:

 function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
}
index.js

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token
configure.py

public static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refreshAccessToken();
  return googleCredentials.getAccessToken().getTokenValue();
}
FirebaseRemoteConfigSnippets.java

После истечения срока действия вашего токена доступа автоматически вызывается метод обновления токена для получения обновленного токена доступа.

Для авторизации доступа к Remote Config запросите область действия https://www.googleapis.com/auth/firebase.remoteconfig .

Измените шаблон Remote Config .

При работе с шаблонами Remote Config следует помнить, что они версионированы, и каждая версия имеет ограниченный срок действия с момента ее создания до момента замены обновлением: 90 дней, с общим лимитом в 300 сохраненных версий. Дополнительную информацию см. в разделе «Шаблоны и версионирование» .

Получите текущий шаблон Remote Config

Вы можете использовать API бэкэнда для получения текущей активной версии шаблона Remote Config в формате JSON.

Параметры и значения параметров, созданные специально в качестве вариантов в эксперименте A/B Testing не включаются в экспортируемые шаблоны.

Используйте следующие команды:

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/my-project-id/remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

Проверьте шаблон Remote Config .

При желании вы можете проверить свои обновления перед публикацией. Для проверки обновлений шаблона добавьте к запросу на публикацию параметр URL ?validate_only=true . В ответе код состояния 200 и обновленный etag с суффиксом -0 означают, что ваше обновление было успешно проверено. Любой ответ, отличный от 200, указывает на то, что данные JSON содержат ошибки, которые необходимо исправить перед публикацией.

Обновите шаблон Remote Config .

Получив шаблон и внеся в него изменения в JSON-содержимое, вы можете его опубликовать. Публикация шаблона, как описано в этом разделе, заменяет весь существующий шаблон конфигурации обновленным файлом, и новому активному шаблону присваивается номер версии на единицу больше, чем у замененного им шаблона.

При необходимости вы можете использовать REST API для отката к предыдущей версии . Чтобы снизить риск ошибок при обновлении, вы можете выполнить проверку перед публикацией .

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

• Настройки персонализации нельзя импортировать из одного проекта в другой.

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

• Условия можно импортировать из проекта в проект, но обратите внимание, что любые конкретные значения условий (например, идентификаторы приложений или аудитории) должны существовать в целевом проекте до публикации.

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

• Если шаблон, который вы планируете опубликовать, содержит условия, зависящие от Google Analytics , Analytics необходимо включить в целевом проекте.

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

Изменение условий Remote Config

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

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all
      capital letters."
    }
  }
}

firebase remoteconfig:versions:list [--limit NUMBER_OF_VERSIONS]

firebase remoteconfig:get [-v, --version_number VERSION_NUMBER] [-o, --output FILENAME]

firebase remoteconfig:rollback [-v, --version_number VERSION_NUMBER] [--force]

firebase remoteconfig:experiments:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]

firebase remoteconfig:experiments:list

firebase remoteconfig:experiments:get EXPERIMENT_ID

firebase remoteconfig:experiments:get exp_promo_discount_2026

firebase remoteconfig:experiments:delete EXPERIMENT_ID

firebase remoteconfig:experiments:delete exp_promo_discount_2026

firebase remoteconfig:rollouts:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]

firebase remoteconfig:rollouts:list

firebase remoteconfig:rollouts:get ROLLOUT_ID

firebase remoteconfig:rollouts:get rollout_new_checkout_flow

firebase remoteconfig:rollouts:delete ROLLOUT_ID

firebase remoteconfig:rollouts:delete rollout_new_checkout_flow