Список рекламных кампаний
Получает список рекламных кампаний с их статусами, привязанных к субклиенту.
Request
GET
https://geoadv-api.yandex.ru/priority/v1/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,
"name": "string",
"chainId": 0,
"isChainCampaign": false,
"companyDescription": {
"companyId": 0,
"name": "string",
"online": false
},
"paused": false,
"status": "DELAYED_START",
"users": {
"id": 0,
"login": "string"
},
"agency": {
"id": 0,
"name": 0
},
"country": {
"geoID": 0
},
"remainingDays": 0,
"type": "WEB"
}
}
|
Name |
Description |
|
campaigns |
Type: Campaign Информация о рекламных кампаниях. |
|
pager |
Type: GetCampaignsPager Пагинация ответа. |
Campaign
Информация о рекламных кампаниях.
|
Name |
Description |
|
agency |
Type: CampaignAgency Информация о рекламном агентстве. |
|
chainId |
Type: number ID организации, у которых несколько физических точек (сетевые или франшизы) |
|
companyDescription |
|
|
country |
Type: CampaignCountry Страна для которой используется рекламная кампания. |
|
id |
Type: number ID рекламной кампании. |
|
isChainCampaign |
Type: boolean Входит ли организация в сеть. |
|
name |
Type: string Название рекламной кампании. |
|
paused |
Type: boolean Остановлена ли рекламная кампания. |
|
remainingDays |
Type: number Количество дней оставшихся в рекламной кампании. |
|
status |
Type: string Текущий статус рекламной кампании. Enum: |
|
type |
Type: string Тип рекламной кампании. Enum: |
|
users |
Type: CampaignUsers Пользователи, имеющие доступ к рекламной кампании. |
GetCampaignsPager
Пагинация ответа.
|
Name |
Description |
|
limit |
Type: number Ограничение на количество кампаний в ответе. |
|
offset |
Type: number Оффсет ответа. |
|
total |
Type: number Общее количество кампаний. |
CampaignAgency
Информация о рекламном агентстве.
|
Name |
Description |
|
id |
Type: number ID рекламного агентства. |
|
name |
Type: number Название рекламного агентства. |
CampaignCompanyDescription
|
Name |
Description |
|
companyId |
Type: number ID компании, у которой только одна точка или конкретной точки сети. |
|
name |
Type: string Название организации. |
|
online |
Type: boolean Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник) |
CampaignCountry
Страна для которой используется рекламная кампания.
|
Name |
Description |
|
geoID |
Type: number Географический идентификатор страны. |
CampaignUsers
Пользователи, имеющие доступ к рекламной кампании.
|
Name |
Description |
|
id |
Type: number ID пользователя. |
|
login |
Type: string Логин пользователя. |
No longer supported, please use an alternative and newer version.