update: параметры TextCampaign

Структура запроса в формате JSON:

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "TextCampaign": {  /* TextCampaignUpdateItem */
        "BiddingStrategy": {  /* TextCampaignStrategy */
          "Search": {  /* TextCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "PlacementTypes" : {
              "SearchResults" : ( "YES" | "NO" ),
              "ProductGallery" : ( "YES" | "NO" ),
              "DynamicPlaces" : ( "YES" | "NO" )
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long),
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoals */
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long), /* nillable */
              "Profitability": (long), /* nillable */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr": {  /* StrategyPayForConversionCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "PayForConversion" : { /* StrategyPayForConversion */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoals */
              "WeeklySpendLimit" : (long) /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          },
          "Network": {  /* TextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefault */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long),
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoals */
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long), /* nillable */
              "Profitability": (long), /* nillable */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr": {  /* StrategyPayForConversionCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "PayForConversion" : { /* StrategyPayForConversion */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoals */
              "WeeklySpendLimit" : (long) /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          }
        },
        "Settings": [{  /* TextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "RelevantKeywords": {  /* RelevantKeywordsSetting */
          "BudgetPercent": (int),
          "OptimizeGoalId": (long) /* nillable */
        }, /* nillable */
        "PriorityGoals": { /* PriorityGoalsUpdateSetting */
          "Items": [{ /* PriorityGoalsUpdateItem */
            "GoalId": (long), /* required */
            "Value": (long), /* required */
            "Operation": ( "SET" ), /* required */
            "IsMetrikaSourceOfValue": ( "YES" | "NO" )
          }, ... ] /* required */
        }, /* nillable */
        "TrackingParams" : (string),
        "AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
        "PackageBiddingStrategy": {
          "StrategyId": (long),
          "StrategyFromCampaignId": (long),
          "Platforms" : {
            "SearchResult" : ( "YES" | "NO" ) /* required */,
            "ProductGallery" : ( "YES" | "NO" ) /* required */,
            "Network" : ( "YES" | "NO" ) /* required */,
            "DynamicPlaces" : ( "YES" | "NO" )
          }
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ... ] /* required */
  }
}

Параметр

Тип

Описание

Обязательный

Структура TextCampaignUpdateItem

Settings

array of TextCampaignSetting

Массив настроек, допускающих только значения YES или NO.

Нет

CounterIds

ArrayOfInteger, nillable

Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).

Нет

RelevantKeywords

RelevantKeywordsSetting, nillable

Настройки показов по дополнительным релевантным фразам (см. раздел Показы по дополнительным релевантным фразам).

Чтобы отключить показы по дополнительным релевантным фразам, передайте null (nil).

Нет

TrackingParams

string

Параметры URL для шаблонов.

AttributionModel

AttributionModelEnum

Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции).

Возможные значения:

  • FC — первый переход.
  • LC — последний переход.
  • LSC — последний значимый переход.
  • LYDC — последний переход из Яндекс Директа.
  • FCCD – первый переход кросс-девайс.
  • LSCCD – последний значимый переход кросс-девайс.
  • LYDCCD – последний переход из Яндекс Директа кросс-девайс.
  • AUTO – автоматическая атрибуция.

Нет

PackageBiddingStrategy

TextCampaignPackageBiddingStrategyUpdate, nillable

Привязывает кампанию к указанной стратегии. При значении Null (nil) отвязывает кампанию от пакетной стратегии, в этом случае обязательно передать новое значение BiddingStrategy.

При заполнении этого поля нельзя передавать следующие параметры:

  • BiddingStrategy.
  • PriorityGoals.
  • CounterIds.
  • AttributionModel.

Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение BiddingStrategy и сбросьте значение параметра PackageBiddingStrategy: null.

Нет

BiddingStrategy

TextCampaignStrategy

Стратегия показа.

Нет

PriorityGoals

PriorityGoalsUpdateSetting, nillable

Ключевые цели, на достижение которых направлена автоматическая корректировка ставок.

null (nil) — удалить набор ключевых целей. В этом случае автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа.

Ограничение — 30 ключевых целей.

При передаче параметров AverageCpaMultipleGoals или PayForConversionMultipleGoals

