Skip to main content

Получение плейсмента

Описание

Возвращает параметры плейсмента по его идентификатору placementId. Используйте метод, чтобы посмотреть статус плейсмента и его настройки перед привязкой кампаний.

URL-адрес

GET/catboss/placement/{placementId}

Параметры запроса

ПараметрГдеТипПримерОбязательныйОписание
placementIdpathinteger12ДаИдентификатор плейсмента

Пример запроса

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"
}

Возвращаемые параметры

ПараметрТипОписание
[].idintegerИдентификатор плейсмента
[].namestringНазвание плейсмента
[].descriptionstringОписание плейсмента
[].statusstringСтатус плейсмента
[].typestringТип плейсмента
[].template_idintegerИдентификатор шаблона
[].fill_modebooleanРежим заполнения выдачи
[].related_campaignsarraynull
[].default_strategyobjectСтратегия по умолчанию
[].default_strategy.algorithm_typestringТип алгоритма
[].default_strategy.algorithm_idintegerИдентификатор алгоритма
[].default_strategy.goalobjectЦель оптимизации
[].default_strategy.goal.typestringТип цели (ctr, revenue)
[].default_strategy.goal.namestringНазвание цели (CTR, Revenue)
[].default_strategy.filtersobjectФильтры
[].default_strategy.filters.mustarrayОбязательные условия
[].default_strategy.filters.mustNotarrayИсключающие условия
[].default_strategy.filters.shouldarrayЖелательные условия
[].default_strategy.filters.must[].attrstringАтрибут для фильтра
[].default_strategy.filters.must[].operatorstringОператор фильтра
[].default_strategy.filters.must[].valuesarrayЗначения для сравнения
[].default_strategy.filters.mustNot[].attrstringАтрибут для исключающего фильтра
[].default_strategy.filters.mustNot[].operatorstringОператор исключающего фильтра
[].default_strategy.filters.mustNot[].valuesarrayЗначения для исключения
[].default_strategy.merchandisingobjectМерчендайзинг
[].default_strategy.merchandising.strengthintegerСила влияния правил
[].default_strategy.merchandising.rulesarrayПравила мерчендайзинга
[].default_strategy.merchandising.rules[].attrstringАтрибут правила
[].default_strategy.merchandising.rules[].operatorstringОператор правила
[].default_strategy.merchandising.rules[].valuesarrayЗначения
[].default_strategy.merchandising.rules[].weightintegerВес правила (может быть отрицательным)