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

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

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "TextCampaign": {  /* TextCampaignAddItem */
        "BiddingStrategy": {  /* TextCampaignStrategyAdd */
          "Search": {  /* TextCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "PlacementTypes" : {
              "SearchResults" : ( "YES" | "NO" ),
              "ProductGallery" : ( "YES" | "NO" ),
              "DynamicPlaces" : ( "YES" | "NO" )
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long), /* required */
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoalsAdd */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "Profitability": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrrAdd */
              "Crr": (int), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr" : {  /* StrategyPayForConversionCrrAdd */
              "Crr": (int), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "PayForConversion" : { /* StrategyPayForConversionAdd */
              "Cpa" : (long) /* required */,
              "GoalId" : (long) /* required */,
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoalsAdd */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          }, /* required */
          "Network": {  /* TextCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long), /* required */
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoalsAdd */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BidCeiling": (long),
              "Profitability": (long),
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrrAdd */
              "Crr": (int), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr" : {  /* StrategyPayForConversionCrrAdd */
              "Crr": (int), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "PayForConversion" : { /* StrategyPayForConversionAdd */
              "Cpa" : (long) /* required */,
              "GoalId" : (long) /* required */,
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoalsAdd */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          } /* required */
        }, /* required */
        "Settings": [{  /* TextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        },
        "RelevantKeywords": {  /* RelevantKeywordsSettingAdd */
          "BudgetPercent": (int), /* required */
          "OptimizeGoalId": (long) /* nillable */
        },
        "PriorityGoals": { /* PriorityGoalsArray */
          "Items": [{ /* PriorityGoalsItem */
            "GoalId": (long), /* required */
            "Value": (long), /* required */
            "IsMetrikaSourceOfValue": ( "YES" | "NO" )
          }, ... ] /* required */
        },
        "TrackingParams": (string),
        "AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
        "PackageBiddingStrategy": { /* TextCampaignPackageBiddingStrategyAdd */
          "StrategyId": (long),
          "StrategyFromCampaignId": (long),
          "Platforms" : { /* required */
            "SearchResult" : ( "YES" | "NO" ) /* required */,
            "ProductGallery" : ( "YES" | "NO" ) /* required */,
            "Network" : ( "YES" | "NO" ) /* required */,
            "DynamicPlaces" : ( "YES" | "NO" )
          }
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }, ... ] /* required */
    }
  }
}

Параметр

Тип

Описание

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

Структура TextCampaignAddItem

BiddingStrategy

TextCampaignStrategyAdd

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

Нет, если указан PackageBiddingStrategy

Settings

array of TextCampaignSetting

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

Нет

CounterIds

ArrayOfInteger

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

Нет

RelevantKeywords

RelevantKeywordsSettingAdd

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

Нет

PriorityGoals

PriorityGoalsArray

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

Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа.

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

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

TrackingParams

string

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

Нет

AttributionModel

AttributionModelEnum

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

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

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

Значение по умолчанию — AUTO.

Нет

PackageBiddingStrategy

TextCampaignPackageBiddingStrategyAdd

Привязывает кампанию к указанной стратегии.

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

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

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

Нет, если указан BiddingStrategy

NegativeKeywordSharedSetIds

ArrayOfLong

Идентификаторы наборов минус-фраз. Не более 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

Да
  • CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED

Нет

Value

YesNoEnum

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

Да

Структура RelevantKeywordsSettingAdd

BudgetPercent

int

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

Да

OptimizeGoalId

long, nillable

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

При создании кампании отсутствует возможность указать конкретную цель. Допустимы следующие значения:

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

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

Если параметр не задан, значение по умолчанию — 0.

Нет

Структура TextCampaignPackageBiddingStrategyAdd

StrategyId

long

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

Нет

StrategyFromCampaignId

long

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

Нет

Platforms

TextCampaignPlatforms

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

Да

Структура PriorityGoalsArray

Items

array of PriorityGoalsItem

Набор ключевых целей и ценностей конверсий по ним.

Да

Структура PriorityGoalsItem

GoalId

long

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

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

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

Да

Value

long

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

Да

