Изменить кампанию

Изменяет данные указанной кампании.

Request

PUT

https://api.media.metrika.yandex.net/v1/management/advertiser/{advertiserId}/campaign/{campaignId}

Path parameters

Name

Description

advertiserId*

Type: integer<int32>

Идентификатор рекламодателя.

campaignId*

Type: integer<int32>

Идентификатор кампании.

Query parameters

Name

Description

override

Type: boolean

Переопределить значения, заданные ранее.

Default: false

Body

application/json
{
    "campaign": {
        "name": "string",
        "date_start": "string",
        "date_end": "string",
        "status": "active",
        "plan_impressions": 0,
        "plan_clicks": 0,
        "goal_plans": [
            {
                "goal_id": 0,
                "conversions": 0,
                "avg_conversion_cost": 0
            }
        ],
        "goals": [
            {
                "counter_id": 0,
                "counter_name": "string",
                "goal_id": 0,
                "goal_name": "string",
                "site": "string",
                "owner": "string"
            }
        ],
        "placements": [
            {
                "name": "string",
                "placement_type": "banner",
                "pricing_model": "cpm",
                "volume": 0,
                "cost": 0,
                "creatives": [
                    {
                        "creative_id": 0,
                        "comment": "string"
                    }
                ],
                "site_id": 0,
                "landing_id": 0
            }
        ],
        "plan_ctr": 0,
        "plan_cpm": 0,
        "plan_cpc": 0
    }
}

Name

Description

campaign

Type: CampaignSettingsIn

CampaignSettingsIn

Name

Description

date_end*

Type: string

Время окончания проведения кампании.

date_start*

Type: string

Время начала проведения кампании.

placements*

Type: PlacementIn[]

Информация о размещениях.

goal_plans

Type: GoalPlan[]

План по показателям.

Min items: 0

Max items: 1

goals

Type: AdvGoal[]

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

Min items: 0

Max items: 1000

name

Type: string

Название кампании.

Min length: 1

Max length: 256

plan_clicks

Type: integer<int32>

Плановое количество кликов.

Max value: 1000000

plan_cpc

Type: number<double>

CPC средний.

plan_cpm

Type: number<double>

CPM средний.

plan_ctr

Type: number<double>

CTR средний.

plan_impressions

Type: integer<int32>

Плановое количество показов.

Max value: 1000000000

status

Type: string

Статус кампании.

Enum: active, archived

PlacementIn

Информация о размещениях.

Name

Description

landing_id*

Type: integer<int32>

Идентификатор посадочной страницы.

site_id*

Type: integer<int32>

Идентификатор места размещения.

cost

Type: number<double>

Стоимость за единицу, ₽.

creatives

Type: Creative[]

Креативы.

name

Type: string

Название размещения.

Min length: 1

Max length: 256

placement_type

Type: string

Тип размещения.

Enum: banner, video, search

pricing_model

Type: string

Модель закупки.

Enum: cpm, cpc, days

volume

Type: integer<int32>

Объем закупки, тыс. ед..

Max value: 1000000000

GoalPlan

План по показателям.

Name

Description

avg_conversion_cost

Type: number<double>

Средняя цена конверсии, ₽.

conversions

Type: integer<int32>

Количество конверсий.

Max value: 1000000000

goal_id

Type: integer<int64>

Идентификатор цели.

AdvGoal

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

Name

Description

counter_id

Type: integer<int32>

Идентификатор счетчика.

counter_name

Type: string

Название счетчика.

goal_id

Type: integer<int64>

Идентификатор цели.

goal_name

Type: string

Название цели.

owner

Type: string

Полный домен сайта.

site

Type: string

Полный домен сайта.

Creative

Креативы.

Name

Description

comment*

Type: string

Название креатива.

creative_id

Type: integer<int32>

Идентификатор креатива.

Responses

200 OK

OK

Body

