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

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

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

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "DynamicTextCampaign": {  /* DynamicTextCampaignGetItem */
        "BiddingStrategy": {  /* DynamicTextCampaignStrategy */
          "Search": {  /* DynamicTextCampaignSearchStrategy */
            "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": {  /* DynamicTextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "SERVING_OFF" | "UNKNOWN" ) /* required */
          }
        },
        "Settings": [{  /* DynamicTextCampaignSettingGet */
          "Option": ( "ADD_METRICA_TAG" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        } /* nillable */
        
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура DynamicTextCampaignGetItem
Settings array of DynamicTextCampaignSettingGet Массив настроек, допускающих только значения YES или NO.
CounterIds ArrayOfInteger, nillable Идентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве.
BiddingStrategy DynamicTextCampaignStrategy Стратегия показа.
Структура DynamicTextCampaignSettingGet
Option DynamicTextCampaignSettingsGetEnum

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

Value YesNoEnum Значение настройки.
Структура DynamicTextCampaignStrategy
Network DynamicTextCampaignNetworkStrategy Стратегия показа в сетях.
Структура DynamicTextCampaignSearchStrategy
BiddingStrategyType DynamicTextCampaignSearchStrategyTypeEnum

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

WbMaximumClicks StrategyMaximumClicks Параметры стратегии Недельный бюджет (максимум кликов).
WbMaximumConversionRate StrategyMaximumConversionRate Параметры стратегии Недельный бюджет (максимальная конверсия).
AverageCpc StrategyAverageCpc Параметры стратегии Средняя цена клика.
AverageCpa StrategyAverageCpa Параметры стратегии Средняя цена конверсии.
AverageRoi StrategyAverageRoi Параметры стратегии Средняя рентабельность инвестиций.
WeeklyClickPackage StrategyWeeklyClickPackage Параметры стратегии Недельный пакет кликов.
Структура DynamicTextCampaignNetworkStrategy
BiddingStrategyType DynamicTextCampaignNetworkStrategyTypeEnum Тип стратегии показа в сетях. Доступно единственное значение: SERVING_OFF.
Структура 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 long, nillable

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

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

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