add: параметры DynamicTextCampaign
Структура запроса в формате JSON:
{
"method": "add",
"params": {
"Campaigns": [{ /* CampaignAddItem */
...
"DynamicTextCampaign": { /* DynamicTextCampaignAddItem */
"BiddingStrategy": { /* DynamicTextCampaignStrategyAdd */
"Search": { /* DynamicTextCampaignSearchStrategyAdd */
"BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"PlacementTypes" : {
"SearchResults" : ( "YES" | "NO" ),
"ProductGallery" : ( "YES" | "NO" ),
"DynamicPlaces" : ( "YES" | "NO" )
},
"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 |
|||
|
|
DynamicTextCampaignStrategyAdd |
Стратегия показа. |
Нет, если указан PackageBiddingStrategy |
|
|
array of DynamicTextCampaignSetting |
Массив настроек, допускающих только значения YES или NO. |
Нет |
|
|
array of DynamicTextCampaignPlacementTypes |
Места показа рекламы на поиске. Примечание При создании кампании тип размещения "Динамические места на поиске" принимает такое же значение, что и тип "Поисковая выдача" (поле |
Нет |
|
|
ArrayOfInteger |
Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). |
Нет |
|
|
PriorityGoalsArray |
Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. Ограничение — 30 ключевых целей. |
Нет |
|
|
string |
Параметры URL для шаблонов. |
|
|
|
AttributionModelEnum |
Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции). Возможные значения:
Значение по умолчанию — AUTO. |
Нет |
|
|
DynamicTextCampaignPackageBiddingStrategyAdd |
Привязывает кампанию к указанной стратегии. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение |
Нет, если указан BiddingStrategy |
|
|
ArrayOfLong, nillable |
Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. |
Нет |
|
Структура DynamicTextCampaignSetting |
|||
|
|
DynamicTextCampaignSettingsEnum |
Имя настройки:
|
Да |
|
Нет |
||
|
|
YesNoEnum |
Значение настройки. |
Да |
|
Структура DynamicTextCampaignPlacementTypes |
|||
|
|
DynamicTextCampaignPlacementTypesEnum |
Тип места показа рекламы на поиске:
|
Да |
|
|
YesNoEnum |
Значение настройки. |
Да |
|
Структура DynamicTextCampaignPackageBiddingStrategyAdd |
|||
|
|
long |
Идентификатор пакетной стратегии. |
|
|
|
long |
Идентификатор кампании, из которой создается пакетная стратегия. |
Нет |
|
Структура PriorityGoalsArray |
|||
|
|
array of PriorityGoalsItem |
Набор ключевых целей и ценностей конверсий по ним. |
Да |
|
Структура PriorityGoalsItem |
|||
|
|
long |
Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели “Вовлеченные сессии”. |
Да |
|
|
long |
Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. |
Да |
|
|
YesNoEnum |
Источник ценности ключевой цели — цель Метрики. Значение |
При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
|
Структура DynamicTextCampaignStrategyAdd |
|||
|
|
Стратегия показа на поиске. |
Да |
|
|
|
Стратегия показа в сетях. |
Да |
|
|
Структура DynamicTextCampaignSearchStrategyAdd |
|||
|
|
DynamicTextCampaignSearchStrategyTypeEnum |
Тип стратегии показа на поиске:
|
Да |
|
|
DynamicTextCampaignSearchStrategyPlacementTypes |
Места показов на поиске. |
Нет |
|
|
StrategyMaximumClicksAdd |
Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
При значении WB_MAXIMUM_CLICKS в параметре |
|
|
StrategyMaximumConversionRateAdd |
Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. |
При значении WB_MAXIMUM_CONVERSION_RATE в параметре |
|
|
StrategyAverageCpcAdd |
Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
При значении AVERAGE_CPC в параметре |
|
|
StrategyAverageCpaAdd |
Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. |
При значении AVERAGE_CPA в параметре |
|
|
StrategyAverageRoiAdd |
Параметры стратегии Оптимизация рентабельности. |
При значении AVERAGE_ROI в параметре |
|
|
StrategyAverageCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
При значении AVERAGE_CRR в параметре |
|
|
StrategyPayForConversionAdd |
Параметры стратегии Оптимизация конверсий, оплата за конверсии. |
При значении PAY_FOR_CONVERSION в параметре |
|
|
StrategyPayForConversionCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
При значении PAY_FOR_CONVERSION_CRR в параметре |
|
|
StrategyWeeklyClickPackageAdd |
Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов. |
При значении WEEKLY_CLICK_PACKAGE в параметре |
|
Структура DynamicTextCampaignNetworkStrategyAdd |
|||
|
|
DynamicTextCampaignNetworkStrategyTypeEnum |
Тип стратегии показа в сетях. Доступно единственное значение: SERVING_OFF. |
Да |
|
Структура DynamicTextCampaignSearchStrategyPlacementTypes |
|||
|
|
YesNoEnum |
Поисковая выдача. |
Нет |
|
|
YesNoEnum |
Товарная галерея. |
Нет |
|
|
YesNoEnum |
Динамические места на поиске. |
Нет |
|
Структура StrategyMaximumClicksAdd |
|||
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
Структура StrategyMaximumConversionRateAdd |
|||
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
Структура StrategyAverageCpcAdd |
|||
|
|
long |
Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
Структура StrategyAverageCpaAdd |
|||
|
|
long |
Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
|
ExplorationBudget |
Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре Если |
Нет |
|
Структура StrategyAverageRoiAdd |
|||
|
|
int |
Максимальный процент сэкономленных средств, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра Значение от 0 до 100, кратное десяти: 0, 10, 20... 100. |
Да |
|
|
long |
Желаемая средняя рентабельность инвестиций за неделю. Значение представляет собой отношение прибыли от продаж к расходам на рекламу, умноженное на 1 000 000. Значение должно быть целым числом. Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
Да |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
|
long |
Процент выручки, являющийся себестоимостью товаров или услуг. Значение представляет собой процент, умноженный на 1 000 000. Значение должно быть целым числом от 0 до 100 000 000 (что соответствует 100%). Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
Нет |
|
|
ExplorationBudget |
Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре Если |
Нет |
|
Структура StrategyAverageCrrAdd |
|||
|
|
int |
Средняя доля расходов. |
Да |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
|
ExplorationBudget |
Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре Если |
Нет |
|
Структура PayForConversionAdd |
|||
|
|
long |
Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
Структура StrategyPayForConversionCrrAdd |
|||
|
|
int |
Средняя доля расходов. |
Да |
|
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
Структура StrategyWeeklyClickPackageAdd |
|||
|
|
long |
Требуемое количество кликов в неделю. |
Да |
|
|
long |
Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Параметры |
Нет |
|
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
Структура ExplorationBudget |
|||
|
|
long |
Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). |
Да, если в запросе есть структура |
|
|
YesNoEnum |
Признак пользовательского значения минимального бюджета. |
Да, если в запросе есть структура |
|
Структура CustomPeriodBudget |
|||
|
|
long |
Значение бюджета на период. |
Да |
|
|
string |
Начало бюджетного периода. |
Да |
|
|
string |
Окончание бюджетного периода. |
Да |
|
|
YesNoEnum |
Признак автопродления бюджета. |
Да |