NegativeKeywordSharedSetIds

ArrayOfLong, nillable

Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве.

Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get.

Нет

Структура TextCampaignSetting

Option

TextCampaignSettingsEnum

Имя настройки:

  • ADD_METRICA_TAG
  • ADD_OPENSTAT_TAG
  • ADD_TO_FAVORITES
  • ENABLE_AREA_OF_INTEREST_TARGETING
  • ENABLE_COMPANY_INFO
  • ENABLE_EXTENDED_AD_TITLE
  • ENABLE_SITE_MONITORING
  • EXCLUDE_PAUSED_COMPETING_ADS
  • MAINTAIN_NETWORK_CPC
  • REQUIRE_SERVICING

Да

Value

YesNoEnum

Значение настройки.

Да

Структура RelevantKeywordsSetting

BudgetPercent

int

Максимальный процент бюджета, расходуемый на клики по дополнительным релевантным фразам (от 1 до 100).

Если структура RelevantKeywordsSetting ранее отсутствовала в кампании

OptimizeGoalId

long, nillable

Идентификатор цели Яндекс Метрики. Статистика конверсий по этой цели используется для оптимизации дополнительных релевантных фраз.

Подходят все цели, доступные для кампании, в том числе составные. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Допустимы также следующие значения:

  • 0 — оптимизация дополнительных релевантных фраз осуществляется по всем целям, доступным для кампании;

  • null (nil) — оптимизация по целям не осуществляется.

Если параметр не передан и в кампании отсутствовала структура RelevantKeywordsSetting (показы по дополнительным релевантным фразам были отключены), то значение по умолчанию — 0.

Внимание

Если в кампании выбрана стратегия WB_MAXIMUM_CONVERSION_RATE, AVERAGE_CPA или AVERAGE_ROI, то независимо от значения параметра OptimizeGoalId оптимизация осуществляется по цели (или всем целям), указанной в параметре GoalId в настройках стратегии.

Нет

Структура PriorityGoalsUpdateSetting

Items

array of PriorityGoalsUpdateItem

Новый набор ключевых целей и ценностей конверсий, которым нужно заменить существующий набор.

Да

Структура PriorityGoalsUpdateItem

GoalId

long

Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Значение 12 соответствует цели “Вовлеченные сессии”.

Да

Value

long

Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели.

Да

Operation

OperationEnum

Тип действия над набором ключевых целей. В настоящее время доступно только значение SET.

Да

IsMetrikaSourceOfValue

YesNoEnum

Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов.

При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType

Структура TextCampaignPackageBiddingStrategyUpdate

StrategyId

long

Идентификатор пакетной стратегии.

Нет

StrategyFromCampaignId

long

Идентификатор кампании, из которой создается пакетная стратегия.

Нет

Platforms

TextCampaignPlatforms

Платформа размещения рекламы.

Нет

Структура TextCampaignPlatforms

SearchResult

YesNoEnum

Поисковая выдача.

Да

ProductGallery

YesNoEnum

Товарная галерея.

Да

Network

YesNoEnum

Рекламная сеть Яндекса.

Да

DynamicPlaces

YesNoEnum

Динамические места на поиске.

Нет

Структура TextCampaignStrategy

Search

TextCampaignSearchStrategy

Стратегия показа на поиске.

Нет

Network

TextCampaignNetworkStrategy

Стратегия показа в сетях.

Нет

Структура TextCampaignSearchStrategy

BiddingStrategyType

TextCampaignSearchStrategyTypeEnum

Тип стратегии показа на поиске:

  • HIGHEST_POSITION
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_CONVERSION_RATE
  • AVERAGE_CPC
  • AVERAGE_CPA
  • AVERAGE_ROI
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION
  • PAY_FOR_CONVERSION_CRR
  • WEEKLY_CLICK_PACKAGE
  • SERVING_OFF

О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа.

Да

PlacementTypes

TextCampaignSearchStrategyPlacementTypes

Места показов на поиске.

Нет

WbMaximumClicks

StrategyMaximumClicks

Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету.

При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType

WbMaximumConversionRate

StrategyMaximumConversionRate

Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии.

При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType

AverageCpc

