Список рекламных кампаний

Возвращает список рекламных кампаний, привязанных к субклиенту

Request

GET

https://geoadv-api.yandex.ru/priority/v6/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": {
                "client": {
                    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
                    "inn": "string",
                    "name": "string",
                    "kpp": "string",
                    "epayNumber": "string",
                    "oksmNumber": "string",
                    "vat": "string",
                    "regNumber": "string"
                },
                "contractor": {
                    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
                    "inn": "string",
                    "name": "string",
                    "kpp": "string",
                    "epayNumber": "string",
                    "oksmNumber": "string",
                    "vat": "string",
                    "regNumber": "string"
                },
                "contract": {
                    "type": "contract  договор оказания услуг",
                    "isChargePaidByAgent": false,
                    "actionType": "distribution действия в целях распространения рекламы",
                    "subjectType": "org-distribution договор на организацию распространения рекламы",
                    "number": "string",
                    "date": "string",
                    "amount": 0,
                    "isVat": false
                }
            }
        }
    ]
}

Name

Description

campaigns

Type: CampaignV6[]

Информация о рекламной кампании

pager

Type: GetCampaignsV6Pager

Пагинация ответа

CampaignV6

Name	Description
agency	Type: CampaignV6Agency Информация о рекламном агентстве
beneficiary	Type: CampaignExtendedBeneficiary Данные о рекламодателе.
company	Type: CampaignV6Company
country	Type: CampaignV6Country Страна, для которой используется рекламная кампания
id	Type: number ID рекламной кампании
mapsOnly	Type: boolean Кампания рекламируется только на Яндекс Картах
name	Type: string Название рекламной кампании
paused	Type: boolean Остановлена ли рекламная кампания
remainingDays	Type: number Количество оставщихся дней
status	Type: string Статус рекламной кампании Enum: `STOPPED`, `WAITING`, `PAUSED`, `RUNNING`, `FINISHED`, `DELAYED_START`
url	Type: string Рекламируемый сайт
users	Type: CampaignV6User[] Пользователи, имеющие доступ к рекламной кампании

GetCampaignsV6Pager

Пагинация ответа

Name	Description
limit	Type: number Ограничение на количество кампаний в ответе
offset	Type: number Оффсет ответа
total	Type: number Общее количество кампаний

CampaignV6Agency

Информация о рекламном агентстве

Name

Description

Type: number

ID рекламного агентства

name

Type: number

Название рекламного агентства

CampaignExtendedBeneficiary

Данные о рекламодателе.

Name	Description
client*	Type: CampaignBeneficiaryClient Данные конечного рекламодателя
contract	Type: CampaignBeneficiaryContract Договор между клиентом и посредником
contractor	Type: CampaignBeneficiaryContractor Данные посредника

CampaignV6Company

Name	Description
id	Type: number ID компании (у которой только одна точка) или сети
isChain	Type: boolean Является ли организация сетевой
isOnline	Type: boolean Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)
name	Type: string Название организации

CampaignV6Country

Страна, для которой используется рекламная кампания

Name

Description

geoId

Type: number

Географический идентификатор страны

name

Type: string

Название страны

CampaignV6User

Name

Description

Type: number

ID пользователя

Type: string

Логин пользователя

CampaignBeneficiaryClient

Данные конечного рекламодателя

Name	Description
name*	Type: string ФИО или наименование клиента
type*	Type: string тип клиента Enum: `FOREIGN_LEGAL иностранное юридическое лицо`, `FOREIGN_PHYSICAL иностранное физическое лицо`, `INDIVIDUAL ИП`, `LEGAL юридическое лицо`, `PHYSICAL физическое лицо`
epayNumber	Type: string Номер электронного средства платежа. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL
inn	Type: string ИНН. Обязателен для рекламодателей типа: - PHYSICAL - INDIVIDUAL - LEGAL
kpp	Type: string КПП. Указывается для рекламодателей типа: - LEGAL
oksmNumber	Type: string Код страны регистрации лица в соответствии с ОКСМ. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL - FOREIGN_LEGAL
regNumber	Type: string Регистрационный номер либо его аналог Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет vat)
vat	Type: string Номер налогоплательщика либо его аналог в стране регистрации. Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет regNumber)

CampaignBeneficiaryContract

Договор между клиентом и посредником

Name	Description
date*	Type: string Дата заключения договора в формате YYYY-MM-DD
subjectType*	Type: string Предмет договора Enum: `org-distribution договор на организацию распространения рекламы`, `mediation посредничество`, `distribution договор на распространение рекламы`, `representation представительство`, `other иное`
type*	Type: string Тип договора Enum: `contract договор оказания услуг`, `intermediary-contract посреднический договор`
actionType	Type: string Роль посредника-представителя. Обязателен для договоров с типом: - intermediary-contract Enum: `distribution действия в целях распространения рекламы`, `conclude заключение договоров`, `commercial коммерческое представительство`, `other иное`
amount	Type: number Сумма
isChargePaidByAgent	Type: boolean Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора. Указывается для договоров с типом: - intermediary-contract
isVat	Type: boolean Включён ли НДС в сумму. Обязателен если есть amount.
number	Type: string Номер договора

CampaignBeneficiaryContractor

Данные посредника

Name	Description
name*	Type: string ФИО или наименование клиента
type*	Type: string тип клиента Enum: `FOREIGN_LEGAL иностранное юридическое лицо`, `FOREIGN_PHYSICAL иностранное физическое лицо`, `INDIVIDUAL ИП`, `LEGAL юридическое лицо`, `PHYSICAL физическое лицо`
epayNumber	Type: string Номер электронного средства платежа. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL
inn	Type: string ИНН. Обязателен для рекламодателей типа: - PHYSICAL - INDIVIDUAL - LEGAL
kpp	Type: string КПП. Указывается для рекламодателей типа: - LEGAL
oksmNumber	Type: string Код страны регистрации лица в соответствии с ОКСМ. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL - FOREIGN_LEGAL
regNumber	Type: string Регистрационный номер либо его аналог Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет vat)
vat	Type: string Номер налогоплательщика либо его аналог в стране регистрации. Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет regNumber)

500 Internal Server Error

Непредвиденная ошибка

Была ли статья полезна?

Список рекламных кампаний

Информация о рекламной кампании