API Яндекс.Бизнес
Sections
Specification
Open API
{
"openapi": "3.0.1",
"info": {
"title": "API Яндекс.Бизнес",
"description": "",
"version": ""
},
"servers": [
{
"url": "https://geoadv-api.yandex.ru"
}
],
"tags": [
{
"name": "Campaign_management",
"description": "Работа с рекламной кампанией."
},
{
"name": "Payment",
"description": "Оплата рекламной кампании."
},
{
"name": "Generate_commercial_offer",
"description": "Генерация коммерческого предложения (КП)."
}
],
"paths": {
"/priority/v4/campaign-beneficiary": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Указание рекламодателя",
"description": "Запрос на указание рекламодателя для рекламной кампании.\n 1 сентября 2022 года изменился закон «О рекламе». Из-за этого нам нужны данные о конечном рекламодателе — чтобы кампания не нарушала закон",
"operationId": "CampaignBeneficiaryV4",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос",
"properties": {
"campaignId": {
"type": "number",
"description": "ID кампании"
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Рекламодатель успешно установлен",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ответ",
"properties": {
"data": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
}
},
"500": {
"description": "Ошибка при выполнении запроса",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при установке рекламодателя.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
}
}
}
}
}
}
}
}
},
"/priority/v6/campaign-beneficiary": {
"post": {
"tags": [
"Campaign_management"
],
"summary": "Указание рекламодателя",
"description": "Запрос на указание рекламодателя для рекламной кампании.\n 1 сентября 2022 года изменился закон «О рекламе». Из-за этого нам нужны данные о конечном рекламодателе — чтобы кампания не нарушала закон",
"operationId": "CampaignBeneficiaryV6",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос",
"properties": {
"campaignId": {
"type": "number",
"description": "ID кампании"
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
},
"required": [
"campaignId",
"beneficiary"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Рекламодатель успешно установлен",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ответ",
"properties": {
"data": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
}
}
}
},
"400": {
"description": "Невалидный client.type",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при установке рекламодателя.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"BENEFICIARY_IS_NOT_VALID // Ошибка валидации данных о рекламодателе"
]
},
"businessData": {
"type": "string",
"description": "Данные валидации"
}
}
}
}
}
},
"422": {
"description": "Ошибка валидации",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при установке рекламодателя.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"BENEFICIARY_IS_NOT_VALID // Ошибка валидации данных о рекламодателе"
]
},
"businessData": {
"type": "string",
"description": "Данные валидации"
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v5/get-campaign-beneficiary": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Получение данных о рекламодателе",
"description": "Возвращает данные о рекламодателе",
"operationId": "GetCampaignExtendedBeneficiary",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Найденные рекламные кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v4/get-campaigns": {
"get": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Список рекламных кампаний",
"description": "Возвращает список рекламных кампаний, привязанных к субклиенту",
"operationId": "GetCampaignsGetV4",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента, для кого запрашиваем список рекламных кампаний. Если его не будет - вернется список всех РК агентства",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "limit",
"description": "Количество рекламных кампаний",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "offset",
"description": "Оффсет ответа",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Найденные рекламные кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Список рекламных кампаний",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"campaigns": {
"type": "array",
"description": "Информация о рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v6/get-campaigns": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Список рекламных кампаний",
"description": "Возвращает список рекламных кампаний, привязанных к субклиенту",
"operationId": "GetCampaignsGetV6",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента, для кого запрашиваем список рекламных кампаний. Если его не будет - вернется список всех РК агентства",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "limit",
"description": "Количество рекламных кампаний",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "offset",
"description": "Оффсет ответа",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Найденные рекламные кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Список рекламных кампаний",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"campaigns": {
"type": "array",
"description": "Информация о рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v5/get-campaign": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Информация о рекламной кампании",
"description": "Возвращает информацию о конкретной рекламной кампании",
"operationId": "GetCampaingGetV5",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Информация о рекламной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
},
"isBeneficiaryValid": {
"type": "boolean",
"description": "Статус корректности заполнения данных о рекламодателе"
},
"siteType": {
"type": "string",
"description": "Тип рекламируемого сайта",
"enum": [
"NONE // Возвращается для рекламной кампании без сайта",
"NORMAL // Обычный сайт",
"LANDING // Сайт от Яндекс Бизнеса",
"TELEGRAM // Telegram канал",
"OUTSIDER // Данный тип сайта не поддержан в API"
]
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v4/get-campaign": {
"get": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Информация о рекламной кампании",
"description": "Возвращает информацию о конкретной рекламной кампании",
"operationId": "GetCampaingGetV4",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Информация о рекламной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v1/get-campaign": {
"get": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Информация о рекламной кампании",
"description": "Отдает информацию о конкретной рекламной кампании: цене, остатке дней, примененном промокоде.",
"operationId": "GetCampaingGet",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Информация о рекламной кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании"
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID организации с одной точкой или один филиал сети"
},
"isChain": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"name": {
"type": "string",
"description": "Название организации"
}
}
},
"campainPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v4/launch-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Запуск рекламной кампании",
"description": "Запускает рекламную кампанию. На кошельке должны быть деньги. Происходит списание денег с кошелька и старт кампании. Нужно вызывать только для кампании в статусе waiting, stopped, finished. В противном случае произойдет продление еще не оконченной кампании\n",
"operationId": "LaunchCampaignPostV4",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"monthAmount": {
"type": "number",
"description": "Сумма месячного бюджета рекламной кампании. Должна быть не меньше значения в MINIMAL бюджете за 30 дней\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании",
"enum": [
90,
180,
360
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Рекламная кампания запущена"
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания",
"NOT_ENOUGH_MONEY // недостаточно средств на кошельке",
"PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах",
"BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах",
"NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты",
"CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку",
"CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление",
"UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты",
"UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается",
"BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v5/launch-campaign": {
"post": {
"tags": [
"Campaign_management"
],
"summary": "Запуск рекламной кампании",
"description": "Запускает рекламную кампанию. На кошельке должны быть деньги. Происходит списание денег с кошелька и старт кампании. Нужно вызывать только для кампании в статусе waiting, stopped, finished. В противном случае произойдет продление еще не оконченной кампании\n",
"operationId": "LaunchCampaignPostV5",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"monthAmount": {
"type": "number",
"description": "Сумма месячного бюджета рекламной кампании. Должна быть не меньше значения в MINIMAL бюджете за 30 дней. Обязателен при launchType=DEFAULT, иначе игнорируется\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании для launchType=DEFAULT",
"enum": [
90,
180,
360
]
}
},
"required": [
"campaignId",
"duration"
]
},
{
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"totalAmount": {
"type": "number",
"description": "Сумма всего бюджета рекламной кампании. Должна быть в пределах minAmount и maxAmount включительно. Обязателен при launchType=SHORT_PERIOD, иначе игнорируется\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании для launchType=SHORT_PERIOD, должна быть в пределах minDuration и maxDuration включительно"
}
},
"required": [
"campaignId",
"duration"
]
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Рекламная кампания запущена"
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания",
"NOT_ENOUGH_MONEY // недостаточно средств на кошельке",
"PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах",
"BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах",
"NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты",
"CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку",
"CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление",
"UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты",
"UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается",
"BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v4/campaign-price": {
"get": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Получение цен для кампании",
"description": "Возвращает бюджеты для рекламной кампании. Для кампаний с mapsOnly будет возвращаться только MINIMAL бюджет.\n",
"operationId": "CampaignPriceGetV4",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Возращает бюджеты для рекламной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"fixedUntil": {
"type": "string",
"description": "Дата, до которой цена зафиксирована"
},
"price": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v5/campaign-price": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Получение цен для кампании",
"description": "Возвращает бюджеты для рекламной кампании. Для кампаний с mapsOnly будет возвращаться только MINIMAL бюджет.\n",
"operationId": "CampaignPriceGetV5",
"parameters": [
{
"in": "query",
"name": "campaignId",
"description": "ID рекламной кампании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Возращает бюджеты для рекламной кампании",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"fixedUntil": {
"type": "string",
"description": "Дата, до которой цена зафиксирована. Доступна для launchType=DEFAULT"
},
"price": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
}
}
},
{
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"price": {
"type": "object",
"description": "Информация о ценах для SHORT_PERIOD",
"properties": {
"minDuration": {
"type": "number",
"description": "Минимальная длительность рекламной кампании в днях"
},
"maxDuration": {
"type": "number",
"description": "Максимальная длительность рекламной кампании в днях"
},
"durationStep": {
"type": "number",
"description": "Шаг выбора длительности в днях"
},
"minAmount": {
"type": "number",
"description": "Минимальный бюджет для запуска в валюте из currency"
},
"maxAmount": {
"type": "number",
"description": "Максимальный бюджет для запуска в валюте из currency"
},
"amountStep": {
"type": "number",
"description": "Шаг выбора бюджета в валюте из currency"
},
"promo": {
"type": "object",
"description": "Информация о промокоде, если он применён и активен",
"properties": {
"discount": {
"type": "number",
"description": "Скидка в деньгах"
},
"bonus": {
"type": "number",
"description": "Бонус к бюджету в деньгах"
},
"minTotalAmount": {
"type": "number",
"description": "Минимальный бюджет, с которого начинает действовать промокод"
},
"minMonthAmount": {
"type": "number",
"description": "Минимальный месячный бюджет, с которого начинает действовать промокод"
},
"minDuration": {
"type": "number",
"description": "Минимальная длительность запуска, с которой начинает действовать промокод"
},
"percentDiscount": {
"type": "number",
"description": "Скидка в процентах"
},
"percentBonus": {
"type": "number",
"description": "Бонус к бюджету в процентах"
},
"percentBonusLimit": {
"type": "number",
"description": "Максимальная сумма процентного бонуса в деньгах"
}
}
}
}
}
}
}
]
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v4/create-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Создание рекламной кампании",
"description": "Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId, если создаем на организацию с одной физической точкой (или один филиал сети), chainId — если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно\n",
"operationId": "CreateCampaignPostV4",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента на кого создаем рекламную кампанию",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"description": "Информация о рекламной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на создание кампании",
"properties": {
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)\n"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны. Обязательный при указании chainId"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт. Не учитывается при указании chainId или mapsOnly"
},
"mapsOnly": {
"type": "boolean",
"description": "Создание кампании с рекламой только на Яндекс Картах"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Информация о созданной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Статус",
"enum": [
"READY",
"PROCESSING"
]
},
"id": {
"type": "number",
"description": "ID созданной рекламной кампании"
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства",
"USER_NOT_FOUND не смогли найти пользователя из хедера",
"AGENCY_COULD_NOT_BE_OWNER_IN_CAMPAIGN пытаемся создать кампанию на логин, который является агентством",
"BALANCE_CLIENT_NOT_EXIST неизвестное агентство",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT пользователь не субклиент агенства",
"NO_PRODUCTS_AVAILABLE нет доступных продуктов"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v5/create-campaign": {
"post": {
"tags": [
"Campaign_management"
],
"summary": "Создание рекламной кампании",
"description": "Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId, если создаем на организацию с одной физической точкой (или один филиал сети), chainId — если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно.\n",
"operationId": "CreateCampaignPostV5",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента на кого создаем рекламную кампанию",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"description": "Информация о рекламной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на создание кампании",
"properties": {
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)\n"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Рекламируемый сайт. Не учитывается при указании chainId или mapsOnly. Если передаётся ссылка на телеграм-канал, то создается телеграмная рекламная кампания, подробнее https://business.yandex.ru/subscription/telegram_advertising\n"
},
"mapsOnly": {
"type": "boolean",
"description": "Создание кампании с рекламой только на Яндекс Картах"
}
},
"required": [
"countryGeoId"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Информация о созданной кампании",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Статус",
"enum": [
"READY",
"PROCESSING"
]
},
"id": {
"type": "number",
"description": "ID созданной рекламной кампании"
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства",
"USER_NOT_FOUND не смогли найти пользователя из хедера",
"AGENCY_COULD_NOT_BE_OWNER_IN_CAMPAIGN пытаемся создать кампанию на логин, который является агентством",
"BALANCE_CLIENT_NOT_EXIST неизвестное агентство",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT пользователь не субклиент агенства",
"NO_PRODUCTS_AVAILABLE нет доступных продуктов"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка"
}
}
}
},
"/priority/v3/price": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Получение цен",
"description": "Показывает доступные бюджеты для конкретной рекламной кампании.",
"operationId": "PricePostV3",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на рассчет бюджета.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании. Получаем после /priority/v1/create-campaign. Применяется когда нужно посмотреть стоимость с учетом привязанного промокода"
},
"companyId": {
"type": "number",
"description": "ID организации у которой одна физическая точка. Получаем из /priority/v1/company-search"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search."
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"branding": {
"type": "boolean",
"description": "Передаем если необходимо рассчитать цену с брендированным пином на Яндекс.Картах (только для рекламы на Картах, geoproduct)"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Возращает все цены по всем продуктам.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Цены на рекламные продукты для этой организации или кампании",
"properties": {
"data": {
"type": "object",
"description": "Все доступные бюджеты",
"properties": {
"allowGeoproduct": {
"type": "boolean",
"description": "Возможен ли заказ «Рекламной подписки» для организации"
},
"allowSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Приоритетное размещение на Яндекс.Картах»"
},
"allowWebSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Веб подписки»"
},
"currency": {
"type": "string",
"description": "Валюта рекламной кампании."
},
"geoproduct": {
"type": "object",
"description": "Цены для «Приоритетное размещение на Картах»",
"properties": {
"DEFAULT": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"subscription": {
"type": "object",
"description": "Цены для «Рекламной подписки на Яндекс»",
"properties": {
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"websubscription": {
"type": "object",
"description": "Цены для «Рекламной веб подписки»",
"properties": {
"WEB_OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
}
}
},
"fixedUntil": {
"type": "string",
"description": "Дата до которой цена зафиксирована"
}
}
}
}
}
}
}
}
},
"/priority/v3/launch-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Бюджетный запуск",
"description": "Запускает рекламную кампанию. На кошельке должны быть деньги. Происходит списание денег с кошелька и старт кампании. Нужно вызывать только для кампании в статусе waiting, stopped, finished. В противном случае произойдет продление еще не оконченной кампании",
"operationId": "LaunchCampaignPostV3",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на запуск рекламной кампании.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании."
},
"budgetType": {
"type": "string",
"description": "Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct",
"enum": [
"OPTIMAL",
"MAXIMAL",
"MINIMAL",
"WEB_OPTIMAL",
"WEB_MAXIMAL",
"WEB_MINIMAL",
"CUSTOM",
"DEFAULT"
]
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "ID полученной задачи"
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания",
"NOT_ENOUGH_MONEY // недостаточно средств на кошельке",
"PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах",
"BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах",
"NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты",
"CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку",
"CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление",
"UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты",
"UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается",
"BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v3/create-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Создание рекламной кампании",
"description": "Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId если создаем на организацию с одной физической точкой (или один филиал сети), chainId если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно.",
"operationId": "CreateCampaignPostV3",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента на кого создаем рекламную кампанию",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"description": "Информация о рекламной кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на создание кампании.",
"properties": {
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
},
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Сайт организации нужен для создания веб кампании."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Информация о созданной кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Статус READY | PROCESSING."
},
"id": {
"type": "number",
"description": "ID созданной рекламной кампании."
},
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства",
"USER_NOT_FOUND не смогли найти пользователя из хедера",
"AGENCY_COULD_NOT_BE_OWNER_IN_CAMPAIGN пытаемся создать кампанию на логин, который является агентством",
"BALANCE_CLIENT_NOT_EXIST неизвестное агентство",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT пользователь не субклиент агенства",
"NO_PRODUCTS_AVAILABLE нет доступных продуктов"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v2/price": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Получение цен",
"description": "Показывает доступные бюджеты. Чтобы получить цены для организации нужно передавать companyId или chainId. Для цены конкретной рекламной кампании с промокодом надо указывать campaignId",
"operationId": "PricePostV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на рассчет бюджета.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании. Получаем после /priority/v1/create-campaign. Применяется когда нужно посмотреть стоимость с учетом привязанного промокода"
},
"companyId": {
"type": "number",
"description": "ID организации у которой одна физическая точка. Получаем из /priority/v1/company-search"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search."
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"branding": {
"type": "boolean",
"description": "Передаем если необходимо рассчитать цену с брендированным пином на Яндекс.Картах (только для рекламы на Картах, geoproduct)"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Возращает все цены по всем продуктам.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Цены на рекламные продукты для этой организации или кампании",
"properties": {
"data": {
"type": "object",
"description": "Все доступные бюджеты",
"properties": {
"allowGeoproduct": {
"type": "boolean",
"description": "Возможен ли заказ «Рекламной подписки» для организации"
},
"allowSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Приоритетное размещение на Яндекс.Картах»"
},
"allowWebSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Веб подписки»"
},
"currency": {
"type": "string",
"description": "Валюта рекламной кампании."
},
"geoproduct": {
"type": "object",
"description": "Цены для «Приоритетное размещение на Картах»",
"properties": {
"DEFAULT": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"subscription": {
"type": "object",
"description": "Цены для «Рекламной подписки на Яндекс»",
"properties": {
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"websubscription": {
"type": "object",
"description": "Цены для «Рекламной веб подписки»",
"properties": {
"WEB_OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
}
}
},
"fixedUntil": {
"type": "string",
"description": "Дата до которой цена зафиксирована"
}
}
}
}
}
}
}
}
},
"/priority/v2/launch-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Бюджетный запуск",
"description": "Запускает рекламную кампанию. На кошельке должны быть деньги. Происходит списание денег с кошелька и старт кампании. Нужно вызывать только для кампании в статусе waiting, stopped, finished. В противном случае произойдет продление еще не оконченной кампании",
"operationId": "LaunchCampaignPostV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на запуск рекламной кампании.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании."
},
"product": {
"type": "string",
"description": "Тип продукта.",
"enum": [
"subscriptionf",
"websubscription",
"geoproduct"
]
},
"budgetType": {
"type": "string",
"description": "Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct",
"enum": [
"OPTIMAL",
"MAXIMAL",
"MINIMAL",
"WEB_OPTIMAL",
"WEB_MAXIMAL",
"WEB_MINIMAL",
"CUSTOM",
"DEFAULT"
]
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "ID полученной задачи"
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания",
"NOT_ENOUGH_MONEY // недостаточно средств на кошельке",
"PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах",
"BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах",
"NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты",
"CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку",
"CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление",
"UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты",
"UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается",
"BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v1/company-search": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Поиск организации",
"description": "Поиск организации в базе Справочника. Поиск можно делать как по названию, так по email, адресу, телефону или другим связанным параметрам. Также можно их объединять, например: Кафе Солнышко Челябинск ул. Ленин.",
"operationId": "CompanySearchGet",
"parameters": [
{
"in": "query",
"name": "text",
"description": "Поисковый запрос (в любом формате).",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "limit",
"description": "Ограничение на количество ответов.",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "offset",
"description": "Оффсет возвращаемых ответов.",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "geoId",
"description": "Географический идентификатор страны. 225 для России.",
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Список найденных компаний.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Поиск организации.",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Количество элементов в ответе."
},
"limit": {
"type": "number",
"description": "Ограничение на количество элементов в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"companies": {
"type": "object",
"description": "Результат поиска для организации с одной физической точкой.",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации"
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации"
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"country": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
},
"companieschain": {
"type": "object",
"description": "Результат поиска для организации входящая в сеть (несколько физических точек).",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации."
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации."
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"chainCountries": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/priority/v1/is-owner": {
"get": {
"tags": [
"Campaign_management"
],
"summary": "Проверка прав на организацию",
"description": "Проверяет есть ли у субклиента права на организацию. Для получения прав нужно попросить пользователя добавить логин субклиента владельцем организации в Яндекс.Справочнике",
"operationId": "IsOwnerGet",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента чьи права проверяем",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "chainId",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "companyId",
"description": "ID организации, у которой только одна точка.",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "countryGeoId",
"description": "Географический идентификатор страны",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Успешный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"owned": {
"description": "Наличие прав на компанию.",
"type": "boolean"
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"COUNTRY_NOT_FOUND не валидный countryGeoId",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT указанный логин не субклиент агенства"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v1/create-campaign": {
"post": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Создание рекламной кампании",
"description": "Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId если создаем на организацию с одной физической точкой (или один филиал сети), chainId если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно.",
"operationId": "CreateCampaignPostV1",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента на кого создаем рекламную кампанию",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"description": "Информация о рекламной кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на создание кампании.",
"properties": {
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Сайт организации нужен для создания веб кампании."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Информация о созданной кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "Статус READY | PROCESSING."
},
"id": {
"type": "number",
"description": "ID созданной рекламной кампании."
},
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства",
"USER_NOT_FOUND не смогли найти пользователя из хедера",
"AGENCY_COULD_NOT_BE_OWNER_IN_CAMPAIGN пытаемся создать кампанию на логин, который является агентством",
"BALANCE_CLIENT_NOT_EXIST неизвестное агентство",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT пользователь не субклиент агенства",
"NO_PRODUCTS_AVAILABLE нет доступных продуктов"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v1/get-campaigns": {
"get": {
"deprecated": true,
"tags": [
"Campaign_management"
],
"summary": "Список рекламных кампаний",
"description": "Получает список рекламных кампаний с их статусами, привязанных к субклиенту.",
"operationId": "GetCampaignsGet",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента, для кого запрашиваем список рекламных кампаний. Если его не будет - вернется список всех РК агентства.",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "limit",
"description": "Количество рекламных кампаний.",
"schema": {
"type": "number"
},
"required": true
},
{
"in": "query",
"name": "offset",
"description": "Оффсет ответа.",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Найденные рекламные кампании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на получение кампаний.",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний."
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"campaigns": {
"type": "object",
"description": "Информация о рекламных кампаниях.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании."
},
"name": {
"type": "string",
"description": "Название рекламной кампании."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"isChainCampaign": {
"type": "boolean",
"description": "Входит ли организация в сеть."
},
"companyDescription": {
"type": "object",
"properties": {
"companyId": {
"type": "number",
"description": "ID компании, у которой только одна точка или конкретной точки сети."
},
"name": {
"type": "string",
"description": "Название организации."
},
"online": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания."
},
"status": {
"type": "string",
"description": "Текущий статус рекламной кампании.",
"enum": [
"DELAYED_START",
"FINISHED",
"PAUSED",
"RUNNING",
"STOPPED",
"WAITING"
]
},
"users": {
"type": "object",
"description": "Пользователи, имеющие доступ к рекламной кампании.",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя."
},
"login": {
"description": "Логин пользователя.",
"type": "string"
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства."
},
"name": {
"type": "number",
"description": "Название рекламного агентства."
}
}
},
"country": {
"type": "object",
"description": "Страна для которой используется рекламная кампания.",
"properties": {
"geoID": {
"type": "number",
"description": "Географический идентификатор страны."
}
}
},
"remainingDays": {
"type": "number",
"description": "Количество дней оставшихся в рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
}
}
}
}
}
}
}
}
}
}
},
"/priority/v1/apply-promocode": {
"post": {
"tags": [
"Campaign_management"
],
"summary": "Применение промокода к кампании",
"description": "Позволяет применить промокод к созданной рекламной кампании",
"operationId": "ApplyPromocodePost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода."
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Возращает все цены по всем продуктам.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о рекламных кампаниях.",
"properties": {
"data": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода."
},
"applicable": {
"type": "boolean",
"description": "Применился промокод или нет"
}
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessCode": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessData": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/priority/v1/discard-promocode": {
"post": {
"tags": [
"Campaign_management"
],
"summary": "Сброс промокода",
"description": "Позволяет открепить промокод от рекламной кампании",
"operationId": "DiscardPromocodePost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Возращает все цены по всем продуктам.",
"content": {
"application/json": {
"schema": {
"type": "number",
"description": "ID задачи."
}
}
}
}
}
}
},
"/priority/v1/generate-commercial-offer": {
"post": {
"tags": [
"Generate_commercial_offer"
],
"summary": "Создание задачи на генерацию КП",
"description": "Метод доступен по запросу через менеджера. Создает задачу на генерацию нового коммерческого предложения. Ограничения: не более 200 презентаций в день. Не запускайте создание всех КП разом.",
"operationId": "GenerateCommercialOfferPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"companyId": {
"description": "ID организации у которой одна физическая точка. Получаем из /priority/v1/company-search",
"type": "integer",
"format": "int64"
},
"chainID": {
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search.",
"type": "integer",
"format": "int64"
},
"countryGeoID": {
"description": "Географический идентификатор страны.",
"type": "integer",
"format": "int32"
},
"manager": {
"type": "object",
"description": "Данные менеджера, добавляются на последний слайд",
"properties": {
"name": {
"type": "string",
"description": "Имя Фамилия менеджера."
},
"email": {
"type": "string",
"description": "E-mail менеджера."
}
}
},
"branding": {
"type": "boolean",
"description": "Добавляет в презентацию слайд про брендированную метку на Яндекс.Картах (пин с логотипом). Подходит только для крупных сетей."
},
"product": {
"type": "string",
"description": "Выбор создать презентацию на продукт «Реклама на Картах» (geoproduct) или «Рекламная подписка на весь Яндекс» (subscription). Презентации отличаются разным набором слайдов.",
"enum": [
"geoproduct",
"subscription"
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "ID полученной задачи",
"content": {
"application/json": {
"schema": {
"type": "number",
"description": "ID задачи."
}
}
}
}
}
}
},
"/priority/v1/get-commercial-offer-result": {
"get": {
"parameters": [
{
"in": "query",
"name": "taskId",
"description": "ID задачи.",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"Generate_commercial_offer"
],
"summary": "Получение статуса задачи и результата",
"description": "Получает статус выполнения задачи по её ID полученной в /priority/v1/generate-commercial-offer",
"operationId": "GetCommercialOfferGet",
"responses": {
"200": {
"description": "ID полученной задачи.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"taskId": {
"description": "ID задачи.",
"type": "integer"
},
"status": {
"type": "string",
"description": "Статус выполнения задачи.",
"enum": [
"CREATED",
"ERROR",
"IN_PROGRESS",
"READY"
]
},
"result": {
"type": "object",
"description": "Результат выполнения задачи. Может быть null если задача еще не\n выполнена.",
"properties": {
"pdf": {
"type": "string",
"description": "Ссылка на презентацию в формате PDF."
},
"pptx": {
"type": "string",
"description": "Ссылка на презентацию в формате PPTX."
}
}
}
}
}
}
}
}
}
}
},
"/priority/v1/get-balance-client": {
"get": {
"tags": [
"Payment"
],
"summary": "Баланс кошелька (нужен для перевода средств).",
"description": "Позволяет узнать баланс и идентификатор кошелька субклиента. Идентификатор понадобится для перевода средств /priority/v1/billing-transfer.",
"operationId": "GetBalanceClientGet",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Информация о балансе клиента.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на получение бюджета клиента.",
"properties": {
"data": {
"type": "object",
"description": "Информация о бюджете.",
"properties": {
"currency": {
"type": "string",
"description": "Валюта кошелька пользователя",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"walletId": {
"type": "number",
"description": "Идентификатор кошелька."
},
"availableSum": {
"type": "number",
"description": "Доступная сумма на кошельке."
}
}
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"USER_NOT_FOUND",
"RESOURCE_ACCESS_FORBIDDEN"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v1/deposit": {
"post": {
"tags": [
"Payment"
],
"summary": "Депозит",
"description": "Пополняет кошелек указанного субклиента за счет средств с кредитной линии. Обратитесь к менеджеру для заключения такого договора.",
"operationId": "DepositPost",
"requestBody": {
"description": "Информация о депозите.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о депозите.",
"properties": {
"walletId": {
"type": "number",
"description": "ID кошелька из /get-balance-client."
},
"contract": {
"type": "string",
"description": "Кредитный договор, например 1234567/89."
},
"currency": {
"type": "string",
"description": "Валюта кошелька пользователя",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"amount": {
"type": "number",
"description": "Сумма пополнения"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "ID полученной задачи",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"nullable": true
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"USER_NOT_FOUND",
"RESOURCE_ACCESS_FORBIDDEN нет прав на совершение перевода",
"BALANCE_CLIENT_OR_ORDERS_ARE_NOT_FOUND_FOR_USER не нашли балансового клиента или заказ",
"YANDEX_BALANCE_ERROR ошибка в Yandex.Balance, надо обратиться в поддержку",
"CONTRACT_NOT_FOUND не нашли контракт",
"TOO_MANY_CONTRACTS нашли больше чем 1 контракт надо обратиться в поддержку",
"CURRENCY_MISMATCH валюта контракта и балансового клиента различаются",
"NO_PAYMENT_SYSTEM_AVAILABLE нет доступных способов оплаты надо обратиться в поддержку"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка. Что-то сломалось"
}
}
}
},
"/priority/v1/billing-transfer": {
"post": {
"tags": [
"Payment"
],
"summary": "Перевод средств",
"description": "Переводит деньги между кошельками субклиентов. walletId берутся из /priority/v1/get-balance-client",
"operationId": "14BillingTransferPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Запрос на перевод денег между кошельками.",
"properties": {
"srcWallet": {
"description": "walletId с которого переводятся деньги.",
"type": "number"
},
"dstWallet": {
"description": "walletId на который переводятся деньги.",
"type": "number"
},
"sumOld": {
"description": "Текущая сумма на кошельке, с которого нужно переводить.",
"type": "number"
},
"sumNew": {
"description": "Сумма на кошельке, которая должна остаться после перевода",
"type": "number"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "ID полученной задачи",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"nullable": true
}
}
}
}
}
},
"422": {
"description": "Ошибка при работе",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN",
"USER_NOT_FOUND",
"YANDEX_BALANCE_ERROR"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка."
}
}
}
},
"/priority/v1/create-company": {
"post": {
"tags": [
"Company_creation"
],
"summary": "Создание компании",
"description": "Создание компании",
"operationId": "CompanyCreation",
"parameters": [
{
"in": "header",
"name": "Client-Login",
"description": "Логин субклиента, который будет назначен создателем компании. Если не указан, то создателем назначается владелец токена.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Информация о создаваемой компании.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Информация о компании.",
"properties": {
"name": {
"type": "string",
"description": "Название компании"
},
"phone": {
"type": "string",
"description": "Телефон компании"
},
"website": {
"type": "string",
"description": "Вебсайт компании"
},
"coordinates": {
"type": "array",
"description": "Координаты [latitude, longitude]. Необходимо для компаний с типом offline (!)",
"items": {
"type": "number"
}
},
"rubricIds": {
"type": "array",
"description": "список ID рубрик из /rubric-suggestion (Запрос \"Поиск рубик\"), можно указать от 1 до 3 рубрик",
"items": {
"type": "number"
}
},
"type": {
"type": "string",
"description": "Тип компании",
"enum": [
"online",
"offline"
]
},
"regions": {
"type": "array",
"description": "Регионы, которые охватывает компания. Можно получить из /region-suggestion (Запрос \"Поиск регионов\") Необходимо для компаний с типом online (!)",
"items": {
"type": "object",
"description": "ID и наименование региона.",
"properties": {
"id": {
"type": "number",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
}
}
},
"required": [
"name",
"phone",
"rubricIds",
"type"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Возвращает ID созданной компании",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"description": "ID созданной компании"
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка. Что-то сломалось"
}
}
}
},
"/priority/v1/company-creation-status": {
"get": {
"tags": [
"Company_creation"
],
"summary": "Статус создания компании",
"description": "Статус создания компании",
"operationId": "CompanyCreationStatus",
"parameters": [
{
"in": "query",
"name": "companyId",
"description": "ID компании",
"schema": {
"type": "number"
},
"required": true
}
],
"responses": {
"200": {
"description": "Статус созданной компании",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"in_progress",
"creation"
]
}
}
}
}
}
}
}
},
"422": {
"description": "Компания не существует",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ошибка при попытке узнать статус созданной компании.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"COMPANY_NOT_FOUND"
]
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка. Что-то сломалось"
}
}
}
},
"/priority/v1/rubric-suggestion": {
"get": {
"tags": [
"Company_creation"
],
"summary": "Поиск рубрик",
"description": "Получение списка подходящих под запрос рубрик",
"operationId": "RubricSuggestion",
"parameters": [
{
"in": "query",
"name": "text",
"description": "Наименование рубрики",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Список рубрик",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Список рубрик",
"items": {
"type": "object",
"description": "Рубрика",
"properties": {
"id": {
"type": "integer",
"description": "ID рубрики"
},
"name": {
"type": "string",
"description": "Наименование рубрики"
}
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка. Что-то сломалось"
}
}
}
},
"/priority/v1/region-suggestion": {
"get": {
"tags": [
"Company_creation"
],
"summary": "Поиск регионов",
"description": "Получение списка подходящих под запрос регионов",
"operationId": "RegionSuggestion",
"parameters": [
{
"in": "query",
"name": "text",
"description": "Наименование региона",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Список регионов",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Список регионов",
"items": {
"type": "object",
"description": "Регион",
"properties": {
"id": {
"type": "integer",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
}
}
}
}
}
}
},
"500": {
"description": "Непредвиденная ошибка. Что-то сломалось"
}
}
}
}
},
"components": {
"schemas": {
"RubricSuggestionData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Список рубрик",
"items": {
"type": "object",
"description": "Рубрика",
"properties": {
"id": {
"type": "integer",
"description": "ID рубрики"
},
"name": {
"type": "string",
"description": "Наименование рубрики"
}
}
}
}
}
},
"RubricSuggestionDataRubric": {
"type": "object",
"description": "Рубрика",
"properties": {
"id": {
"type": "integer",
"description": "ID рубрики"
},
"name": {
"type": "string",
"description": "Наименование рубрики"
}
}
},
"RegionSuggestionData": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Список регионов",
"items": {
"type": "object",
"description": "Регион",
"properties": {
"id": {
"type": "integer",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
}
}
}
},
"RegionSuggestionDataRegion": {
"type": "object",
"description": "Регион",
"properties": {
"id": {
"type": "integer",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
},
"GetCampaign": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании"
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID организации с одной точкой или один филиал сети"
},
"isChain": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"name": {
"type": "string",
"description": "Название организации"
}
}
},
"campainPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
}
}
}
}
},
"GetCampaignData": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании"
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID организации с одной точкой или один филиал сети"
},
"isChain": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"name": {
"type": "string",
"description": "Название организации"
}
}
},
"campainPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
},
"GetCampaignDataCompany": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID организации с одной точкой или один филиал сети"
},
"isChain": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"name": {
"type": "string",
"description": "Название организации"
}
}
},
"GetCampaignDataCampainPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статутс рекламной кампании"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
},
"GetCampaignError": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
}
}
},
"GetCampaignV4": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
},
"GetCampaignV4Data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
},
"GetCampaignV4DataCompany": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"GetCampaignV4DataCountry": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"GetCampaignV4DataUser": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
},
"GetCampaignV4DataAgency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"GetCampaignV4DataCampaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"GetCampaignV5": {
"type": "object",
"description": "Информация о рекламной кампании",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
},
"isBeneficiaryValid": {
"type": "boolean",
"description": "Статус корректности заполнения данных о рекламодателе"
},
"siteType": {
"type": "string",
"description": "Тип рекламируемого сайта",
"enum": [
"NONE // Возвращается для рекламной кампании без сайта",
"NORMAL // Обычный сайт",
"LANDING // Сайт от Яндекс Бизнеса",
"TELEGRAM // Telegram канал",
"OUTSIDER // Данный тип сайта не поддержан в API"
]
}
}
}
}
},
"GetCampaignV5Data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"campaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
},
"isBeneficiaryValid": {
"type": "boolean",
"description": "Статус корректности заполнения данных о рекламодателе"
},
"siteType": {
"type": "string",
"description": "Тип рекламируемого сайта",
"enum": [
"NONE // Возвращается для рекламной кампании без сайта",
"NORMAL // Обычный сайт",
"LANDING // Сайт от Яндекс Бизнеса",
"TELEGRAM // Telegram канал",
"OUTSIDER // Данный тип сайта не поддержан в API"
]
}
}
},
"GetCampaignV5DataCompany": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"GetCampaignV5DataCountry": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"GetCampaignV5DataUser": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
},
"GetCampaignV5DataAgency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"GetCampaignV5DataCampaignPromo": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода"
},
"applicable": {
"type": "boolean",
"description": "Статус промокода"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Текст ошибки"
}
}
},
"DicardPromocode": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
}
}
},
"ApplyPromocodeRequest": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода."
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
}
}
},
"ApplyPromocodeAnswer": {
"type": "object",
"description": "Информация о рекламных кампаниях.",
"properties": {
"data": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода."
},
"applicable": {
"type": "boolean",
"description": "Применился промокод или нет"
}
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessCode": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessData": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
}
}
},
"ApplyPromocodeAnswerData": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код промокода."
},
"applicable": {
"type": "boolean",
"description": "Применился промокод или нет"
}
}
},
"ApplyPromocodeAnswerError": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки"
},
"message": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessCode": {
"type": "string",
"description": "Сообщение ошибки"
},
"businessData": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
}
}
},
"ApplyPromocodeAnswerErrorBusinessData": {
"type": "object",
"properties": {
"promocode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonCode": {
"type": "string",
"description": "Код ошибки"
},
"nonApplicableReasonText": {
"type": "string",
"description": "Код ошибки"
}
}
},
"GetLaunchCampaignError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN // нет прав на запуск кампания",
"NOT_ENOUGH_MONEY // недостаточно средств на кошельке",
"PRIORITY_NOT_ALLOWED // для некоторых организаций в составе кампании недоступно размещение на картах",
"BRANDING_WITHOUT_PRIORITY // для некоторых организаций в составе РК недоступно размещение на картах",
"NO_PRODUCTS_AVAILABLE // для некоторых организаций в составе кампании недоступны рекламные продукты",
"CAMPAIGN_HAS_NO_BALANCE_ORDER // не создался заказ в балансе, обратитесь в нашу поддержку",
"CAMPAIGN_PROLONGATION_DISABLED // для данной кампании недоступно продление",
"UNSUPPORTED_COUNTRY // Кампания создана на страну, в которой недоступны рекламные продукты",
"UNSUPPORTED_CAMPAIGN_TYPE // Тип рекламной кампании не поддерживается",
"BENEFICIARY_IS_NOT_VALID // Нельзя запусить РК из-за того, что данные о рекламодателе не заполнены или невалидны"
]
}
}
},
"CampaignBeneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
},
"CampaignBeneficiaryContractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"CampaignBeneficiaryClient": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"CampaignBeneficiaryContract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
},
"CampaignExtendedBeneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
},
"CampaignBeneficiaryRequest": {
"type": "object",
"description": "Запрос",
"properties": {
"campaignId": {
"type": "number",
"description": "ID кампании"
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
},
"CampaignExtendedBeneficiaryRequest": {
"type": "object",
"description": "Запрос",
"properties": {
"campaignId": {
"type": "number",
"description": "ID кампании"
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
},
"required": [
"campaignId",
"beneficiary"
]
},
"CampaignExtendedBeneficiaryResponse": {
"type": "object",
"description": "Ответ",
"properties": {
"data": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
},
"CampaignExtendedBeneficiaryError": {
"type": "object",
"description": "Ошибка при установке рекламодателя.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"BENEFICIARY_IS_NOT_VALID // Ошибка валидации данных о рекламодателе"
]
},
"businessData": {
"type": "string",
"description": "Данные валидации"
}
}
},
"CampaignBeneficiaryResponse": {
"type": "object",
"description": "Ответ",
"properties": {
"data": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
},
"CampaignBeneficiaryError": {
"type": "object",
"description": "Ошибка при установке рекламодателя.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
}
}
},
"IsOwnerError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"COUNTRY_NOT_FOUND не валидный countryGeoId",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT указанный логин не субклиент агенства"
]
}
}
},
"CreateCampainError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства",
"USER_NOT_FOUND не смогли найти пользователя из хедера",
"AGENCY_COULD_NOT_BE_OWNER_IN_CAMPAIGN пытаемся создать кампанию на логин, который является агентством",
"BALANCE_CLIENT_NOT_EXIST неизвестное агентство",
"BALANCE_CLIENT_IS_NOT_AGENCY_SUB_CLIENT пользователь не субклиент агенства",
"NO_PRODUCTS_AVAILABLE нет доступных продуктов"
]
}
}
},
"LaunchCampaignV2": {
"type": "object",
"description": "Запрос на запуск рекламной кампании.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании."
},
"product": {
"type": "string",
"description": "Тип продукта.",
"enum": [
"subscriptionf",
"websubscription",
"geoproduct"
]
},
"budgetType": {
"type": "string",
"description": "Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct",
"enum": [
"OPTIMAL",
"MAXIMAL",
"MINIMAL",
"WEB_OPTIMAL",
"WEB_MAXIMAL",
"WEB_MINIMAL",
"CUSTOM",
"DEFAULT"
]
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании."
}
}
},
"LaunchCampaignV3": {
"type": "object",
"description": "Запрос на запуск рекламной кампании.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании."
},
"budgetType": {
"type": "string",
"description": "Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct",
"enum": [
"OPTIMAL",
"MAXIMAL",
"MINIMAL",
"WEB_OPTIMAL",
"WEB_MAXIMAL",
"WEB_MINIMAL",
"CUSTOM",
"DEFAULT"
]
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании."
}
}
},
"LaunchCampaignV4": {
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"monthAmount": {
"type": "number",
"description": "Сумма месячного бюджета рекламной кампании. Должна быть не меньше значения в MINIMAL бюджете за 30 дней\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании",
"enum": [
90,
180,
360
]
}
}
},
"LaunchDefaultCampaignV5": {
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"monthAmount": {
"type": "number",
"description": "Сумма месячного бюджета рекламной кампании. Должна быть не меньше значения в MINIMAL бюджете за 30 дней. Обязателен при launchType=DEFAULT, иначе игнорируется\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании для launchType=DEFAULT",
"enum": [
90,
180,
360
]
}
},
"required": [
"campaignId",
"duration"
]
},
"LaunchShortPeriodCampaignV5": {
"type": "object",
"description": "Запрос на запуск рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании. Опционально, если не передавать будет DEFAULT",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"campaignId": {
"type": "number",
"description": "ID рекламной кампании"
},
"totalAmount": {
"type": "number",
"description": "Сумма всего бюджета рекламной кампании. Должна быть в пределах minAmount и maxAmount включительно. Обязателен при launchType=SHORT_PERIOD, иначе игнорируется\n"
},
"duration": {
"type": "number",
"description": "Продолжительность рекламной кампании для launchType=SHORT_PERIOD, должна быть в пределах minDuration и maxDuration включительно"
}
},
"required": [
"campaignId",
"duration"
]
},
"BudgetType": {
"type": "string",
"description": "Суммы бюджетов на один месяц доступные к выбору от меньшего к большему: минимальный, оптимальный, максимальный. Бюджеты c префиксом web для веб подписки. CUSTOM передается если пользователь хочет свой бюджет между минимальным и максимальным. DEFAULT нужно передавать при запуске рекламы на картах geoproduct",
"enum": [
"OPTIMAL",
"MAXIMAL",
"MINIMAL",
"WEB_OPTIMAL",
"WEB_MAXIMAL",
"WEB_MINIMAL",
"CUSTOM",
"DEFAULT"
]
},
"ProductEnum": {
"type": "string",
"description": "Тип продукта.",
"enum": [
"subscriptionf",
"websubscription",
"geoproduct"
]
},
"CalculateBudgetRequest": {
"type": "object",
"description": "Запрос на рассчет бюджета.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании. Получаем после /priority/v1/create-campaign. Применяется когда нужно посмотреть стоимость с учетом привязанного промокода"
},
"companyId": {
"type": "number",
"description": "ID организации у которой одна физическая точка. Получаем из /priority/v1/company-search"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search."
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"branding": {
"type": "boolean",
"description": "Передаем если необходимо рассчитать цену с брендированным пином на Яндекс.Картах (только для рекламы на Картах, geoproduct)"
}
}
},
"CalculateCampaignBudgetRequest": {
"type": "object",
"description": "Запрос на рассчет бюджета.",
"properties": {
"campaignId": {
"type": "number",
"description": "ID рекламной кампании. Получаем после /priority/v1/create-campaign. Применяется когда нужно посмотреть стоимость с учетом привязанного промокода"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search."
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"branding": {
"type": "boolean",
"description": "Передаем если необходимо рассчитать цену с брендированным пином на Яндекс.Картах (только для рекламы на Картах, geoproduct)"
}
}
},
"GetBalanceClient": {
"type": "object",
"description": "Запрос на получение бюджета клиента.",
"properties": {
"data": {
"type": "object",
"description": "Информация о бюджете.",
"properties": {
"currency": {
"type": "string",
"description": "Валюта кошелька пользователя",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"walletId": {
"type": "number",
"description": "Идентификатор кошелька."
},
"availableSum": {
"type": "number",
"description": "Доступная сумма на кошельке."
}
}
}
}
},
"GetBalanceClientData": {
"type": "object",
"description": "Информация о бюджете.",
"properties": {
"currency": {
"type": "string",
"description": "Валюта кошелька пользователя",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"walletId": {
"type": "number",
"description": "Идентификатор кошелька."
},
"availableSum": {
"type": "number",
"description": "Доступная сумма на кошельке."
}
}
},
"GetBalanceClientError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"USER_NOT_FOUND",
"RESOURCE_ACCESS_FORBIDDEN"
]
}
}
},
"Deposit": {
"type": "object",
"description": "Информация о депозите.",
"properties": {
"walletId": {
"type": "number",
"description": "ID кошелька из /get-balance-client."
},
"contract": {
"type": "string",
"description": "Кредитный договор, например 1234567/89."
},
"currency": {
"type": "string",
"description": "Валюта кошелька пользователя",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"amount": {
"type": "number",
"description": "Сумма пополнения"
}
}
},
"DepositError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"USER_NOT_FOUND",
"RESOURCE_ACCESS_FORBIDDEN нет прав на совершение перевода",
"BALANCE_CLIENT_OR_ORDERS_ARE_NOT_FOUND_FOR_USER не нашли балансового клиента или заказ",
"YANDEX_BALANCE_ERROR ошибка в Yandex.Balance, надо обратиться в поддержку",
"CONTRACT_NOT_FOUND не нашли контракт",
"TOO_MANY_CONTRACTS нашли больше чем 1 контракт надо обратиться в поддержку",
"CURRENCY_MISMATCH валюта контракта и балансового клиента различаются",
"NO_PAYMENT_SYSTEM_AVAILABLE нет доступных способов оплаты надо обратиться в поддержку"
]
}
}
},
"BillingTransfer": {
"type": "object",
"description": "Запрос на перевод денег между кошельками.",
"properties": {
"srcWallet": {
"description": "walletId с которого переводятся деньги.",
"type": "number"
},
"dstWallet": {
"description": "walletId на который переводятся деньги.",
"type": "number"
},
"sumOld": {
"description": "Текущая сумма на кошельке, с которого нужно переводить.",
"type": "number"
},
"sumNew": {
"description": "Сумма на кошельке, которая должна остаться после перевода",
"type": "number"
}
}
},
"BillingTransferError": {
"type": "object",
"description": "Ошибка при работе с клиентом.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"RESOURCE_ACCESS_FORBIDDEN",
"USER_NOT_FOUND",
"YANDEX_BALANCE_ERROR"
]
}
}
},
"CompanySearch": {
"type": "object",
"description": "Поиск организации.",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Количество элементов в ответе."
},
"limit": {
"type": "number",
"description": "Ограничение на количество элементов в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"companies": {
"type": "object",
"description": "Результат поиска для организации с одной физической точкой.",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации"
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации"
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"country": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
},
"companieschain": {
"type": "object",
"description": "Результат поиска для организации входящая в сеть (несколько физических точек).",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации."
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации."
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"chainCountries": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
}
}
},
"CompanySearchPager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Количество элементов в ответе."
},
"limit": {
"type": "number",
"description": "Ограничение на количество элементов в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"Company": {
"type": "object",
"description": "Результат поиска для организации с одной физической точкой.",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации"
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации"
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"country": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
},
"CompanyChain": {
"type": "object",
"description": "Результат поиска для организации входящая в сеть (несколько физических точек).",
"properties": {
"id": {
"type": "number",
"description": "ID организации, он же companyId."
},
"name": {
"type": "string",
"description": "Название организации."
},
"rubrics": {
"type": "number",
"description": "Вид деятельности выбранные у организации."
},
"address": {
"type": "number",
"description": "Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1."
},
"url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"isChain": {
"type": "number",
"description": "Является ли организация сетью (сетевые организации или франшизы)."
},
"isOnline": {
"type": "number",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"chainCountries": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
}
}
},
"Country": {
"type": "object",
"description": "",
"properties": {
"name": {
"type": "string",
"description": "Страна, в которой работает организация"
},
"geoId": {
"type": "number",
"description": "Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании"
},
"isAdvertisingDisabled": {
"type": "boolean",
"description": "Если true то создание рекламы в данной стране невозможно"
}
}
},
"Url": {
"type": "array",
"description": "Все адреса (url) указанные как контактные",
"items": {
"type": "string"
}
},
"PriceAnswer": {
"type": "object",
"description": "Представление организации.",
"properties": {
"id": {
"type": "number",
"description": "Идентификатор организации."
},
"name": {
"type": "string",
"description": "Название организации."
},
"rubrics": {
"type": "number",
"description": "Применимые рубрики."
},
"address": {
"type": "number",
"description": "Адрес организации."
},
"isChain": {
"type": "number",
"description": "Является ли точка сетью компаний."
},
"isOnline": {
"type": "number",
"description": "Работает ли организация онлайн."
},
"chainId": {
"type": "number",
"description": "Идентификатор сети компаний. Передается если нужно сгенерировать КП для всей сети (сеть это организация с несколькими точкам, филиалами)."
},
"chainCountries": {
"type": "number",
"description": "Страны, в которых работает сеть компаний."
},
"country": {
"type": "number",
"description": "Страна, в которой работает компания."
}
}
},
"CreateCampaign": {
"type": "object",
"description": "Запрос на создание кампании.",
"properties": {
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Сайт организации нужен для создания веб кампании."
}
}
},
"CreateCampaignV3": {
"type": "object",
"description": "Запрос на создание кампании.",
"properties": {
"name": {
"type": "string",
"description": "Имя рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
},
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Сайт организации нужен для создания веб кампании."
}
}
},
"CreateCampaignV4": {
"type": "object",
"description": "Запрос на создание кампании",
"properties": {
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)\n"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны. Обязательный при указании chainId"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт. Не учитывается при указании chainId или mapsOnly"
},
"mapsOnly": {
"type": "boolean",
"description": "Создание кампании с рекламой только на Яндекс Картах"
}
}
},
"CreateCampaignV5": {
"type": "object",
"description": "Запрос на создание кампании",
"properties": {
"companyId": {
"type": "number",
"description": "Идентификатор организации, у которой только одна физическая точка"
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)\n"
},
"countryGeoId": {
"type": "number",
"description": "Географический идентификатор страны."
},
"url": {
"type": "string",
"description": "Рекламируемый сайт. Не учитывается при указании chainId или mapsOnly. Если передаётся ссылка на телеграм-канал, то создается телеграмная рекламная кампания, подробнее https://business.yandex.ru/subscription/telegram_advertising\n"
},
"mapsOnly": {
"type": "boolean",
"description": "Создание кампании с рекламой только на Яндекс Картах"
}
},
"required": [
"countryGeoId"
]
},
"GetCampaigns": {
"type": "object",
"description": "Запрос на получение кампаний.",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний."
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"campaigns": {
"type": "object",
"description": "Информация о рекламных кампаниях.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании."
},
"name": {
"type": "string",
"description": "Название рекламной кампании."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"isChainCampaign": {
"type": "boolean",
"description": "Входит ли организация в сеть."
},
"companyDescription": {
"type": "object",
"properties": {
"companyId": {
"type": "number",
"description": "ID компании, у которой только одна точка или конкретной точки сети."
},
"name": {
"type": "string",
"description": "Название организации."
},
"online": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания."
},
"status": {
"type": "string",
"description": "Текущий статус рекламной кампании.",
"enum": [
"DELAYED_START",
"FINISHED",
"PAUSED",
"RUNNING",
"STOPPED",
"WAITING"
]
},
"users": {
"type": "object",
"description": "Пользователи, имеющие доступ к рекламной кампании.",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя."
},
"login": {
"description": "Логин пользователя.",
"type": "string"
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства."
},
"name": {
"type": "number",
"description": "Название рекламного агентства."
}
}
},
"country": {
"type": "object",
"description": "Страна для которой используется рекламная кампания.",
"properties": {
"geoID": {
"type": "number",
"description": "Географический идентификатор страны."
}
}
},
"remainingDays": {
"type": "number",
"description": "Количество дней оставшихся в рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
}
}
}
}
},
"GetCampaignsPager": {
"type": "object",
"description": "Пагинация ответа.",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний."
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе."
},
"offset": {
"type": "number",
"description": "Оффсет ответа."
}
}
},
"Campaign": {
"type": "object",
"description": "Информация о рекламных кампаниях.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании."
},
"name": {
"type": "string",
"description": "Название рекламной кампании."
},
"chainId": {
"type": "number",
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы)"
},
"isChainCampaign": {
"type": "boolean",
"description": "Входит ли организация в сеть."
},
"companyDescription": {
"type": "object",
"properties": {
"companyId": {
"type": "number",
"description": "ID компании, у которой только одна точка или конкретной точки сети."
},
"name": {
"type": "string",
"description": "Название организации."
},
"online": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания."
},
"status": {
"type": "string",
"description": "Текущий статус рекламной кампании.",
"enum": [
"DELAYED_START",
"FINISHED",
"PAUSED",
"RUNNING",
"STOPPED",
"WAITING"
]
},
"users": {
"type": "object",
"description": "Пользователи, имеющие доступ к рекламной кампании.",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя."
},
"login": {
"description": "Логин пользователя.",
"type": "string"
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства."
},
"name": {
"type": "number",
"description": "Название рекламного агентства."
}
}
},
"country": {
"type": "object",
"description": "Страна для которой используется рекламная кампания.",
"properties": {
"geoID": {
"type": "number",
"description": "Географический идентификатор страны."
}
}
},
"remainingDays": {
"type": "number",
"description": "Количество дней оставшихся в рекламной кампании."
},
"type": {
"type": "string",
"description": "Тип рекламной кампании.",
"enum": [
"WEB",
"SUBSCRIPTION",
"GEO"
]
}
}
},
"CampaignCompanyDescription": {
"type": "object",
"properties": {
"companyId": {
"type": "number",
"description": "ID компании, у которой только одна точка или конкретной точки сети."
},
"name": {
"type": "string",
"description": "Название организации."
},
"online": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"CampaignUsers": {
"type": "object",
"description": "Пользователи, имеющие доступ к рекламной кампании.",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя."
},
"login": {
"description": "Логин пользователя.",
"type": "string"
}
}
},
"CampaignAgency": {
"type": "object",
"description": "Информация о рекламном агентстве.",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства."
},
"name": {
"type": "number",
"description": "Название рекламного агентства."
}
}
},
"CampaignCountry": {
"type": "object",
"description": "Страна для которой используется рекламная кампания.",
"properties": {
"geoID": {
"type": "number",
"description": "Географический идентификатор страны."
}
}
},
"GetCampaignsV4": {
"type": "object",
"description": "Список рекламных кампаний",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"campaigns": {
"type": "array",
"description": "Информация о рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
}
}
}
},
"GetCampaignsV4Pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"GetCampaignsV6": {
"type": "object",
"description": "Список рекламных кампаний",
"properties": {
"pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"campaigns": {
"type": "array",
"description": "Информация о рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
}
}
}
},
"GetCampaignsV6Pager": {
"type": "object",
"description": "Пагинация ответа",
"properties": {
"total": {
"type": "number",
"description": "Общее количество кампаний"
},
"limit": {
"type": "number",
"description": "Ограничение на количество кампаний в ответе"
},
"offset": {
"type": "number",
"description": "Оффсет ответа"
}
}
},
"CampaignV4": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"type": {
"type": "string",
"description": "Тип рекламодателя.\n Возможные значения:\n - FOREIGN_LEGAL - Иностранное юридическое лицо\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - INDIVIDUAL - ИП\n - LEGAL - Юридическое лицо\n - PHYSICAL - Физическое лицо",
"enum": [
"FOREIGN_LEGAL",
"FOREIGN_PHYSICAL",
"INDIVIDUAL",
"LEGAL",
"PHYSICAL"
]
},
"phone": {
"type": "string",
"description": "Номер телефона рекламодателя.\n Обязательное поле для типов рекламодателей:\n - FOREIGN_PHYSICAL - Иностранное физическое лицо\n - PHYSICAL - Физическое лицо"
},
"email": {
"type": "string",
"description": "Email рекламодателя"
},
"inn": {
"type": "string",
"description": "ИНН рекламодателя.\n Обязателен для типов рекламодателей:\n - LEGAL - Юридическое лицо (12 символов)\n - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов)\n - INDIVIDUAL - ИП (12 символов)"
}
}
}
}
},
"CampaignV4Company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"CampaignV4Country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"CampaignV4User": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
},
"CampaignV4Agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"CampaignV6": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID рекламной кампании"
},
"status": {
"type": "string",
"description": "Статус рекламной кампании",
"enum": [
"STOPPED",
"WAITING",
"PAUSED",
"RUNNING",
"FINISHED",
"DELAYED_START"
]
},
"remainingDays": {
"type": "number",
"description": "Количество оставщихся дней"
},
"url": {
"type": "string",
"description": "Рекламируемый сайт"
},
"mapsOnly": {
"type": "boolean",
"description": "Кампания рекламируется только на Яндекс Картах"
},
"name": {
"type": "string",
"description": "Название рекламной кампании"
},
"paused": {
"type": "boolean",
"description": "Остановлена ли рекламная кампания"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"users": {
"type": "array",
"description": "Пользователи, имеющие доступ к рекламной кампании",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
}
},
"agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"beneficiary": {
"type": "object",
"description": "Данные о рекламодателе.",
"properties": {
"client": {
"type": "object",
"description": "Данные конечного рекламодателя",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contractor": {
"type": "object",
"description": "Данные посредника",
"properties": {
"type": {
"type": "string",
"description": "тип клиента",
"enum": [
"FOREIGN_LEGAL иностранное юридическое лицо",
"FOREIGN_PHYSICAL иностранное физическое лицо",
"INDIVIDUAL ИП",
"LEGAL юридическое лицо",
"PHYSICAL физическое лицо"
]
},
"inn": {
"type": "string",
"description": "ИНН.\n Обязателен для рекламодателей типа:\n - PHYSICAL\n - INDIVIDUAL\n - LEGAL"
},
"name": {
"type": "string",
"description": "ФИО или наименование клиента"
},
"kpp": {
"type": "string",
"description": "КПП.\n Указывается для рекламодателей типа:\n - LEGAL"
},
"epayNumber": {
"type": "string",
"description": "Номер электронного средства платежа.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL"
},
"oksmNumber": {
"type": "string",
"description": "Код страны регистрации лица в соответствии с ОКСМ.\n Обязателен для рекламодателей типа:\n - FOREIGN_PHYSICAL\n - FOREIGN_LEGAL"
},
"vat": {
"type": "string",
"description": "Номер налогоплательщика либо его аналог в стране регистрации.\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет regNumber)"
},
"regNumber": {
"type": "string",
"description": "Регистрационный номер либо его аналог\n Обязателен для рекламодателей типа:\n - FOREIGN_LEGAL (обязателен, если нет vat)"
}
},
"required": [
"type",
"name"
]
},
"contract": {
"type": "object",
"description": "Договор между клиентом и посредником",
"properties": {
"type": {
"type": "string",
"description": "Тип договора",
"enum": [
"contract договор оказания услуг",
"intermediary-contract посреднический договор"
]
},
"isChargePaidByAgent": {
"type": "boolean",
"description": "Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора.\n Указывается для договоров с типом:\n - intermediary-contract"
},
"actionType": {
"type": "string",
"description": "Роль посредника-представителя.\n Обязателен для договоров с типом:\n - intermediary-contract",
"enum": [
"distribution действия в целях распространения рекламы",
"conclude заключение договоров",
"commercial коммерческое представительство",
"other иное"
]
},
"subjectType": {
"type": "string",
"description": "Предмет договора",
"enum": [
"org-distribution договор на организацию распространения рекламы",
"mediation посредничество",
"distribution договор на распространение рекламы",
"representation представительство",
"other иное"
]
},
"number": {
"type": "string",
"description": "Номер договора"
},
"date": {
"type": "string",
"description": "Дата заключения договора в формате YYYY-MM-DD"
},
"amount": {
"type": "number",
"description": "Сумма"
},
"isVat": {
"type": "boolean",
"description": "Включён ли НДС в сумму.\n Обязателен если есть amount."
}
},
"required": [
"type",
"subjectType",
"date"
]
}
},
"required": [
"client"
]
}
}
},
"CampaignV6Company": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID компании (у которой только одна точка) или сети"
},
"name": {
"type": "string",
"description": "Название организации"
},
"isChain": {
"type": "boolean",
"description": "Является ли организация сетевой"
},
"isOnline": {
"type": "boolean",
"description": "Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)"
}
}
},
"CampaignV6Country": {
"type": "object",
"description": "Страна, для которой используется рекламная кампания",
"properties": {
"geoId": {
"type": "number",
"description": "Географический идентификатор страны"
},
"name": {
"type": "string",
"description": "Название страны"
}
}
},
"CampaignV6User": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID пользователя"
},
"login": {
"type": "string",
"description": "Логин пользователя"
}
}
},
"CampaignV6Agency": {
"type": "object",
"description": "Информация о рекламном агентстве",
"properties": {
"id": {
"type": "number",
"description": "ID рекламного агентства"
},
"name": {
"type": "number",
"description": "Название рекламного агентства"
}
}
},
"CampaignPrice": {
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"fixedUntil": {
"type": "string",
"description": "Дата, до которой цена зафиксирована"
},
"price": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
}
}
},
"CampaignPricePrice": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
},
"CampaignPriceDefault": {
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"fixedUntil": {
"type": "string",
"description": "Дата, до которой цена зафиксирована. Доступна для launchType=DEFAULT"
},
"price": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
}
}
},
"CampaignPriceShortPeriod": {
"type": "object",
"description": "Цены для рекламной кампании",
"properties": {
"launchType": {
"type": "string",
"description": "Тип запуска рекламной кампании",
"enum": [
"DEFAULT // Запуска по умолчанию с конкретными бюджетами",
"SHORT_PERIOD // Запуск на короткий срок с гибкими бюджетом и длительностью. Сейчас доступен только для телеграм-каналов"
]
},
"currency": {
"type": "string",
"description": "Валюта",
"enum": [
"rub",
"kzt",
"byn",
"uah"
]
},
"price": {
"type": "object",
"description": "Информация о ценах для SHORT_PERIOD",
"properties": {
"minDuration": {
"type": "number",
"description": "Минимальная длительность рекламной кампании в днях"
},
"maxDuration": {
"type": "number",
"description": "Максимальная длительность рекламной кампании в днях"
},
"durationStep": {
"type": "number",
"description": "Шаг выбора длительности в днях"
},
"minAmount": {
"type": "number",
"description": "Минимальный бюджет для запуска в валюте из currency"
},
"maxAmount": {
"type": "number",
"description": "Максимальный бюджет для запуска в валюте из currency"
},
"amountStep": {
"type": "number",
"description": "Шаг выбора бюджета в валюте из currency"
},
"promo": {
"type": "object",
"description": "Информация о промокоде, если он применён и активен",
"properties": {
"discount": {
"type": "number",
"description": "Скидка в деньгах"
},
"bonus": {
"type": "number",
"description": "Бонус к бюджету в деньгах"
},
"minTotalAmount": {
"type": "number",
"description": "Минимальный бюджет, с которого начинает действовать промокод"
},
"minMonthAmount": {
"type": "number",
"description": "Минимальный месячный бюджет, с которого начинает действовать промокод"
},
"minDuration": {
"type": "number",
"description": "Минимальная длительность запуска, с которой начинает действовать промокод"
},
"percentDiscount": {
"type": "number",
"description": "Скидка в процентах"
},
"percentBonus": {
"type": "number",
"description": "Бонус к бюджету в процентах"
},
"percentBonusLimit": {
"type": "number",
"description": "Максимальная сумма процентного бонуса в деньгах"
}
}
}
}
}
}
},
"PriceDefault": {
"type": "object",
"description": "Бюджеты. Для рекламных кампаний с mapsOnly будет возвращаться только MINIMAL бюджет",
"properties": {
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
}
},
"required": [
"MINIMAL"
]
},
"PriceShortPeriod": {
"type": "object",
"description": "Информация о ценах для SHORT_PERIOD",
"properties": {
"minDuration": {
"type": "number",
"description": "Минимальная длительность рекламной кампании в днях"
},
"maxDuration": {
"type": "number",
"description": "Максимальная длительность рекламной кампании в днях"
},
"durationStep": {
"type": "number",
"description": "Шаг выбора длительности в днях"
},
"minAmount": {
"type": "number",
"description": "Минимальный бюджет для запуска в валюте из currency"
},
"maxAmount": {
"type": "number",
"description": "Максимальный бюджет для запуска в валюте из currency"
},
"amountStep": {
"type": "number",
"description": "Шаг выбора бюджета в валюте из currency"
},
"promo": {
"type": "object",
"description": "Информация о промокоде, если он применён и активен",
"properties": {
"discount": {
"type": "number",
"description": "Скидка в деньгах"
},
"bonus": {
"type": "number",
"description": "Бонус к бюджету в деньгах"
},
"minTotalAmount": {
"type": "number",
"description": "Минимальный бюджет, с которого начинает действовать промокод"
},
"minMonthAmount": {
"type": "number",
"description": "Минимальный месячный бюджет, с которого начинает действовать промокод"
},
"minDuration": {
"type": "number",
"description": "Минимальная длительность запуска, с которой начинает действовать промокод"
},
"percentDiscount": {
"type": "number",
"description": "Скидка в процентах"
},
"percentBonus": {
"type": "number",
"description": "Бонус к бюджету в процентах"
},
"percentBonusLimit": {
"type": "number",
"description": "Максимальная сумма процентного бонуса в деньгах"
}
}
}
}
},
"PriceShortPeriodPromo": {
"type": "object",
"description": "Информация о промокоде, если он применён и активен",
"properties": {
"discount": {
"type": "number",
"description": "Скидка в деньгах"
},
"bonus": {
"type": "number",
"description": "Бонус к бюджету в деньгах"
},
"minTotalAmount": {
"type": "number",
"description": "Минимальный бюджет, с которого начинает действовать промокод"
},
"minMonthAmount": {
"type": "number",
"description": "Минимальный месячный бюджет, с которого начинает действовать промокод"
},
"minDuration": {
"type": "number",
"description": "Минимальная длительность запуска, с которой начинает действовать промокод"
},
"percentDiscount": {
"type": "number",
"description": "Скидка в процентах"
},
"percentBonus": {
"type": "number",
"description": "Бонус к бюджету в процентах"
},
"percentBonusLimit": {
"type": "number",
"description": "Максимальная сумма процентного бонуса в деньгах"
}
}
},
"PriceCompanyAnswer": {
"type": "object",
"description": "Цены на рекламные продукты для этой организации или кампании",
"properties": {
"data": {
"type": "object",
"description": "Все доступные бюджеты",
"properties": {
"allowGeoproduct": {
"type": "boolean",
"description": "Возможен ли заказ «Рекламной подписки» для организации"
},
"allowSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Приоритетное размещение на Яндекс.Картах»"
},
"allowWebSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Веб подписки»"
},
"currency": {
"type": "string",
"description": "Валюта рекламной кампании."
},
"geoproduct": {
"type": "object",
"description": "Цены для «Приоритетное размещение на Картах»",
"properties": {
"DEFAULT": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"subscription": {
"type": "object",
"description": "Цены для «Рекламной подписки на Яндекс»",
"properties": {
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"websubscription": {
"type": "object",
"description": "Цены для «Рекламной веб подписки»",
"properties": {
"WEB_OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
}
}
},
"fixedUntil": {
"type": "string",
"description": "Дата до которой цена зафиксирована"
}
}
},
"AllBudget": {
"type": "object",
"description": "Все доступные бюджеты",
"properties": {
"allowGeoproduct": {
"type": "boolean",
"description": "Возможен ли заказ «Рекламной подписки» для организации"
},
"allowSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Приоритетное размещение на Яндекс.Картах»"
},
"allowWebSubscription": {
"type": "boolean",
"description": "Возможен ли заказ «Веб подписки»"
},
"currency": {
"type": "string",
"description": "Валюта рекламной кампании."
},
"geoproduct": {
"type": "object",
"description": "Цены для «Приоритетное размещение на Картах»",
"properties": {
"DEFAULT": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"subscription": {
"type": "object",
"description": "Цены для «Рекламной подписки на Яндекс»",
"properties": {
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"websubscription": {
"type": "object",
"description": "Цены для «Рекламной веб подписки»",
"properties": {
"WEB_OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
}
}
},
"GeoproductPrice": {
"type": "object",
"description": "Цены для «Приоритетное размещение на Картах»",
"properties": {
"DEFAULT": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"SubscriptionPrice": {
"type": "object",
"description": "Цены для «Рекламной подписки на Яндекс»",
"properties": {
"OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"WebSubscriptionPrice": {
"type": "object",
"description": "Цены для «Рекламной веб подписки»",
"properties": {
"WEB_OPTIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MAXIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"WEB_MINIMAL": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
}
}
},
"DurationWith30": {
"type": "object",
"description": "",
"properties": {
"30": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех, кто перейдет в карточку организации на Картах)"
}
}
},
"Duration": {
"type": "object",
"description": "",
"properties": {
"90": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"180": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"360": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"monthPrediction": {
"type": "number",
"description": "Прогноз потенциальных клиентов (тех кто перейдет в карточку организации на Картах)"
}
}
},
"DurationPrice": {
"type": "object",
"description": "",
"properties": {
"amount": {
"type": "number",
"description": "Цена за период с примененным промокодом"
},
"durationPercentDiscount": {
"type": "number",
"description": "Скидка за длительность в процентах"
},
"amountWithoutPromoDiscount": {
"type": "number",
"description": "Стоимость без учета промокода"
},
"promoDiscount": {
"type": "number",
"description": "Скидка в деньгах по промокоду"
},
"promoPlusDays": {
"type": "number",
"description": "Количество дополнительных дней рекламы по промокоду"
},
"promoBonus": {
"type": "number",
"description": "Дополнительный бюджет в деньгах по промокоду"
}
}
},
"CommercialProposalTaskId": {
"type": "number",
"description": "ID задачи."
},
"CommercialProposalResponse": {
"type": "object",
"properties": {
"taskId": {
"description": "ID задачи.",
"type": "integer"
},
"status": {
"type": "string",
"description": "Статус выполнения задачи.",
"enum": [
"CREATED",
"ERROR",
"IN_PROGRESS",
"READY"
]
},
"result": {
"type": "object",
"description": "Результат выполнения задачи. Может быть null если задача еще не\n выполнена.",
"properties": {
"pdf": {
"type": "string",
"description": "Ссылка на презентацию в формате PDF."
},
"pptx": {
"type": "string",
"description": "Ссылка на презентацию в формате PPTX."
}
}
}
}
},
"CommercialProposalResponseResult": {
"type": "object",
"description": "Результат выполнения задачи. Может быть null если задача еще не\n выполнена.",
"properties": {
"pdf": {
"type": "string",
"description": "Ссылка на презентацию в формате PDF."
},
"pptx": {
"type": "string",
"description": "Ссылка на презентацию в формате PPTX."
}
}
},
"CommercialProposalRequest": {
"type": "object",
"properties": {
"companyId": {
"description": "ID организации у которой одна физическая точка. Получаем из /priority/v1/company-search",
"type": "integer",
"format": "int64"
},
"chainID": {
"description": "ID организации, у которых несколько физических точек (сетевые или франшизы) Получаем из /priority/v1/company-search.",
"type": "integer",
"format": "int64"
},
"countryGeoID": {
"description": "Географический идентификатор страны.",
"type": "integer",
"format": "int32"
},
"manager": {
"type": "object",
"description": "Данные менеджера, добавляются на последний слайд",
"properties": {
"name": {
"type": "string",
"description": "Имя Фамилия менеджера."
},
"email": {
"type": "string",
"description": "E-mail менеджера."
}
}
},
"branding": {
"type": "boolean",
"description": "Добавляет в презентацию слайд про брендированную метку на Яндекс.Картах (пин с логотипом). Подходит только для крупных сетей."
},
"product": {
"type": "string",
"description": "Выбор создать презентацию на продукт «Реклама на Картах» (geoproduct) или «Рекламная подписка на весь Яндекс» (subscription). Презентации отличаются разным набором слайдов.",
"enum": [
"geoproduct",
"subscription"
]
}
}
},
"CommercialProposalRequestManager": {
"type": "object",
"description": "Данные менеджера, добавляются на последний слайд",
"properties": {
"name": {
"type": "string",
"description": "Имя Фамилия менеджера."
},
"email": {
"type": "string",
"description": "E-mail менеджера."
}
}
},
"CompanyCreation": {
"type": "object",
"description": "Информация о компании.",
"properties": {
"name": {
"type": "string",
"description": "Название компании"
},
"phone": {
"type": "string",
"description": "Телефон компании"
},
"website": {
"type": "string",
"description": "Вебсайт компании"
},
"coordinates": {
"type": "array",
"description": "Координаты [latitude, longitude]. Необходимо для компаний с типом offline (!)",
"items": {
"type": "number"
}
},
"rubricIds": {
"type": "array",
"description": "список ID рубрик из /rubric-suggestion (Запрос \"Поиск рубик\"), можно указать от 1 до 3 рубрик",
"items": {
"type": "number"
}
},
"type": {
"type": "string",
"description": "Тип компании",
"enum": [
"online",
"offline"
]
},
"regions": {
"type": "array",
"description": "Регионы, которые охватывает компания. Можно получить из /region-suggestion (Запрос \"Поиск регионов\") Необходимо для компаний с типом online (!)",
"items": {
"type": "object",
"description": "ID и наименование региона.",
"properties": {
"id": {
"type": "number",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
}
}
},
"required": [
"name",
"phone",
"rubricIds",
"type"
]
},
"CompanyCreationRegion": {
"type": "object",
"description": "ID и наименование региона.",
"properties": {
"id": {
"type": "number",
"description": "ID региона"
},
"name": {
"type": "string",
"description": "Наименование региона"
}
}
},
"CompanyCreationStatusData": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"in_progress",
"creation"
]
}
}
},
"CompanyCreationStatusError": {
"type": "object",
"description": "Ошибка при попытке узнать статус созданной компании.",
"properties": {
"code": {
"type": "number",
"description": "Код ошибки."
},
"message": {
"type": "string",
"description": "Сообщение об ошибке."
},
"businessCode": {
"type": "string",
"description": "Бизнес-код ошибки в текстовом формате.",
"enum": [
"COMPANY_NOT_FOUND"
]
}
}
}
}
}
}
Была ли статья полезна?
Предыдущая
Следующая