Получение плейсмента
Описание
Возвращает параметры плейсмента по его идентификатору placementId. Используйте метод, чтобы посмотреть статус плейсмента и его настройки перед привязкой кампаний.
URL-адрес
GET
/catboss/placement/{placementId}Параметры запроса
| Параметр | Где | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|---|
| placementId | path | integer | 12 | Да | Идентификатор плейсмента |
Пример запроса
bash
curl -X GET "https://example.com/api/catboss/placement/12" \
-H "X-MOODREC-API: <token>" \
-H "Accept: application/json"
Пример ответа
json
{
"default_strategy": {
"algorithm_id": 24,
"algorithm_type": "text_similarity",
"filters": {
"must": [],
"mustNot": [],
"should": []
},
"goal": {
"name": "CTR",
"type": "ctr"
},
"merchandising": {
"rules": [],
"strength": 0
}
},
"description": "Test",
"fill_mode": false,
"id": 224,
"name": "Test123",
"related_campaigns": [132, 133],
"status": "active",
"template_id": 1,
"type": "api"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| [].id | integer | Идентификатор плейсмента |
| [].name | string | Название плейсмента |
| [].description | string | Описание плейсмента |
| [].status | string | Статус плейсмента |
| [].type | string | Тип плейсмента |
| [].template_id | integer | Идентификатор шаблона |
| [].fill_mode | boolean | Режим заполнения выдачи |
| [].related_campaigns | array | null |
| [].default_strategy | object | Стратегия по умолчанию |
| [].default_strategy.algorithm_type | string | Тип алгоритма |
| [].default_strategy.algorithm_id | integer | Идентификатор алгоритма |
| [].default_strategy.goal | object | Цель оптимизации |
| [].default_strategy.goal.type | string | Тип цели (ctr, revenue) |
| [].default_strategy.goal.name | string | Название цели (CTR, Revenue) |
| [].default_strategy.filters | object | Фильтры |
| [].default_strategy.filters.must | array | Обязательные условия |
| [].default_strategy.filters.mustNot | array | Исключающие условия |
| [].default_strategy.filters.should | array | Желательные условия |
| [].default_strategy.filters.must[].attr | string | Атрибут для фильтра |
| [].default_strategy.filters.must[].operator | string | Оператор фильтра |
| [].default_strategy.filters.must[].values | array | Значения для сравнения |
| [].default_strategy.filters.mustNot[].attr | string | Атрибут для исключающего фильтра |
| [].default_strategy.filters.mustNot[].operator | string | Оператор исключающего фильтра |
| [].default_strategy.filters.mustNot[].values | array | Значения для исключения |
| [].default_strategy.merchandising | object | Мерчендайзинг |
| [].default_strategy.merchandising.strength | integer | Сила влияния правил |
| [].default_strategy.merchandising.rules | array | Правила мерчендайзинга |
| [].default_strategy.merchandising.rules[].attr | string | Атрибут правила |
| [].default_strategy.merchandising.rules[].operator | string | Оператор правила |
| [].default_strategy.merchandising.rules[].values | array | Значения |
| [].default_strategy.merchandising.rules[].weight | integer | Вес правила (может быть отрицательным) |