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

Внимание. Все денежные параметры кампаний (дневной бюджет, недельный бюджет, средняя цена для автоматических стратегий) передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой денежное значение в валюте рекламодателя, умноженное на 1 000 000.

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

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "DynamicTextCampaign": {  /* DynamicTextCampaignAddItem */
        "BiddingStrategy": {  /* DynamicTextCampaignStrategyAdd */
          "Search": {  /* DynamicTextCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "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 */
              }
            },
            "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")
              }
            }
          }, /* required */
          "Network": {  /* DynamicTextCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "SERVING_OFF" ) /* required */
          } /* required */
        }, /* required */
        "Settings": [{  /* DynamicTextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "PlacementTypes": [{  /* DynamicTextCampaignPlacementTypes */
          "Type": ( "SEARCH_RESULTS" | "PRODUCT_GALLERY" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        },
        "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": {
          "StrategyId": (long),
          "StrategyFromCampaignId": (long)
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обязательный
Структура DynamicTextCampaignAddItem
BiddingStrategy DynamicTextCampaignStrategyAdd Стратегия показа. Нет, если указан PackageBiddingStrategy
Settings array of DynamicTextCampaignSetting Массив настроек, допускающих только значения YES или NO. Нет
PlacementTypes array of DynamicTextCampaignPlacementTypes Места показа рекламы на поиске. Нет
CounterIds ArrayOfInteger Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). Нет
PriorityGoals PriorityGoalsArray

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

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

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

 Нет
TrackingParams string

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

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

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

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

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

 Нет
PackageBiddingStrategy DynamicTextCampaignPackageBiddingStrategyAdd

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

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

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

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

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

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

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

 Нет
Структура DynamicTextCampaignSetting
Option DynamicTextCampaignSettingsEnum

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

 Да
Нет
Value YesNoEnum Значение настройки. Да
Структура DynamicTextCampaignPlacementTypes
Type DynamicTextCampaignPlacementTypesEnum

Тип места показа рекламы на поиске:

  • SEARCH_RESULTS — в результатах поиска.
  • PRODUCT_GALLERY — в Товарной галерее.
 Да
Value YesNoEnum Значение настройки. Да
Структура DynamicTextCampaignPackageBiddingStrategyAdd
StrategyId long Идентификатор пакетной стратегии.
StrategyFromCampaignId long Идентификатор кампании, из которой создается пакетная стратегия. Нет
Структура 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
Структура DynamicTextCampaignStrategyAdd
Search DynamicTextCampaignSearchStrategyAdd Стратегия показа на поиске. Да
Network DynamicTextCampaignNetworkStrategyAdd Стратегия показа в сетях. Да
Структура DynamicTextCampaignSearchStrategyAdd
BiddingStrategyType DynamicTextCampaignSearchStrategyTypeEnum

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

 Да
WbMaximumClicks StrategyMaximumClicksAdd Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRate StrategyMaximumConversionRateAdd Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpc StrategyAverageCpcAdd Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpa StrategyAverageCpaAdd Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoi StrategyAverageRoiAdd Параметры стратегии Оптимизация рентабельности. При значении AVERAGE_ROI в параметре BiddingStrategyType
AverageCrr StrategyAverageCrrAdd Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. При значении AVERAGE_CRR в параметре BiddingStrategyType
PayForConversion StrategyPayForConversionAdd Параметры стратегии Оптимизация конверсий, оплата за конверсии. При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType
PayForConversionCrr StrategyPayForConversionCrrAdd Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType
WeeklyClickPackage StrategyWeeklyClickPackageAdd

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

Ограничение.

Параметр устарел и больше не поддерживается.

 При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура DynamicTextCampaignNetworkStrategyAdd
BiddingStrategyType DynamicTextCampaignNetworkStrategyTypeEnum Тип стратегии показа в сетях. Доступно единственное значение: SERVING_OFF. Да
Структура StrategyMaximumClicksAdd
WeeklySpendLimit long

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

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

 Да
BidCeiling long

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

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

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

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

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

 Нет
Структура 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, операция завершится с ошибкой.

 Нет
Структура 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, операция завершится с ошибкой.

 Нет
Структура PayForConversionAdd
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.

 Нет
Структура 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.

Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.
 Нет
Структура ExplorationBudget
MinimumExplorationBudget long

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

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

 Да, если в запросе есть структура ExplorationBudget.
IsMinimumExplorationBudgetCustom YesNoEnum Признак пользовательского значения минимального бюджета. Да, если в запросе есть структура ExplorationBudget.
Структура CustomPeriodBudget
SpendLimit long

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

 Да
StartDate string

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

 Да
EndDate string Окончание бюджетного периода. Да
AutoContinue YesNoEnum Признак автопродления бюджета. Да
Параметр Тип Описание Обязательный
Структура DynamicTextCampaignAddItem
BiddingStrategy DynamicTextCampaignStrategyAdd Стратегия показа. Нет, если указан PackageBiddingStrategy
Settings array of DynamicTextCampaignSetting Массив настроек, допускающих только значения YES или NO. Нет
PlacementTypes array of DynamicTextCampaignPlacementTypes Места показа рекламы на поиске. Нет
CounterIds ArrayOfInteger Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). Нет
PriorityGoals PriorityGoalsArray

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

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

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

 Нет
TrackingParams string

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

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

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

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

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

 Нет
PackageBiddingStrategy DynamicTextCampaignPackageBiddingStrategyAdd

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

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

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

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

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

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

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

 Нет
Структура DynamicTextCampaignSetting
Option DynamicTextCampaignSettingsEnum

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

 Да
Нет
Value YesNoEnum Значение настройки. Да
Структура DynamicTextCampaignPlacementTypes
Type DynamicTextCampaignPlacementTypesEnum

Тип места показа рекламы на поиске:

  • SEARCH_RESULTS — в результатах поиска.
  • PRODUCT_GALLERY — в Товарной галерее.
 Да
Value YesNoEnum Значение настройки. Да
Структура DynamicTextCampaignPackageBiddingStrategyAdd
StrategyId long Идентификатор пакетной стратегии.
StrategyFromCampaignId long Идентификатор кампании, из которой создается пакетная стратегия. Нет
Структура 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
Структура DynamicTextCampaignStrategyAdd
Search DynamicTextCampaignSearchStrategyAdd Стратегия показа на поиске. Да
Network DynamicTextCampaignNetworkStrategyAdd Стратегия показа в сетях. Да
Структура DynamicTextCampaignSearchStrategyAdd
BiddingStrategyType DynamicTextCampaignSearchStrategyTypeEnum

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

 Да
WbMaximumClicks StrategyMaximumClicksAdd Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRate StrategyMaximumConversionRateAdd Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpc StrategyAverageCpcAdd Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpa StrategyAverageCpaAdd Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoi StrategyAverageRoiAdd Параметры стратегии Оптимизация рентабельности. При значении AVERAGE_ROI в параметре BiddingStrategyType
AverageCrr StrategyAverageCrrAdd Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. При значении AVERAGE_CRR в параметре BiddingStrategyType
PayForConversion StrategyPayForConversionAdd Параметры стратегии Оптимизация конверсий, оплата за конверсии. При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType
PayForConversionCrr StrategyPayForConversionCrrAdd Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType
WeeklyClickPackage StrategyWeeklyClickPackageAdd

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

Ограничение.

Параметр устарел и больше не поддерживается.

 При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура DynamicTextCampaignNetworkStrategyAdd
BiddingStrategyType DynamicTextCampaignNetworkStrategyTypeEnum Тип стратегии показа в сетях. Доступно единственное значение: SERVING_OFF. Да
Структура StrategyMaximumClicksAdd
WeeklySpendLimit long

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

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

 Да
BidCeiling long

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

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

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

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

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

 Нет
Структура 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, операция завершится с ошибкой.

 Нет
Структура 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, операция завершится с ошибкой.

 Нет
Структура PayForConversionAdd
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.

 Нет
Структура 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.

Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.
 Нет
Структура ExplorationBudget
MinimumExplorationBudget long

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

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

 Да, если в запросе есть структура ExplorationBudget.
IsMinimumExplorationBudgetCustom YesNoEnum Признак пользовательского значения минимального бюджета. Да, если в запросе есть структура ExplorationBudget.
Структура CustomPeriodBudget
SpendLimit long

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

 Да
StartDate string

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

 Да
EndDate string Окончание бюджетного периода. Да
AutoContinue YesNoEnum Признак автопродления бюджета. Да