sigma.includeForceUser

sigma.includeForceUser(experimentId: string, groupIndex?: number)

Метод добавляет пользователя в принудительный список эксперимента (experimentId). Если указан второй параметр — индекс группы (groupIndex), пользователь будет добавлен в принудительный список группы эксперимента.

к сведению

Метод также работает с холдаутами.

Параметры

experimentId: string
Обязательный параметр: идентификатор эксперимента

groupIndex?: number
Необязательный параметр: индекс группы эксперимента

Примечания

Метод завершит работу с предупреждением, если:

• Тип идентификатора эксперимента отсутствует в userData.
• Будет попытка передать несуществующий индекс группы.

к сведению

По завершении работы с методом sigma.includeForceUser(_), рекомендуется удалить пользователя методом sigma.excludeForceUser или sigma.excludeForceUserAll.

Пример использования

const Sigma = require('expf-sigma-node.js').default;

const token = '<TOKEN>';
const userData = { userId: '<USER_ID>' };
const sigma = new Sigma(token, userData);

try {
  console.log(await sigma.getAllUserExperiments()); // null

  await sigma.includeForceUser('<EXPERIMENT_ID>');
  await sigma.includeForceUser('<EXPERIMENT_2_ID>', 0);

  console.log(await sigma.getAllUserExperiments()); // '<EXPERIMENT_ID>.1|<EXPERIMENT_2_ID>.0'

  sigma.excludeForceUser('<EXPERIMENT_ID>');
  sigma.excludeForceUser('<EXPERIMENT_2_ID>');

  console.log(await sigma.getAllUserExperiments()); // null
} catch (error) {
  // Обработка ошибки
}