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

Deprecated

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

Request

GET

https://geoadv-api.yandex.ru/priority/v4/get-campaigns

Query parameters

Name

Description

limit

Type: number

Количество рекламных кампаний

offset

Type: number

Оффсет ответа

Headers

Name

Description

Client-Login

Type: string

Логин субклиента, для кого запрашиваем список рекламных кампаний. Если его не будет - вернется список всех РК агентства

Example: ``

Responses

200 OK

Найденные рекламные кампании

Body

application/json

{
  "pager": {
    "total": 0.5,
    "limit": 0.5,
    "offset": 0.5
  },
  "campaigns": [
    {
      "id": 0.5,
      "status": "STOPPED",
      "remainingDays": 0.5,
      "url": "example",
      "mapsOnly": true,
      "name": "example",
      "paused": true,
      "company": {
        "id": 0.5,
        "name": "example",
        "isChain": true,
        "isOnline": true
      },
      "country": {
        "geoId": 0.5,
        "name": "example"
      },
      "users": [
        {
          "id": 0.5,
          "login": "example"
        }
      ],
      "agency": {
        "id": 0.5,
        "name": 0.5
      },
      "beneficiary": {
        "type": "FOREIGN_LEGAL",
        "phone": "example",
        "email": "example",
        "inn": "example"
      }
    }
  ]
}

Name

Description

campaigns

Type: CampaignV4[]

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

Example

[
  {
    "id": 0.5,
    "status": "STOPPED",
    "remainingDays": 0.5,
    "url": "example",
    "mapsOnly": true,
    "name": "example",
    "paused": true,
    "company": {
      "id": 0.5,
      "name": "example",
      "isChain": true,
      "isOnline": true
    },
    "country": {
      "geoId": 0.5,
      "name": "example"
    },
    "users": [
      {
        "id": 0.5,
        "login": "example"
      }
    ],
    "agency": {
      "id": 0.5,
      "name": 0.5
    },
    "beneficiary": {
      "type": "FOREIGN_LEGAL",
      "phone": "example",
      "email": "example",
      "inn": "example"
    }
  }
]

pager

Type: GetCampaignsV4Pager

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

Example

{
  "total": 0.5,
  "limit": 0.5,
  "offset": 0.5
}

GetCampaignsV4Pager

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

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

Example

{
  "total": 0.5,
  "limit": 0.5,
  "offset": 0.5
}

CampaignV4Company

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

Example

{
  "id": 0.5,
  "name": "example",
  "isChain": true,
  "isOnline": true
}

CampaignV4Country

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

Name

Description

geoId

Type: number

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

name

Type: string

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

Example: example

Example

{
  "geoId": 0.5,
  "name": "example"
}

CampaignV4User

Name

Description

Type: number

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

login

Type: string

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

Example: example

Example

{
  "id": 0.5,
  "login": "example"
}

CampaignV4Agency

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

Name

Description

Type: number

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

name

Type: number

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

Example

{
  "id": 0.5,
  "name": 0.5
}

CampaignBeneficiary

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

Name	Description
email	Type: string Email рекламодателя Example: `example`
inn	Type: string ИНН рекламодателя. Обязателен для типов рекламодателей: - LEGAL - Юридическое лицо (12 символов) - FOREIGN_LEGAL - Иностранное юридическое лицо (от 1 до 50 символов) - INDIVIDUAL - ИП (12 символов) Example: `example`
phone	Type: string Номер телефона рекламодателя. Обязательное поле для типов рекламодателей: - FOREIGN_PHYSICAL - Иностранное физическое лицо - PHYSICAL - Физическое лицо Example: `example`
type	Type: string Тип рекламодателя. Возможные значения: - FOREIGN_LEGAL - Иностранное юридическое лицо - FOREIGN_PHYSICAL - Иностранное физическое лицо - INDIVIDUAL - ИП - LEGAL - Юридическое лицо - PHYSICAL - Физическое лицо Enum: `FOREIGN_LEGAL`, `FOREIGN_PHYSICAL`, `INDIVIDUAL`, `LEGAL`, `PHYSICAL`

Example

{
  "type": "FOREIGN_LEGAL",
  "phone": "example",
  "email": "example",
  "inn": "example"
}

CampaignV4

Name	Description
agency	Type: CampaignV4Agency Информация о рекламном агентстве Example `{ "id": 0.5, "name": 0.5 }`
beneficiary	Type: CampaignBeneficiary Данные о рекламодателе. Example `{ "type": "FOREIGN_LEGAL", "phone": "example", "email": "example", "inn": "example" }`
company	Type: CampaignV4Company Example `{ "id": 0.5, "name": "example", "isChain": true, "isOnline": true }`
country	Type: CampaignV4Country Страна, для которой используется рекламная кампания Example `{ "geoId": 0.5, "name": "example" }`
id	Type: number ID рекламной кампании
mapsOnly	Type: boolean Кампания рекламируется только на Яндекс Картах
name	Type: string Название рекламной кампании Example: `example`
paused	Type: boolean Остановлена ли рекламная кампания
remainingDays	Type: number Количество оставщихся дней
status	Type: string Статус рекламной кампании Enum: `STOPPED`, `WAITING`, `PAUSED`, `RUNNING`, `FINISHED`, `DELAYED_START`
url	Type: string Рекламируемый сайт Example: `example`
users	Type: CampaignV4User[] Пользователи, имеющие доступ к рекламной кампании Example `[ { "id": 0.5, "login": "example" } ]`

Example

{
  "id": 0.5,
  "status": "STOPPED",
  "remainingDays": 0.5,
  "url": "example",
  "mapsOnly": true,
  "name": "example",
  "paused": true,
  "company": {
    "id": 0.5,
    "name": "example",
    "isChain": true,
    "isOnline": true
  },
  "country": {
    "geoId": 0.5,
    "name": "example"
  },
  "users": [
    {
      "id": 0.5,
      "login": "example"
    }
  ],
  "agency": {
    "id": 0.5,
    "name": 0.5
  },
  "beneficiary": {
    "type": "FOREIGN_LEGAL",
    "phone": "example",
    "email": "example",
    "inn": "example"
  }
}

500 Internal Server Error

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

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

Получение данных о рекламодателе

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