StrategyAverageCpc

Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика.

При значении AVERAGE_CPC в параметре BiddingStrategyType

AverageCpa

StrategyAverageCpa

Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии.

При значении AVERAGE_CPA в параметре BiddingStrategyType

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

Параметры стратегии Максимум конверсий с оплатой за клики, удерживать среднюю цену конверсии по нескольким целям.
Одновременно необходимо передать массив PriorityGoals с минимум двумя ключевыми целями, в качестве ценности Value указать для каждой цели целевую цену конверсии.

При значении AVERAGE_CPA_MULTIPLE_GOALS в параметре BiddingStrategyType

AverageRoi

StrategyAverageRoi

Параметры стратегии Оптимизация рентабельности.

При значении AVERAGE_ROI в параметре BiddingStrategyType

AverageCrr

StrategyAverageCrr

Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов.

При значении AVERAGE_CRR в параметре BiddingStrategyType

PayForConversionCrr

StrategyPayForConversionCrr

Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии.

При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType

PayForConversion

StrategyPayForConversion

Параметры стратегии Оптимизация конверсий, оплата за конверсии.

При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType

PayForConversionMultipleGoals

StrategyPayForConversionMultipleGoalsAdd

Параметры стратегии Максимум конверсий с оплатой за конверсии по каждой из указанных целей.
Одновременно необходимо передать массив PriorityGoals с минимум двумя ключевыми целями, в качестве ценности Value указать для каждой цели целевую цену конверсии.

При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType

WeeklyClickPackage

StrategyWeeklyClickPackage

Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов.

При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType

Структура TextCampaignNetworkStrategy

BiddingStrategyType

TextCampaignNetworkStrategyTypeEnum

Тип стратегии показа в сетях:

  • NETWORK_DEFAULT
  • MAXIMUM_COVERAGE
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_CONVERSION_RATE
  • AVERAGE_CPC
  • AVERAGE_CPA
  • AVERAGE_ROI
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION
  • PAY_FOR_CONVERSION_CRR
  • WEEKLY_CLICK_PACKAGE
  • SERVING_OFF

О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа.

Да

NetworkDefault

StrategyNetworkDefault

Настройки показов в сетях в зависимости от настроек на поиске.

Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, передайте пустую структуру.

При значении NETWORK_DEFAULT в параметре BiddingStrategyType

WbMaximumClicks

StrategyMaximumClicks

Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету.

При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType

WbMaximumConversionRate

StrategyMaximumConversionRate

Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии.

При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType

AverageCpc

StrategyAverageCpc

Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика.

При значении AVERAGE_CPC в параметре BiddingStrategyType

AverageCpa

StrategyAverageCpa

Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии.

При значении AVERAGE_CPA в параметре BiddingStrategyType

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

Параметры стратегии Максимум конверсий с оплатой за клики, удерживать среднюю цену конверсии по нескольким целям.
Одновременно необходимо передать массив PriorityGoals с минимум двумя ключевыми целями, в качестве ценности Value указать для каждой цели целевую цену конверсии.

При значении AVERAGE_CPA_MULTIPLE_GOALS в параметре BiddingStrategyType

AverageRoi

StrategyAverageRoi

Параметры стратегии Оптимизация рентабельности.

При значении AVERAGE_ROI в параметре BiddingStrategyType

AverageCrr

StrategyAverageCrr

Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов.

При значении AVERAGE_CRR в параметре BiddingStrategyType

PayForConversionCrr

StrategyPayForConversionCrr

Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии.

При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType

PayForConversion

StrategyPayForConversion

Параметры стратегии Оптимизация конверсий, оплата за конверсии.

При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType

PayForConversionMultipleGoals

StrategyPayForConversionMultipleGoalsAdd

Параметры стратегии Максимум конверсий с оплатой за конверсии по каждой из указанных целей.
Одновременно необходимо передать массив PriorityGoals с минимум двумя ключевыми целями, в качестве ценности Value указать для каждой цели целевую цену конверсии.

При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType

WeeklyClickPackage

StrategyWeeklyClickPackage

Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов.

При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType

Структура TextCampaignSearchStrategyPlacementTypes

SearchResults

YesNoEnum