IsMetrikaSourceOfValue

YesNoEnum

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

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

Структура TextCampaignPlatforms

SearchResult

YesNoEnum

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

Да

ProductGallery

YesNoEnum

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

Да

Network

YesNoEnum

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

Да

DynamicPlaces

YesNoEnum

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

Нет

Структура TextCampaignStrategyAdd

Search

TextCampaignSearchStrategyAdd

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

Да

Network

TextCampaignNetworkStrategyAdd

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

Да

Структура TextCampaignSearchStrategyAdd

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

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

Примечание

При создании кампании тип размещения "Динамические места на поиске" принимает такое же значение, что и тип "Поисковая выдача" (поле SearchResults). Управление типом "Динамические места на поиске" появится в API позже.

Нет

WbMaximumClicks

StrategyMaximumClicksAdd

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

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

WbMaximumConversionRate

StrategyMaximumConversionRateAdd

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

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

AverageCpc

StrategyAverageCpcAdd

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

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

AverageCpa

StrategyAverageCpaAdd

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

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

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

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

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

AverageRoi

StrategyAverageRoiAdd

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

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

AverageCrr

StrategyAverageCrrAdd

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

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

PayForConversionCrr

StrategyPayForConversionCrrAdd

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

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

WeeklyClickPackage

StrategyWeeklyClickPackageAdd

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

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

PayForConversion

StrategyPayForConversionAdd

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

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

PayForConversionMultipleGoals

StrategyPayForConversionMultipleGoalsAdd

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

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

Структура TextCampaignNetworkStrategyAdd

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

StrategyNetworkDefaultAdd

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

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

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

WbMaximumClicks

StrategyMaximumClicksAdd

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

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

WbMaximumConversionRate

StrategyMaximumConversionRateAdd

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

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

AverageCpc

StrategyAverageCpcAdd

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

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

AverageCpa

StrategyAverageCpaAdd

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

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

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

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

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

AverageRoi

StrategyAverageRoiAdd

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

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

AverageCrr

StrategyAverageCrrAdd

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

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

PayForConversion

StrategyPayForConversionAdd

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

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

PayForConversionMultipleGoals

StrategyPayForConversionMultipleGoalsAdd

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

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

PayForConversionCrr

StrategyPayForConversionCrrAdd

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

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

WeeklyClickPackage

StrategyWeeklyClickPackageAdd

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

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

Структура StrategyMaximumClicksAdd

WeeklySpendLimit

long

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

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

Да

BidCeiling

long

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

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

Примечание

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура TextCampaignSearchStrategyPlacementTypes

SearchResults

YesNoEnum

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

Нет

ProductGallery

YesNoEnum

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

Нет

DynamicPlaces

YesNoEnum

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

Нет

Структура StrategyMaximumConversionRateAdd

WeeklySpendLimit

long

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

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

Да

BidCeiling

long

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

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

Примечание

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

Нет

GoalId

long

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

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

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

Да

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyAverageCpcAdd

AverageCpc

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyAverageCpaAdd

AverageCpa

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

GoalId

long

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

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

Да

BidCeiling

long

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

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

Примечание

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

Нет

ExplorationBudget

ExplorationBudget

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

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

Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре 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, операция завершится с ошибкой.

Нет

Структура StrategyAverageRoiAdd

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

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

BidCeiling

long

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

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

Примечание

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

Нет

Profitability

long

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

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

Нет

ExplorationBudget

ExplorationBudget

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

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

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

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

Нет

Структура StrategyAverageCrrAdd

Crr

int

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

Да

GoalId

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

ExplorationBudget

ExplorationBudget

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

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

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

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

Нет

Структура StrategyPayForConversionAdd

Cpa

long

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

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

Да

GoalId

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура PayForConversionMultipleGoals

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyPayForConversionCrrAdd

Crr

int

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

Да

GoalId

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyWeeklyClickPackageAdd

ClicksPerWeek

long

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

Да

AverageCpc

long

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

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

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба.

Нет

BidCeiling

long

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

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

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба.

Нет

Структура StrategyNetworkDefaultAdd

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

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

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