Список рекламных кампаний
Возвращает список рекламных кампаний, привязанных к субклиенту
Request
GET
https://geoadv-api.yandex.ru/priority/v4/get-campaigns
Query parameters
|
Name |
Description |
|
limit* |
Type: number Количество рекламных кампаний |
|
offset* |
Type: number Оффсет ответа |
Headers
|
Name |
Description |
|
Client-Login* |
Type: string Логин субклиента, для кого запрашиваем список рекламных кампаний. Если его не будет - вернется список всех РК агентства |
Responses
200 OK
Найденные рекламные кампании
Body
application/json
{
"pager": {
"total": 0,
"limit": 0,
"offset": 0
},
"campaigns": [
{
"id": 0,
"status": "STOPPED",
"remainingDays": 0,
"url": "string",
"mapsOnly": false,
"name": "string",
"paused": false,
"company": {
"id": 0,
"name": "string",
"isChain": false,
"isOnline": false
},
"country": {
"geoId": 0,
"name": "string"
},
"users": [
{
"id": 0,
"login": "string"
}
],
"agency": {
"id": 0,
"name": 0
},
"beneficiary": {
"type": "FOREIGN_LEGAL",
"phone": "string",
"email": "string",
"inn": "string"
}
}
]
}
|
Name |
Description |
|
campaigns |
Type: CampaignV4[] Информация о рекламной кампании |
|
pager |
Type: GetCampaignsV4Pager Пагинация ответа |
CampaignV4
|
Name |
Description |
|
agency |
Type: CampaignV4Agency Информация о рекламном агентстве |
|
beneficiary |
Type: CampaignBeneficiary Данные о рекламодателе. |
|
company |
Type: CampaignV4Company |
|
country |
Type: CampaignV4Country Страна, для которой используется рекламная кампания |
|
id |
Type: number ID рекламной кампании |
|
mapsOnly |
Type: boolean Кампания рекламируется только на Яндекс Картах |
|
name |
Type: string Название рекламной кампании |
|
paused |
Type: boolean Остановлена ли рекламная кампания |
|
remainingDays |
Type: number Количество оставщихся дней |
|
status |
Type: string Статус рекламной кампании Enum: |
|
url |
Type: string Рекламируемый сайт |
|
users |
Type: CampaignV4User[] Пользователи, имеющие доступ к рекламной кампании |
GetCampaignsV4Pager
Пагинация ответа
|
Name |
Description |
|
limit |
Type: number Ограничение на количество кампаний в ответе |
|
offset |
Type: number Оффсет ответа |
|
total |
Type: number Общее количество кампаний |
CampaignV4Agency
Информация о рекламном агентстве
|
Name |
Description |
|
id |
Type: number ID рекламного агентства |
|
name |
Type: number Название рекламного агентства |
CampaignBeneficiary
Данные о рекламодателе.
|
Name |
Description |
|
|
Type: string Email рекламодателя |
|
inn |
Type: string ИНН рекламодателя. Обязателен для типов рекламодателей: - LEGAL - Юридическое лицо (12 символов) - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов) - INDIVIDUAL - ИП (12 символов) |
|
phone |
Type: string Номер телефона рекламодателя. Обязательное поле для типов рекламодателей: - FOREIGN_PHYSICAL - Иностранное физическое лицо - PHYSICAL - Физическое лицо |
|
type |
Type: string Тип рекламодателя. Возможные значения: - FOREIGN_LEGAL - Иностранное юридическое лицо - FOREIGN_PHYSICAL - Иностранное физическое лицо - INDIVIDUAL - ИП - LEGAL - Юридическое лицо - PHYSICAL - Физическое лицо Enum: |
CampaignV4Company
|
Name |
Description |
|
id |
Type: number ID компании (у которой только одна точка) или сети |
|
isChain |
Type: boolean Является ли организация сетевой |
|
isOnline |
Type: boolean Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник) |
|
name |
Type: string Название организации |
CampaignV4Country
Страна, для которой используется рекламная кампания
|
Name |
Description |
|
geoId |
Type: number Географический идентификатор страны |
|
name |
Type: string Название страны |
CampaignV4User
|
Name |
Description |
|
id |
Type: number ID пользователя |
|
login |
Type: string Логин пользователя |
500 Internal Server Error
Непредвиденная ошибка
No longer supported, please use an alternative and newer version.