application/json
{
    "campaign": {
        "name": "string",
        "date_start": "string",
        "date_end": "string",
        "status": "active",
        "plan_impressions": 0,
        "plan_clicks": 0,
        "goal_plans": [
            {
                "goal_id": 0,
                "conversions": 0,
                "avg_conversion_cost": 0
            }
        ],
        "goals": [
            {
                "counter_id": 0,
                "counter_name": "string",
                "goal_id": 0,
                "goal_name": "string",
                "site": "string",
                "owner": "string"
            }
        ],
        "campaign_id": 0,
        "create_time": "string",
        "placements": [
            {
                "name": "string",
                "placement_type": "banner",
                "pricing_model": "cpm",
                "volume": 0,
                "cost": 0,
                "creatives": [
                    {
                        "creative_id": 0,
                        "comment": "string"
                    }
                ],
                "placement_id": 0,
                "site": {
                    "site_id": 0,
                    "name": "string",
                    "url": "string",
                    "site_type": "adv_network"
                },
                "landing": {
                    "landing_id": 0,
                    "name": "string",
                    "url": "string"
                }
            }
        ],
        "real_date_start": "string",
        "real_date_end": "string",
        "plan_ctr": 0,
        "plan_cpm": 0,
        "plan_cpc": 0
    }
}

Name

Description

campaign

Type: CampaignSettingsOut

Параметры кампании.

CampaignSettingsOut

Параметры кампании.

Name

Description

date_end*

Type: string

Время окончания проведения кампании.

date_start*

Type: string

Время начала проведения кампании.

campaign_id

Type: integer<int32>

Идентификатор кампании.

create_time

Type: string

Время создания кампании.

goal_plans

Type: GoalPlan[]

План по показателям.

Min items: 0

Max items: 1

goals

Type: AdvGoal[]

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

Min items: 0

Max items: 1000

name

Type: string

Название кампании.

Min length: 1

Max length: 256

placements

Type: PlacementOut[]

Размещения.

plan_clicks

Type: integer<int32>

Плановое количество кликов.

Max value: 1000000

plan_cpc

Type: number<double>

CPC средний.

plan_cpm

Type: number<double>

CPM средний.

plan_ctr

Type: number<double>

CTR средний.

plan_impressions

Type: integer<int32>

Плановое количество показов.

Max value: 1000000000

real_date_end

Type: string

Время окончания проведения кампании.

real_date_start

Type: string

Время начала проведения кампании.

status

Type: string

Статус кампании.

Enum: active, archived

PlacementOut

Размещения.

Name

Description

cost

Type: number<double>

Стоимость за единицу, ₽.

creatives

Type: Creative[]

Креативы.

landing

Type: Landing

Информация о посадочной странице.

name

Type: string

Название размещения.

Min length: 1

Max length: 256

placement_id

Type: integer<int32>

Идентификатор размещения.

placement_type

Type: string

Тип размещения.

Enum: banner, video, search

pricing_model

Type: string

Модель закупки.

Enum: cpm, cpc, days

site

Type: Site

Место размещения.

volume

Type: integer<int32>

Объем закупки, тыс. ед..

Max value: 1000000000

Landing

Информация о посадочной странице.

Name

Description

landing_id

Type: integer<int32>

Идентификатор посадочной страницы.

name

Type: string

Название посадочной страницы.

Min length: 1

Max length: 256

url

Type: string

URL посадочной страницы.

Min length: 1

Max length: 1024

Site

Место размещения.

Name

Description

name

Type: string

Название места размещения.

Min length: 1

Max length: 300

site_id

Type: integer<int32>

Идентификатор места размещения. Список доступных мест размещений см. в ручке GET /v1/management/sites

site_type

Type: string

Тип места размещения:

  • adv_network — в рекламных системах Яндекса
  • site — другое место размещения

Enum: adv_network, site

url

Type: string

URL места размещения.

Min length: 1

Max length: 300
Предыдущая
Получить параметры кампании
Следующая
Удалить кампанию