Charboost API — Методы для кампаний

Последнее обновление:
Некоторым из этих конечных точек нужен идентификатор кампании. Где найти идентификатор своей кампании?

 

 

Эта конечная точка предоставляет информацию о конкретной кампании (если указаны), иначе возвращает все кампании независимо от статуса.

bid_id предоставляется в отклике, который можно использовать для перечисленных ниже конечных точек.

Метод HTTP GET
Конечная точка https://api.chartboost.com/campaigns
Пример запроса https://api.chartboost.com/campaigns/?user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
campaign_id String Необязательное Ид. одной кампании Все

Поля отклика
Параметр Описание Для кого возвращается
app_id Ид. рекламируемого приложения Рекламодатель
bids Ид. целей кампаний; bid_id для конечных точек ниже Все
campaign_type marketplace, directdeal, crosspromotion Все
date_created Дата создания кампании (метка времени UNIX) Все
date_max Дата завершения кампании, если задана (метка времени UNIX) Все
date_min Дата начала кампании, если задана (метка времени UNIX) Все
date_modified Дата последнего изменения кампании (метка времени UNIX) Все
id Ид. кампании Все
name Название кампании Все
platform ios, google_play, amazon Все
priority Текущий приоритет показов кампании Все
promote_in Ид. публикующих приложений Публикаторы
status Текущий статус кампании: active, paused, archived Все

▲ К началу

 

Эта конечная точка возвращает подробную информацию о конкретном предложении цены, если оно указано в рамках кампании, иначе возвращаются все предложения цены этой кампании. Конечная точка /bid используется для Get Bid Info и всех следующих методов.


Метод HTTP GET
Конечная точка https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Пример запроса https://api.chartboost.com/campaigns/?{{Campaign ID}}/bid/{{Bid ID}}?campaign_id={{Campaign ID}}&bid_id={{Bid ID}}&user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}


Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
bid_id String Необязательное Ид. одного (целевого) предложения цены Все
campaign_id String Обязательное Ид. одной кампании Нет

Поля отклика
Параметр Описание Для кого возвращается
app_filter Устаревший Все
app_toggle Устаревший Все
bid_amount Предложение цены в долларах США Рекламодатели
bid_id Ид. предложения цены Все
bid_type Тип предложения цены за рекламирование
Подробнее о типах предложения цены ▶
Рекламодатели
budget Общий дневной бюджет для предложения цены (целевого) Рекламодатели
device_filter Устройства по серии или модели, выбранной в таргетинге Все
device_toggle true = включающий; false = исключающий Все
expire_date Дата истечения срока предложения цены в прямых сделках (метка времени UNIX) Все
is_enabled Определяет, активно ли предложение цены (целевое): true, false Все
location_filter Страны, выбранные в таргетинге Все
location_toggle true = включающий; false = исключающий Все
os_filter Операционные системы, выбранные в таргетинге: max = макс. версия; min = мин. версия Все
title Название предложения цены (целевого) Все

▲ К началу

 

Этот метод позволяет изменять существующее предложение цены. Каждым запросом можно изменить только одно предложение цены.


Метод HTTP PUT
Конечная точка https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Пример запроса См. код ниже

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}

