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

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

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

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "TextCampaign": {  /* TextCampaignAddItem */
        "BiddingStrategy": {  /* TextCampaignStrategyAdd */
          "Search": {  /* TextCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long) /* required */
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long)
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            }
          }, /* required */
          "Network": {  /* TextCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
              "LimitPercent": (int),
              "BidPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long) /* required */
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long)
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            }
          } /* 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 */
        }
      }
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обязательный
Структура TextCampaignAddItem
BiddingStrategy TextCampaignStrategyAdd Стратегия показа. Да
Settings array of TextCampaignSetting Массив настроек, допускающих только значения YES или NO. Нет
CounterIds ArrayOfInteger Идентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве. Нет
RelevantKeywords RelevantKeywordsSettingAdd Настройки показов по дополнительным релевантным фразам (см. раздел Показы по дополнительным релевантным фразам помощи Директа). Если структура не задана, показы по дополнительным релевантным фразам отключены. Нет
Структура TextCampaignSetting
Option TextCampaignSettingsEnum

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

Да
Value YesNoEnum Значение настройки. Да
Структура RelevantKeywordsSettingAdd
BudgetPercent int

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

Да
OptimizeGoalId long, nillable

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

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

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

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

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

Нет
Структура TextCampaignStrategyAdd
Network TextCampaignNetworkStrategyAdd Стратегия показа в сетях. Да
Структура TextCampaignSearchStrategyAdd
BiddingStrategyType TextCampaignSearchStrategyTypeEnum

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

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

Да
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
WeeklyClickPackage StrategyWeeklyClickPackageAdd Параметры стратегии Недельный пакет кликов. При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура TextCampaignNetworkStrategyAdd
BiddingStrategyType TextCampaignNetworkStrategyTypeEnum

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

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

Да
NetworkDefault StrategyNetworkDefaultAdd Параметры стратегии «Ручное управление ставками с оптимизацией в сетях» (ставка в сети устанавливается в зависимости от ставки на поиске). При значении 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
AverageRoi StrategyAverageRoiAdd Параметры стратегии Средняя рентабельность инвестиций. При значении AVERAGE_ROI в параметре BiddingStrategyType
WeeklyClickPackage StrategyWeeklyClickPackageAdd Параметры стратегии Недельный пакет кликов. При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура StrategyMaximumClicksAdd
WeeklySpendLimit long

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

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

Да
BidCeiling long

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

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

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

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

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

Да
BidCeiling long

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

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

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

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

Значение 0 — все цели, настроенные на сайте (кроме составных).

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

Да
Структура StrategyAverageCpcAdd
AverageCpc long

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

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

Да
WeeklySpendLimit long

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

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

Нет
Структура StrategyAverageCpaAdd
AverageCpa long

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

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

Да
WeeklySpendLimit long

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

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

Нет
GoalId long

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

Значение 0 — все цели, настроенные на сайте (кроме составных).

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

Да
BidCeiling long

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

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

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

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

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

Да
RoiCoef long

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

Да
GoalId long

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

Значение 0 — все цели, настроенные на сайте (кроме составных).

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

Да
WeeklySpendLimit long

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

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

Нет
BidCeiling long

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

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

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

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

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

Нет
Структура 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. Нет
BidPercent int Ограничение ставки в сетях. Задается в процентах от ставки на поиске. Значение кратно десяти: 10, 20, ..., 100. Значение 100 делает ставку в сетях равной цене на поиске. Значение по умолчанию — 100. Нет