add: параметры UnifiedCampaign
Для работы с Единой перфоманс-кампанией используется адрес https://api.direct.yandex.com/v501/
.
Структура запроса в формате JSON:
{
"method": "add",
"params": {
"Campaigns": [{ /* CampaignAddItem */
...
"UnifiedCampaign" : {
"BiddingStrategy" : {
"Search" : { /* required */
"WbMaximumClicks" : {
"WeeklySpendLimit" : (long) /* required */,
"BidCeiling" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"WbMaximumConversionRate" : {
"WeeklySpendLimit" : (long) /* required */,
"BidCeiling" : (long),
"GoalId" : (long), /* required */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"AverageCpc" : {
"AverageCpc" : (long) /* required */,
"WeeklySpendLimit" : (long)
},
"AverageCpa" : {
"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"|"NO") /* required */
}
},
"PayForConversion" : {
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCrr" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"|"NO") /* required */
}
},
"PayForConversionCrr" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"HIGHEST_POSITION"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR") /* required */,
"PlacementTypes" : {
"SearchResults" : ("YES"|"NO"),
"ProductGallery" : ("YES"|"NO")
}
},
"Network" : { /* required */
"WbMaximumClicks" : {
"WeeklySpendLimit" : (long) /* required */,
"BidCeiling" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"WbMaximumConversionRate" : {
"WeeklySpendLimit" : (long) /* required */,
"BidCeiling" : (long),
"GoalId" : (long), /* required */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"AverageCpc" : {
"AverageCpc" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpa" : {
"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"|"NO") /* required */
}
},
"PayForConversion" : {
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long)
},
"AverageCrr" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"|"NO") /* required */
}
},
"PayForConversionCrr" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"NETWORK_DEFAULT"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR") /* required */
}
},
"Settings" : [{
"Option" : ("ADD_METRICA_TAG"|"ADD_TO_FAVORITES"|"ENABLE_AREA_OF_INTEREST_TARGETING"|"ENABLE_SITE_MONITORING"|"REQUIRE_SERVICING"|"ENABLE_COMPANY_INFO"|"CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED") /* required */,
"Value" : ("YES"|"NO") /* required */
}, ... ],
"CounterIds" : {
"Items" : [ (integer) ] /* required */
},
"PriorityGoals" : {
"Items" : [{ /* required */
"GoalId" : (long) /* required */,
"Value" : (long) /* required */,
"IsMetrikaSourceOfValue" : ("YES"|"NO")
}, ... ]
},
"TrackingParams" : (string),
"AttributionModel" : ("LC"|"LSC"|"FC"|"LYDC"|"LSCCD"|"FCCD"|"LYDCCD"|"AUTO"),
"PackageBiddingStrategy" : {
"StrategyId" : (long),
"StrategyFromCampaignId" : (long),
"Platforms" : { /* required */
"SearchResult" : ("YES"|"NO") /* required */,
"ProductGallery" : ("YES"|"NO") /* required */,
"Network" : ("YES"|"NO") /* required */
}
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}, ... ] /* required */
}
}
}
Параметр | Тип | Описание | Обязательный |
Структура UnifiedCampaignAddItem | |||
---|---|---|---|
BiddingStrategy | UnifiedCampaignStrategyAdd | Стратегия показа. | Нет, если указан PackageBiddingStrategy |
Settings | array of UnifiedCampaignSetting | Массив настроек, допускающих только значения YES или NO. | Нет |
CounterIds | ArrayOfInteger | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
PriorityGoals | PriorityGoalsArray | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. | Нет |
TrackingParams | string | Параметры URL для шаблонов. | Нет |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
Значение по умолчанию — AUTO. | Нет |
PackageBiddingStrategy | UnifiedCampaignPackageBiddingStrategyAdd | Привязывает кампанию к указанной стратегии. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение BiddingStrategy и сбросьте значение параметра PackageBiddingStrategy: null. | Нет, если указан BiddingStrategy |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. | Нет |
Структура UnifiedCampaignSetting | |||
Option | UnifiedCampaignSettingsEnum | Имя настройки: | Да |
Value | YesNoEnum | Значение настройки. | Да |
Структура UnifiedCampaignPackageBiddingStrategyAdd | |||
StrategyId | long | Идентификатор пакетной стратегии. | Нет |
StrategyFromCampaignId | long | Идентификатор кампании, из которой создается пакетная стратегия. | Нет |
Platforms | UnifiedCampaignPlatforms | Платформа размещения рекламы. | Да |
Структура PriorityGoalsArray | |||
Items | array of PriorityGoalsItem | Набор ключевых целей и ценностей конверсий по ним. | Да |
Структура PriorityGoalsItem | |||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». | Да |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. | Да |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. | При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура UnifiedCampaignPlatforms | |||
SearchResult | YesNoEnum | Поисковая выдача. | Да |
ProductGallery | YesNoEnum | Товарная галерея. | Да |
Network | YesNoEnum | Рекламная сеть Яндекса. | Да |
Структура UnifiedCampaignStrategyAdd | |||
Search | UnifiedCampaignSearchStrategyAdd | Стратегия показа на поиске. | Да |
Network | UnifiedCampaignNetworkStrategyAdd | Стратегия показа в сетях. | Да |
Структура UnifiedCampaignSearchStrategyAdd | |||
BiddingStrategyType | UnifiedCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
PlacementTypes | UnifiedCampaignSearchStrategyPlacementTypes | Места показов на поиске. | Нет |
WbMaximumClicks | StrategyMaximumClicksAdd | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpcAdd | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpaAdd | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversionAdd | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignNetworkStrategyAdd | |||
BiddingStrategyType | UnifiedCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
WbMaximumClicks | StrategyMaximumClicksAdd | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpcAdd | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpaAdd | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversionAdd | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура StrategyMaximumClicksAdd | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура UnifiedCampaignSearchStrategyPlacementTypes | |||
SearchResults | YesNoEnum | Поисковая выдача. | Нет |
ProductGallery | YesNoEnum | Товарная галерея. | Нет |
Структура StrategyMaximumConversionRateAdd | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpcAdd | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpaAdd | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrrAdd | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionAdd | |||
Cpa | long | Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyPayForConversionCrrAdd | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура ExplorationBudget | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |
Параметр | Тип | Описание | Обязательный |
Структура UnifiedCampaignAddItem | |||
---|---|---|---|
BiddingStrategy | UnifiedCampaignStrategyAdd | Стратегия показа. | Нет, если указан PackageBiddingStrategy |
Settings | array of UnifiedCampaignSetting | Массив настроек, допускающих только значения YES или NO. | Нет |
CounterIds | ArrayOfInteger | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
PriorityGoals | PriorityGoalsArray | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. | Нет |
TrackingParams | string | Параметры URL для шаблонов. | Нет |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
Значение по умолчанию — AUTO. | Нет |
PackageBiddingStrategy | UnifiedCampaignPackageBiddingStrategyAdd | Привязывает кампанию к указанной стратегии. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение BiddingStrategy и сбросьте значение параметра PackageBiddingStrategy: null. | Нет, если указан BiddingStrategy |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. | Нет |
Структура UnifiedCampaignSetting | |||
Option | UnifiedCampaignSettingsEnum | Имя настройки: | Да |
Value | YesNoEnum | Значение настройки. | Да |
Структура UnifiedCampaignPackageBiddingStrategyAdd | |||
StrategyId | long | Идентификатор пакетной стратегии. | Нет |
StrategyFromCampaignId | long | Идентификатор кампании, из которой создается пакетная стратегия. | Нет |
Platforms | UnifiedCampaignPlatforms | Платформа размещения рекламы. | Да |
Структура PriorityGoalsArray | |||
Items | array of PriorityGoalsItem | Набор ключевых целей и ценностей конверсий по ним. | Да |
Структура PriorityGoalsItem | |||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». | Да |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. | Да |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. | При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура UnifiedCampaignPlatforms | |||
SearchResult | YesNoEnum | Поисковая выдача. | Да |
ProductGallery | YesNoEnum | Товарная галерея. | Да |
Network | YesNoEnum | Рекламная сеть Яндекса. | Да |
Структура UnifiedCampaignStrategyAdd | |||
Search | UnifiedCampaignSearchStrategyAdd | Стратегия показа на поиске. | Да |
Network | UnifiedCampaignNetworkStrategyAdd | Стратегия показа в сетях. | Да |
Структура UnifiedCampaignSearchStrategyAdd | |||
BiddingStrategyType | UnifiedCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
PlacementTypes | UnifiedCampaignSearchStrategyPlacementTypes | Места показов на поиске. | Нет |
WbMaximumClicks | StrategyMaximumClicksAdd | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpcAdd | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpaAdd | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversionAdd | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignNetworkStrategyAdd | |||
BiddingStrategyType | UnifiedCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
WbMaximumClicks | StrategyMaximumClicksAdd | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpcAdd | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpaAdd | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversionAdd | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура StrategyMaximumClicksAdd | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура UnifiedCampaignSearchStrategyPlacementTypes | |||
SearchResults | YesNoEnum | Поисковая выдача. | Нет |
ProductGallery | YesNoEnum | Товарная галерея. | Нет |
Структура StrategyMaximumConversionRateAdd | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpcAdd | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpaAdd | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrrAdd | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionAdd | |||
Cpa | long | Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyPayForConversionCrrAdd | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура ExplorationBudget | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |