Метод: POST /api/v1/advertiser/campaign
Описание: Вы можете создать рекламную кампанию через API для своего рекламного аккаунта HilltopAds.
Обратите внимание, что этот метод доступен только для форматов Popunder mobile и Popunder desktop.
Параметры:
имя | описание | пример | комментарий |
key | Уникальный ключ API, который вы можете сгенерировать в разделе API вашего аккаунта HilltopAds | nXzgO3Bc | Это обязательный параметр в запросе. |
format | Рекламный формат, для которого необходимо создать кампанию. | Popunder mobile | Вы можете указать только один рекламный формат. Это обязательный параметр в запросе. |
rate | Цена за 1000 показов (CPM). | 1.53 | Все цены (курс) указываются в запросе без валюты, но в результате будут установлены в USD. Это обязательный параметр в запросе. |
capTotal | Предельная частота показов. Этот параметр указывает количество показов объявления. | 2 | Вы можете указать только одно число. |
capResetAfter | Предельная частота показов. Этот параметр указывает, как долго показывать объявление. | 12 | Вы можете указать только одно число. |
capForCampaign | Предельная частота показов. Этот параметр указывает, применяется ли правило к кампании или баннеру. | кампания | Для формата Popunder можно указать только кампанию. |
channels | Сегмент и категория трафика, для которых необходимо запустить объявление. | мейнстрим/non-мейнстрим деятельность Высокая активность мейнстрим/non-мейнстрим Средняя активность мейнстрим/non-мейнстрим Низкая активность | Чтобы указать несколько сегментов активности, перечислите их через запятую. Обратите внимание, что вы можете указать только одну категорию трафика - мейнстрим/non-мейнстрим Это обязательный параметр в запросе. |
type | Тип рекламной кампании | CPM, CPC | Обратите внимание, что в настоящее время вы можете указать только тип кампании CPM. Это обязательный параметр в запросе. |
name | Название рекламной кампании. | Popunder_API | Название кампании должно быть уникальным и не повторяться с названиями уже созданных кампаний. Это обязательный параметр в запросе. |
url | Предложите URL-ссылку, по которой нужно отправить трафик. | Вы можете указать только одну ссылку. Это обязательный параметр в запросе. | |
active | Укажите статус созданной кампании: true - включена, false - выключена. | Правда, ложь | Если указать статус кампании как True (ON), кампания станет активной только после модерации. |
targeting | Необходимые настройки таргетинга для рекламной кампании.
| гео браузер os устройство мобильный оператор iprange osversions Приложение | Эти параметры передаются в виде объекта. Каждый новый параметр таргетинга указывается через запятую. |
Пример запроса:
Чтобы создать рекламную кампанию со следующими параметрами:
Формат объявления - Popunder mobile
Стоимость - $1.53
Частота показов - 2 показа в 12 часов для кампании
Каналы - мейнстрим высокой активности и средней активности
Тип - CPM (для формата объявлений Popunder можно указать только CPM)
Имя - Popunder_API
URL - https://mywebsite.com.
Активный - True
Таргетинг - ГЕО: США, Великобритания, DE; Браузер: Chrome, Safary; Устройство - мобильное
Обратите внимание, что если ваша ссылка содержит символ '&', вам необходимо перекодировать ее в формат URL-кода. В противном случае вы можете получить ошибку в ответе на запрос об изменении ссылки.
Например, ссылка
https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}}должен быть указан как
https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D
Чтобы перекодировать ссылку в формат URL, вы можете воспользоваться инструментом.
Вам нужно написать запрос в следующем формате:
curl -X POST --data '{"format": "Popunder mobile", "channels":["Mainstream High Activity", "Mainstream Medium Activity"], "type": "CPM", "rate":1.53, "name": "Popunder_API", "url": "https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D", "active":true, "capTotal":2, "capResetAfter":12, "capForCampaign": "campaign", "targeting":{"geo":{"operator": "in", "operand":["US", "UK", "DE"]}, "browser":{"operator": "in", "operand":["Chrome", "Safary"]}, "device":{"operator": "in", "operand":["Mobile/smartphone"]}}}' https://hilltopads.com/api/v1/advertiser/campaign?key=nXzgO3Bc