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

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

Request

GET

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

Query parameters

Name

Description

limit

Type: number

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

offset

Type: number

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

Headers

Name

Description

Client-Login

Type: string

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

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": {
        "client": {
          "type": "FOREIGN_LEGAL иностранное юридическое лицо",
          "inn": "example",
          "name": "example",
          "kpp": "example",
          "epayNumber": "example",
          "oksmNumber": "example",
          "vat": "example",
          "regNumber": "example"
        },
        "contractor": {
          "type": "FOREIGN_LEGAL иностранное юридическое лицо",
          "inn": "example",
          "name": "example",
          "kpp": "example",
          "epayNumber": "example",
          "oksmNumber": "example",
          "vat": "example",
          "regNumber": "example"
        },
        "contract": {
          "type": "contract  договор оказания услуг",
          "isChargePaidByAgent": true,
          "actionType": "distribution действия в целях распространения рекламы",
          "subjectType": "org-distribution договор на организацию распространения рекламы",
          "number": "example",
          "date": "example",
          "amount": 0.5,
          "isVat": true
        }
      }
    }
  ]
}

Name

Description

campaigns

Type: CampaignV6[]

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

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": {
      "client": {
        "type": "FOREIGN_LEGAL иностранное юридическое лицо",
        "inn": "example",
        "name": "example",
        "kpp": "example",
        "epayNumber": "example",
        "oksmNumber": "example",
        "vat": "example",
        "regNumber": "example"
      },
      "contractor": {
        "type": "FOREIGN_LEGAL иностранное юридическое лицо",
        "inn": "example",
        "name": "example",
        "kpp": "example",
        "epayNumber": "example",
        "oksmNumber": "example",
        "vat": "example",
        "regNumber": "example"
      },
      "contract": {
        "type": "contract  договор оказания услуг",
        "isChargePaidByAgent": true,
        "actionType": "distribution действия в целях распространения рекламы",
        "subjectType": "org-distribution договор на организацию распространения рекламы",
        "number": "example",
        "date": "example",
        "amount": 0.5,
        "isVat": true
      }
    }
  }
]

pager

Type: GetCampaignsV6Pager

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

Example

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

GetCampaignsV6Pager

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

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

Example

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

CampaignV6Company

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
}

CampaignV6Country

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

Name

Description

geoId

Type: number

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

name

Type: string

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

Example: example

Example

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

CampaignV6User

Name

Description

Type: number

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

login

Type: string

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

Example: example

Example

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

CampaignV6Agency

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

Name

Description

Type: number

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

name

Type: number

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

Example

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

CampaignBeneficiaryClient

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

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

Example

{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

CampaignBeneficiaryContractor

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

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

Example

{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

CampaignBeneficiaryContract

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

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

Example

{
  "type": "contract  договор оказания услуг",
  "isChargePaidByAgent": true,
  "actionType": "distribution действия в целях распространения рекламы",
  "subjectType": "org-distribution договор на организацию распространения рекламы",
  "number": "example",
  "date": "example",
  "amount": 0.5,
  "isVat": true
}

CampaignExtendedBeneficiary

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

Name	Description
client	Type: CampaignBeneficiaryClient Данные конечного рекламодателя Example `{ "type": "FOREIGN_LEGAL иностранное юридическое лицо", "inn": "example", "name": "example", "kpp": "example", "epayNumber": "example", "oksmNumber": "example", "vat": "example", "regNumber": "example" }`
contract	Type: CampaignBeneficiaryContract Договор между клиентом и посредником Example `{ "type": "contract договор оказания услуг", "isChargePaidByAgent": true, "actionType": "distribution действия в целях распространения рекламы", "subjectType": "org-distribution договор на организацию распространения рекламы", "number": "example", "date": "example", "amount": 0.5, "isVat": true }`
contractor	Type: CampaignBeneficiaryContractor Данные посредника Example `{ "type": "FOREIGN_LEGAL иностранное юридическое лицо", "inn": "example", "name": "example", "kpp": "example", "epayNumber": "example", "oksmNumber": "example", "vat": "example", "regNumber": "example" }`

Example

{
  "client": {
    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
    "inn": "example",
    "name": "example",
    "kpp": "example",
    "epayNumber": "example",
    "oksmNumber": "example",
    "vat": "example",
    "regNumber": "example"
  },
  "contractor": {
    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
    "inn": "example",
    "name": "example",
    "kpp": "example",
    "epayNumber": "example",
    "oksmNumber": "example",
    "vat": "example",
    "regNumber": "example"
  },
  "contract": {
    "type": "contract  договор оказания услуг",
    "isChargePaidByAgent": true,
    "actionType": "distribution действия в целях распространения рекламы",
    "subjectType": "org-distribution договор на организацию распространения рекламы",
    "number": "example",
    "date": "example",
    "amount": 0.5,
    "isVat": true
  }
}

CampaignV6

Name	Description
agency	Type: CampaignV6Agency Информация о рекламном агентстве Example `{ "id": 0.5, "name": 0.5 }`
beneficiary	Type: CampaignExtendedBeneficiary Данные о рекламодателе. Example { "client": { "type": "FOREIGN_LEGAL иностранное юридическое лицо", "inn": "example", "name": "example", "kpp": "example", "epayNumber": "example", "oksmNumber": "example", "vat": "example", "regNumber": "example" }, "contractor": { "type": "FOREIGN_LEGAL иностранное юридическое лицо", "inn": "example", "name": "example", "kpp": "example", "epayNumber": "example", "oksmNumber": "example", "vat": "example", "regNumber": "example" }, "contract": { "type": "contract договор оказания услуг", "isChargePaidByAgent": true, "actionType": "distribution действия в целях распространения рекламы", "subjectType": "org-distribution договор на организацию распространения рекламы", "number": "example", "date": "example", "amount": 0.5, "isVat": true } }
company	Type: CampaignV6Company Example `{ "id": 0.5, "name": "example", "isChain": true, "isOnline": true }`
country	Type: CampaignV6Country Страна, для которой используется рекламная кампания 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: CampaignV6User[] Пользователи, имеющие доступ к рекламной кампании 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": {
    "client": {
      "type": "FOREIGN_LEGAL иностранное юридическое лицо",
      "inn": "example",
      "name": "example",
      "kpp": "example",
      "epayNumber": "example",
      "oksmNumber": "example",
      "vat": "example",
      "regNumber": "example"
    },
    "contractor": {
      "type": "FOREIGN_LEGAL иностранное юридическое лицо",
      "inn": "example",
      "name": "example",
      "kpp": "example",
      "epayNumber": "example",
      "oksmNumber": "example",
      "vat": "example",
      "regNumber": "example"
    },
    "contract": {
      "type": "contract  договор оказания услуг",
      "isChargePaidByAgent": true,
      "actionType": "distribution действия в целях распространения рекламы",
      "subjectType": "org-distribution договор на организацию распространения рекламы",
      "number": "example",
      "date": "example",
      "amount": 0.5,
      "isVat": true
    }
  }
}

500 Internal Server Error

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

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

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

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