Тело запроса:
{
    "campaign_id": {{Campaign ID}},
    "bid_id": {{Bid ID}},
    "user_id": {{Chartboost customer's user ID}},
    "user_signature": {{CB customer's user signature}}
}
				

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
bid_amount Number Необязательное Значение предложения цены в долларах США (например, "0.55")
Примечание: при обновлении этого значения нужно также задать bid_type.
Нет
bid_id String Обязательное Ид. одного (целевого) предложения цены Нет
bid_type String Необязательное, однако требуется для bid_amount Тип предложения цены (за клик или за установку) Нет
budget Number Необязательное Ежедневный бюджет в долларах США для этого предложения цены Нет
campaign_id String Обязательное Ид. одной кампании Нет
device_filter String Необязательное Разделенный запятыми список типов устройств (например, "iphone,ipod touch,ipad") Нет
device_toggle Boolean Необязательное Оператор для списка в device_filter:
true, если исключающий, и
false или absent, если включающий
false (включающий)
is_enabled Boolean Необязательное Включить или отключить предложение цены (
true = включить, false = отключить).
Нет
location_filter String Необязательное Разделенный запятыми список из двухбуквенных кодов стран (например, "US,CA"); если он пуст, то, по умолчанию, все страны.
Примечание: при обновлении фильтра стран также нужно задать location_toggle.
Нет
location_toggle Boolean Необязательное, но требуется для location_filter true, если location_filter –- «белый список» (т. е. таргетирует только эти страны), и
false, если location_filter – «черный список» (т. е. таргетирует все страны, кроме этих).
Нет
os_filter_max Number Необязательное Максимальная версия ОС (например, 8.0) Нет
os_filter_min Number Необязательное Минимальная версия ОС (например, 4.3) Нет

Поля отклика
Параметр Описание Для кого возвращается
app_filter Устаревший Все
app_toggle Устаревший Все
bid_amount Предложение цены в долларах США Рекламодатели
bid_id Ид. предложения цены Все
bid_type Тип предложения цены (за клик или за установку)
Подробнее о типах предложения цены ▶
Рекламодатели
budget Ежедневный бюджет в долларах США для этого предложения цены Рекламодатели
device_filter Список типов устройств Все
device_toggle true = исключающий; false = включающий Все
expire_date Дата истечения срока предложения цены в прямых сделках (метка времени UNIX) Все
is_enabled Определяет, активно ли предложение цены;
true = включено
false = отключено
Все
location_filter Список стран Все
location_toggle true = включающий; false = исключающий Все
os_filter min = мин. версия ОС; max = макс. версия ОС Все
title Название цели (предложения цены) Все

▲ К началу

 

Этот метод предназначен только для кампаний рекламирования и позволяет создавать новые предложения цены в рамках кампании. Название нового предложения цены будет соответствовать ид. предложения цены, но его можно переименовать на панели пользователя.


Метод HTTP POST
Конечная точка https://api.chartboost.com/campaigns/{{Campaign ID}}/bid
Пример запроса См. код ниже

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid

Request Body:
{
 "campaign_id": {{Campaign ID}},
 "bid_amount": {{Bid Amount}},
 "bid_type": {{Bid Type}},
 "user_id": {{Chartboost customer's user ID}},
 "user_signature": {{CB customer's user signature}}
}

Параметры
Параметр Тип запроса Обязательное? Описание По умолчанию
bid_amount Number Обязательное Значение предложения цены в долларах США (например, "0.55")
Примечание: при обновлении этого значения также нужно задать bid_type.
Нет
bid_type String Обязательное Тип предложения цены (за клик или за установку) Нет
budget Number Обязательное Ежедневный бюджет в долларах США для этого предложения цены Нет
campaign_id String Обязательное Ид. одной кампании Нет
device_filter String Необязательное Разделенный запятыми список типов устройств (например, "iphone,ipod touch,ipad") Нет
device_toggle Boolean Необязательное Оператор для списка в device_filter
true, если исключающий,
false или absent, если включающий
false (включающий)
is_enabled Boolean Необязательное Включить или отключить предложение цены (
true = включить, false = отключить).
Нет
location_filter String Необязательное Разделенный запятыми список из двухбуквенных кодов стран (например, "US,CA"); если пуст, то, по умолчанию, все страны
Примечание: при обновлении фильтра стран также нужно задать location_toggle.
Нет
location_toggle Boolean Необязательное, но требуется для location_filter true, если location_filter –- «белый список» (т. е. таргетирует только эти страны),
false, если location_filter – «черный список» (т. е. таргетирует все страны, кроме этих)
Нет
os_filter_max Number Необязательное Максимальная версия ОС (например, 8.0) Нет
os_filter_min Number Необязательное Минимальная версия ОС (например, 4.3) Нет

Поля отклика
Параметр Описание Для кого возвращается
app_filter Устаревший Все
app_toggle Устаревший Все
bid_amount Предложение цены в долларах США Рекламодатели
bid_id Ид. предложения цены Все
bid_type Тип предложения цены (за клик или за установку)
Подробнее о типах предложения цены ▶
Рекламодатели
budget Ежедневный бюджет в долларах США для этого предложения цены Рекламодатели
device_filter Список типов устройств Все
device_toggle true = исключающий; false = включающий Все
expire_date Дата истечения срока предложения цены в прямых сделках (метка времени UNIX) Все
is_enabled Определяет, активно ли предложение цены;
true = включено
false = отключено
Все
location_filter Список стран Все
location_toggle true = включающий; false = исключающий Все
os_filter min = мин. версия ОС; max = макс. версия ОС Все
title Название цели (предложения цены) Все

▲ К началу

 


Вам может быть интересно...