Метод: PUT /api/v1/advertiser/campaign/{id}
Описание: Вы можете обновить созданную рекламную кампанию через API для вашего аккаунта HilltopAds.
Обратите внимание, что этот метод доступен только для форматов Popunder mobile и Popunder desktop.
Параметры:
имя | описание | пример | комментарий |
key | Уникальный ключ API, который вы можете сгенерировать в разделе API вашего аккаунта HilltopAds | nXzgO3Bc | Это обязательный параметр в запросе. |
campaignID | ID рекламной кампании, которую необходимо обновить
| 123456 | Вы можете указать ID только одной рекламной кампании. Это обязательный параметр в запросе. |
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 - ON, false - OFF | Правда, ложь | Если указать статус кампании как True (ON), кампания станет активной только после модерации. |
targeting | Необходимые настройки таргетинга для рекламной кампании. | гео браузер os устройство мобильный оператор iprange osversions Приложение | Эти параметры передаются в виде объекта. Каждый новый параметр таргетинга указывается через запятую. |
Пример запроса:
Чтобы обновить следующие параметры в созданной рекламной кампании с ID 123456:
Тариф - до $2,53
Частота показов - до 1 показа в 24 часа для кампании
URL - на https://mywebsit2.com
Обратите внимание, что если ваша ссылка содержит символ '&', вам необходимо перекодировать ее в формат URL-кода. В противном случае вы можете получить ошибку в ответе на запрос об изменении ссылки.
Например, ссылка
https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}}
должен быть указан как
https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D
Чтобы перекодировать ссылку в формат URL, вы можете воспользоваться инструментом.
Вам нужно написать запрос в следующем формате:
curl -X PUT --data '{"rate": "2.53", "capTotal":1, "capResetAfter":24, "capForCampaign": "campaign", "url": "https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D"}' https://hilltopads.com/api/v1/advertiser/campaign/123456?key=nXzgO3Bc