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

Deprecated

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

Request

GET

https://geoadv-api.yandex.ru/priority/v1/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,
    "name": "example",
    "chainId": 0.5,
    "isChainCampaign": true,
    "companyDescription": {
      "companyId": 0.5,
      "name": "example",
      "online": true
    },
    "paused": true,
    "status": "DELAYED_START",
    "users": {
      "id": 0.5,
      "login": "example"
    },
    "agency": {
      "id": 0.5,
      "name": 0.5
    },
    "country": {
      "geoID": 0.5
    },
    "remainingDays": 0.5,
    "type": "WEB"
  }
}

Name

Description

campaigns

Type: Campaign

Информация о рекламных кампаниях.

Example

{
  "id": 0.5,
  "name": "example",
  "chainId": 0.5,
  "isChainCampaign": true,
  "companyDescription": {
    "companyId": 0.5,
    "name": "example",
    "online": true
  },
  "paused": true,
  "status": "DELAYED_START",
  "users": {
    "id": 0.5,
    "login": "example"
  },
  "agency": {
    "id": 0.5,
    "name": 0.5
  },
  "country": {
    "geoID": 0.5
  },
  "remainingDays": 0.5,
  "type": "WEB"
}

pager

Type: GetCampaignsPager

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

Example

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

GetCampaignsPager

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

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

Example

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

CampaignCompanyDescription

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

Example

{
  "companyId": 0.5,
  "name": "example",
  "online": true
}

CampaignUsers

Пользователи, имеющие доступ к рекламной кампании.

Name

Description

Type: number

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

login

Type: string

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

Example: example

Example

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

CampaignAgency

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

Name

Description

Type: number

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

name

Type: number

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

Example

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

CampaignCountry

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

Name

Description

geoID

Type: number

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

Example

{
  "geoID": 0.5
}

Campaign

Информация о рекламных кампаниях.

Name	Description
agency	Type: CampaignAgency Информация о рекламном агентстве. Example `{ "id": 0.5, "name": 0.5 }`
chainId	Type: number ID организации, у которых несколько физических точек (сетевые или франшизы)
companyDescription	Type: CampaignCompanyDescription Example `{ "companyId": 0.5, "name": "example", "online": true }`
country	Type: CampaignCountry Страна для которой используется рекламная кампания. Example `{ "geoID": 0.5 }`
id	Type: number ID рекламной кампании.
isChainCampaign	Type: boolean Входит ли организация в сеть.
name	Type: string Название рекламной кампании. Example: `example`
paused	Type: boolean Остановлена ли рекламная кампания.
remainingDays	Type: number Количество дней оставшихся в рекламной кампании.
status	Type: string Текущий статус рекламной кампании. Enum: `DELAYED_START`, `FINISHED`, `PAUSED`, `RUNNING`, `STOPPED`, `WAITING`
type	Type: string Тип рекламной кампании. Enum: `WEB`, `SUBSCRIPTION`, `GEO`
users	Type: CampaignUsers Пользователи, имеющие доступ к рекламной кампании. Example `{ "id": 0.5, "login": "example" }`

Example

{
  "id": 0.5,
  "name": "example",
  "chainId": 0.5,
  "isChainCampaign": true,
  "companyDescription": {
    "companyId": 0.5,
    "name": "example",
    "online": true
  },
  "paused": true,
  "status": "DELAYED_START",
  "users": {
    "id": 0.5,
    "login": "example"
  },
  "agency": {
    "id": 0.5,
    "name": 0.5
  },
  "country": {
    "geoID": 0.5
  },
  "remainingDays": 0.5,
  "type": "WEB"
}

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

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

Применение промокода к кампании