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

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

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

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "TextCampaign": {  /* TextCampaignUpdateItem */
        "BiddingStrategy": {  /* TextCampaignStrategy */
          "Search": {  /* TextCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long) /* nillable */
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            }
          }, 
          "Network": {  /* TextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefault */
              "LimitPercent": (int),
              "BidPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long) /* nillable */
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            }
          } 
        },
        "Settings": [{  /* TextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "RelevantKeywords": {  /* RelevantKeywordsSetting */
          "BudgetPercent": (int),
          "OptimizeGoalId": (long) /* nillable */
        }, /* nillable */
        "PriorityGoals": { /* PriorityGoalsUpdateSetting */
          "Items": [{ /* PriorityGoalsUpdateItem */
            "GoalId": (long), /* required */
            "Value": (long), /* required */ 
            "Operation": ( "SET" ) /* required */
          }, ... ] /* required */
        } /* nillable */
      }
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обязательный
Структура TextCampaignUpdateItem
Settings array of TextCampaignSetting Массив настроек, допускающих только значения YES или NO. Нет
CounterIds ArrayOfInteger, nillable Идентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве. Нет
RelevantKeywords RelevantKeywordsSetting, nillable

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

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

Нет
BiddingStrategy TextCampaignStrategy Стратегия показа. Нет
PriorityGoals PriorityGoalsUpdateSetting, nillable

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

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

Нет
Структура TextCampaignSetting
Option TextCampaignSettingsEnum

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

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

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

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

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

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

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

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

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

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

Внимание. Если в кампании выбрана стратегия WB_MAXIMUM_CONVERSION_RATE, AVERAGE_CPA или AVERAGE_ROI, то независимо от значения параметра OptimizeGoalId оптимизация осуществляется по цели (или всем целям), указанной в параметре GoalId в настройках стратегии.
Нет
Структура PriorityGoalsUpdateSetting
Items array of PriorityGoalsUpdateItem Новый набор ключевых целей и ценностей конверсий, которым нужно заменить существующий набор. Да
Структура PriorityGoalsUpdateItem
GoalId long

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

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

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

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

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

Да
Структура TextCampaignStrategy
Network TextCampaignNetworkStrategy Стратегия показа в сетях. Нет
Структура TextCampaignSearchStrategy
BiddingStrategyType TextCampaignSearchStrategyTypeEnum

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

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

Да
WbMaximumClicks StrategyMaximumClicks Параметры стратегии Недельный бюджет (максимум кликов). При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRate StrategyMaximumConversionRate Параметры стратегии Недельный бюджет (максимальная конверсия). При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpc StrategyAverageCpc Параметры стратегии Средняя цена клика. При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpa StrategyAverageCpa Параметры стратегии Средняя цена конверсии. При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoi StrategyAverageRoi Параметры стратегии Средняя рентабельность инвестиций. При значении AVERAGE_ROI в параметре BiddingStrategyType
WeeklyClickPackage StrategyWeeklyClickPackage Параметры стратегии Недельный пакет кликов. При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура TextCampaignNetworkStrategy
BiddingStrategyType TextCampaignNetworkStrategyTypeEnum

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

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

Да
NetworkDefault StrategyNetworkDefault

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

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

При значении NETWORK_DEFAULT в параметре BiddingStrategyType
WbMaximumClicks StrategyMaximumClicks Параметры стратегии Недельный бюджет (максимум кликов). При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType
WbMaximumConversionRate StrategyMaximumConversionRate Параметры стратегии Недельный бюджет (максимальная конверсия). При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType
AverageCpc StrategyAverageCpc Параметры стратегии Средняя цена клика. При значении AVERAGE_CPC в параметре BiddingStrategyType
AverageCpa StrategyAverageCpa Параметры стратегии Средняя цена конверсии. При значении AVERAGE_CPA в параметре BiddingStrategyType
AverageRoi StrategyAverageRoi Параметры стратегии Средняя рентабельность инвестиций. При значении AVERAGE_ROI в параметре BiddingStrategyType
WeeklyClickPackage StrategyWeeklyClickPackage Параметры стратегии Недельный пакет кликов. При значении WEEKLY_CLICK_PACKAGE в параметре BiddingStrategyType
Структура StrategyMaximumClicks
WeeklySpendLimit long

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

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

Нет
BidCeiling long, nillable

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

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

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

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

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

Нет
BidCeiling long, nillable

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

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

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

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

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

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

Нет
Структура StrategyAverageCpc
AverageCpc long

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

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

Нет
WeeklySpendLimit long, nillable

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

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

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

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

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

Нет
GoalId long

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

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

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

Нет
WeeklySpendLimit long, nillable

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

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

Нет
BidCeiling long, nillable

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

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

Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.
Нет
Структура StrategyAverageRoi
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, nillable

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

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

Нет
BidCeiling long, nillable

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

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

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

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

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

Нет
Структура StrategyWeeklyClickPackage
ClicksPerWeek long Требуемое количество кликов в неделю. Нет
AverageCpc long, nillable

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

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

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

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

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

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

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

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

Нет
BidPercent int

Ограничение ставки в сетях. Задается в процентах от ставки на поиске. Значение кратно десяти: 10, 20, ..., 100. Значение 100 делает ставку в сетях равной цене на поиске. Значение по умолчанию — 100.

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

Нет