Создание рекламной кампании

Deprecated

Создает рекламную кампанию. Операция асинхронная, чтобы получить ответ может быть нужно повторить запрос несколько раз. Передаем companyId если создаем на организацию с одной физической точкой (или один филиал сети), chainId если на всю сеть (сразу все филиалы). Создание на определенный набор филиалов пока недоступно.

Request

POST

https://geoadv-api.yandex.ru/priority/v1/create-campaign

Headers

Name

Description

Client-Login*

Type: string

Логин субклиента на кого создаем рекламную кампанию

Body

application/json
{
    "name": "string",
    "companyId": 0,
    "chainId": 0,
    "countryGeoId": 0,
    "url": "string"
}

Name

Description

chainId

Type: number

ID организации, у которых несколько физических точек (сетевые или франшизы)

companyId

Type: number

Идентификатор организации, у которой только одна физическая точка.

countryGeoId

Type: number

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

name

Type: string

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

url

Type: string

Сайт организации нужен для создания веб кампании.

Responses

200 OK

Информация о созданной кампании.

Body

application/json
{
    "state": "string",
    "id": 0,
    "name": "string",
    "type": "WEB"
}

Name

Description

id

Type: number

ID созданной рекламной кампании.

name

Type: string

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

state

Type: string

Статус READY | PROCESSING.

type

Type: string

Тип рекламной кампании.

Enum: WEB, SUBSCRIPTION, GEO

422 Unprocessable Entity

Ошибка при работе

Body

application/json
{
    "code": 0,
    "message": "string",
    "businessCode": "RESOURCE_ACCESS_FORBIDDEN запрос выполняется не представителем агентства"
}

Name

Description

businessCode

Type: string

Бизнес-код ошибки в текстовом формате.

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 нет доступных продуктов

code

Type: number

Код ошибки.

message

Type: string

Сообщение об ошибке.

500 Internal Server Error

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

No longer supported, please use an alternative and newer version.