Поисковая выдача.

Нет

ProductGallery

YesNoEnum

Товарная галерея.

Нет

DynamicPlaces

YesNoEnum

Динамические места на поиске.

Нет

Структура StrategyMaximumClicks

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

Структура StrategyMaximumConversionRate

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

Структура StrategyAverageCpc

AverageCpc

long

Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

WeeklySpendLimit

long, nillable

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

Структура StrategyAverageCpa

AverageCpa

long

Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Нет

WeeklySpendLimit

long, nillable

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

ExplorationBudget

ExplorationBudget

Минимальный бюджет. Подробнее в справке Директа.

Если поле не задано, значение миниального бюджета не изменится.

Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL.

Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES".

Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой.

Нет

Структура StrategyAverageCpaMultipleGoalsAdd

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BidCeiling

long

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

ExplorationBudget

ExplorationBudget

Минимальный бюджет. Подробнее в справке Директа.

Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии).

Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES".

Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой.

Нет

Структура StrategyAverageRoi

ReserveReturn

int

Максимальный процент сэкономленных средств, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра RoiCoef.

Значение от 0 до 100, кратное десяти: 0, 10, 20... 100.

Нет

RoiCoef

long

Желаемая средняя рентабельность инвестиций за неделю. Значение представляет собой отношение прибыли от продаж к расходам на рекламу, умноженное на 1 000 000. Значение должно быть целым числом. Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой).

Нет

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Нет

WeeklySpendLimit

long, nillable

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

Profitability

long, nillable

Процент выручки, являющийся себестоимостью товаров или услуг.

Значение представляет собой процент, умноженный на 1 000 000. Значение должно быть целым числом от 0 до 100 000 000 (что соответствует 100%). Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой).

Нет

ExplorationBudget

ExplorationBudget

Минимальный бюджет. Подробнее в справке Директа.

Если поле не задано, значение миниального бюджета не изменится.

Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL.

Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES".

Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой.

Нет

Структура StrategyAverageCrr

Crr

int

Средняя доля расходов.

Да

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Да

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

ExplorationBudget

ExplorationBudget

Минимальный бюджет. Подробнее в справке Директа.

Если поле не задано, значение миниального бюджета не изменится.

Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL.

Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES".

Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой.

Нет

Структура StrategyPayForConversionCrr

Crr

int

Средняя доля расходов.

Да

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Да

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

Структура StrategyPayForConversion

Cpa

long

Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

GoalId

long

Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики.

Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4.

Нет

WeeklySpendLimit

long, nillable

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL.

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

Структура PayForConversionMultipleGoals

WeeklySpendLimit

long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get.

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

Структура StrategyWeeklyClickPackage

ClicksPerWeek

long

Требуемое количество кликов в неделю.

Нет

AverageCpc

long, nillable

Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими. Если ранее был задан параметр BidCeiling, то, чтобы задать AverageCpc, нужно одновременно передать null (nil) для BidCeiling.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими. Если ранее был задан параметр AverageCpc, то, чтобы задать BidCeiling, нужно одновременно передать null (nil) для AverageCpc.

Нет

Структура StrategyNetworkDefault

LimitPercent

int

Максимальный процент бюджета, расходуемый на показы в сетях. Значение кратно десяти: 10, 20, ..., 100.

В случае смены стратегии, если параметр не указан, устанавливается значение по умолчанию — 100.

Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, параметр не используется, переданное значение игнорируется.

Нет

Структура ExplorationBudget

MinimumExplorationBudget

long

Значение минимального бюджета.

Допустимое значение: от 0 до значения недельного бюджета (если он задан).

Да, если в запросе есть структура ExplorationBudget.

IsMinimumExplorationBudgetCustom

YesNoEnum

Признак пользовательского значения минимального бюджета.

Да, если в запросе есть структура ExplorationBudget.

Структура CustomPeriodBudget

SpendLimit

long

Значение бюджета на период.

Да

StartDate

string

Начало бюджетного периода.

Да

EndDate

string

Окончание бюджетного периода.

Да

AutoContinue

YesNoEnum

Признак автопродления бюджета.

Да
Предыдущая
update
Следующая
update: параметры UnifiedCampaign