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
BiddingStrategyTextCampaignStrategyAddСтратегия показа.Да
Settingsarray of TextCampaignSettingМассив настроек, допускающих только значения YES или NO.Нет
CounterIdsArrayOfIntegerИдентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве.Нет
RelevantKeywordsRelevantKeywordsSettingAddНастройки показов по дополнительным релевантным фразам (см. раздел Показы по дополнительным релевантным фразам помощи Директа). Если структура не задана, показы по дополнительным релевантным фразам отключены.Нет
Структура TextCampaignSetting
OptionTextCampaignSettingsEnum

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

Да
ValueYesNoEnumЗначение настройки.Да
Структура RelevantKeywordsSettingAdd
BudgetPercentint

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

Да
OptimizeGoalIdlong, nillable

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

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

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

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

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

Нет
Структура TextCampaignStrategyAdd
NetworkTextCampaignNetworkStrategyAddСтратегия показа в сетях.Да
Структура TextCampaignSearchStrategyAdd
BiddingStrategyTypeTextCampaignSearchStrategyTypeEnum

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

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

Да
WbMaximumClicksStrategyMaximumClicksAddПараметры стратегии Недельный бюджет (максимум кликов).При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRateStrategyMaximumConversionRateAddПараметры стратегии Недельный бюджет (максимальная конверсия).При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpcStrategyAverageCpcAddПараметры стратегии Средняя цена клика.При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpaStrategyAverageCpaAddПараметры стратегии Средняя цена конверсии.При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoiStrategyAverageRoiAddПараметры стратегии Средняя рентабельность инвестиций.При значении AVERAGE_ROI в параметре BiddingStrategyType
WeeklyClickPackageStrategyWeeklyClickPackageAddПараметры стратегии Недельный пакет кликов.При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура TextCampaignNetworkStrategyAdd
BiddingStrategyTypeTextCampaignNetworkStrategyTypeEnum

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

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

Да
NetworkDefaultStrategyNetworkDefaultAddПараметры стратегии «Ручное управление ставками с оптимизацией в сетях» (ставка в сети устанавливается в зависимости от ставки на поиске).При значении NETWORK_DEFAULT в параметре BiddingStrategyType
WbMaximumClicksStrategyMaximumClicksAddПараметры стратегии Недельный бюджет (максимум кликов).При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRateStrategyMaximumConversionRateAddПараметры стратегии Недельный бюджет (максимальная конверсия).При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpcStrategyAverageCpcAddПараметры стратегии Средняя цена клика.При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpaStrategyAverageCpaAddПараметры стратегии Средняя цена конверсии.При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoiStrategyAverageRoiAddПараметры стратегии Средняя рентабельность инвестиций.При значении AVERAGE_ROI в параметре BiddingStrategyType
WeeklyClickPackageStrategyWeeklyClickPackageAddПараметры стратегии Недельный пакет кликов.При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура StrategyMaximumClicksAdd
WeeklySpendLimitlong

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

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

Да
BidCeilinglong

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

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

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

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

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

Да
BidCeilinglong

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

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

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

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

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

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

Да
Структура StrategyAverageCpcAdd
AverageCpclong

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

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

Да
WeeklySpendLimitlong

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

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

Нет
Структура StrategyAverageCpaAdd
AverageCpalong

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

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

Да
WeeklySpendLimitlong

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

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

Нет
GoalIdlong

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

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

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

Да
BidCeilinglong

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

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

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

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

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

Да
RoiCoeflong

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

Да
GoalIdlong

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

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

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

Да
WeeklySpendLimitlong

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

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

Нет
BidCeilinglong

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

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

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

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

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

Нет
Структура StrategyWeeklyClickPackageAdd
ClicksPerWeeklongТребуемое количество кликов в неделю.Да
AverageCpclong

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

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

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

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

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

Примечание. Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба.
Нет
Структура StrategyNetworkDefaultAdd
LimitPercentintМаксимальный процент бюджета, расходуемый на показы в сетях. Значение кратно десяти: 10, 20, ..., 100. Значение по умолчанию — 100.Нет
BidPercentintОграничение ставки в сетях. Задается в процентах от ставки на поиске. Значение кратно десяти: 10, 20, ..., 100. Значение 100 делает ставку в сетях равной цене на поиске. Значение по умолчанию — 100.Нет