Управление & создание квот

Для чего нужны квоты?

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

Как получать квалификации для квот?

Для этого есть запрос – questions и searchQuestions. Первый запрос возвращает все вопросы, которые есть, а второй — использует поиск.

Пример возвращаемого Question:

{
  "id": 197,
  "questionType": "Select",
  "referencedId": "2",
  "locale_ru": "Ваш пол",
  "options": [
    {
      "id": 1857,
      "locale_ru": "Женский"
    },
    {
      "id": 1856,
      "locale_ru": "Мужской"
    }
  ]
}

Или для возраста:

{
    "id": 303,
    "questionType": "Number",
    "referencedId": null,
    "locale_ru": "Сколько вам лет?",
    "options": []
}

Для того чтобы использовать квалификации в квотах понадобятся ID. Дальше мы объясним, как создать и отредактировать квоту с примерами.

Чтобы понять, какие квоты создаются, можно использовать личный кабинет менеджера в Хабе. Все квоты, которые вы создаете в API, отображаются в ЛК, и vice-versa.

Какие бывают квоты?

Бывают обязательные условия и квоты. В API они описаны свойством isTotal. В случае true это означает, что пользователь обязательно должен попасть в эту квоту, чтобы квалифицироваться под опрос.

Как создать квоту?

Пример в Playground

Для этого мы используем мутацию createQuota

mutation($survey: Float!, $input: QuotaInput!) {
  createQuota(surveyId: $survey, input: $input) {
    id
    surveyId
  }
}

{
  // ID опроса
  "survey": 40,
  "input": {
    // Название квоты
    "name": "М18-24",
    // Обязательная квота или нет
    "isTotal": true,
    // Процентное соотношение от survey.wantedCompletes
    "percentSplit": 100,
    
    // Вместо "percentSplit" можно указывать "wantedCompletes", 
    // и тогда размер квоты будет в абсолютном количестве.
    
    // "wantedCompletes": 202,
    // Условия опроса
    "conditions": [{
      // ID квалификации (в данном случае, это вопрос выше про пол)
      "property": "197",
      // Логический оператор — всегда "Or"
      "logicalOperator": "Or",
      // Допустимые значения (в данном случае, 1856 — мужской)
      "options": [1856]
    }, {
      // ID квалификации (в данном случае, это вопрос выше про возраст)
      "property": "303",
      // Range возраста (можно указать несколько параметров, например от 18-24, и от 30 до 40.
      "range": [{
        "from": 18,
        "to": 24
      }],
      // Вместо "range" можно указать параметр "values" — и обозначить необходимый возраст в нем.
      // "values": [18,19,20,21,22,23,24],
      "logicalOperator": "Or"
    }]
  }
}

Для того, чтобы обновить квоту, есть метод updateQuota, а удалить — removeQuota.