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),
"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),
"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"),
"DynamicPlaces" : ( "YES" | "NO" ),
"Maps" : ("YES"|"NO"),
"SearchOrganizationList" : ("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 */,
"PlacementTypes" : {
"Network" : ("YES"|"NO"),
"Maps" : ("YES"|"NO")
}
}
},
"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"| "ALTERNATIVE_TEXTS_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 */,
"Maps" : ("YES"|"NO"),
"SearchOrganizationList" : ("YES"|"NO"),
"Network" : ("YES"|"NO") /* required */,
"DynamicPlaces" : ( "YES" | "NO" )
}
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}, ... ] /* required */
}
}
}
Параметр |
Тип |
Описание |
Обязательный |
Структура UnifiedCampaignAddItem |
|||
|
UnifiedCampaignStrategyAdd |
Стратегия показа. |
Нет, если указан PackageBiddingStrategy |
|
array of UnifiedCampaignSetting |
Массив настроек, допускающих только значения YES или NO. |
Нет |
|
ArrayOfInteger |
Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). |
Нет |
|
PriorityGoalsArray |
Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. |
Нет |
|
string |
Параметры URL для шаблонов. |
Нет |
|
AttributionModelEnum |
Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции). Возможные значения:
Значение по умолчанию — AUTO. |
Нет |
|
UnifiedCampaignPackageBiddingStrategyAdd |
Привязывает кампанию к указанной стратегии. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение |
Нет, если указан BiddingStrategy |
|
ArrayOfLong, nillable |
Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. |
Нет |
Структура UnifiedCampaignSetting |
|||
|
UnifiedCampaignSettingsEnum |
Имя настройки:
|
Да |
|
YesNoEnum |
Значение настройки. |
Да |
Структура UnifiedCampaignPackageBiddingStrategyAdd |
|||
|
long |
Идентификатор пакетной стратегии. |
Нет |
|
long |
Идентификатор кампании, из которой создается пакетная стратегия. |
Нет |
|
UnifiedCampaignPlatforms |
Платформа размещения рекламы. |
Да |
Структура PriorityGoalsArray |
|||
|
array of PriorityGoalsItem |
Набор ключевых целей и ценностей конверсий по ним. |
Да |
Структура PriorityGoalsItem |
|||
|
long |
Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели “Вовлеченные сессии”. |
Да |
|
long |
Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. |
Да |
|
YesNoEnum |
Источник ценности ключевой цели — цель Метрики. Значение |
При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура UnifiedCampaignPlatforms |
|||
|
YesNoEnum |
Поисковая выдача. |
Да |
|
YesNoEnum |
Товарная галерея. |
Да |
|
YesNoEnum |
Яндекс Карты. |
Нет |
|
YesNoEnum |
Список организаций в результатах поиска. |
Нет |
|
YesNoEnum |
Рекламная сеть Яндекса. |
Да |
|
YesNoEnum |
Динамические места на поиске. |
Нет |
Структура UnifiedCampaignStrategyAdd |
|||
|
UnifiedCampaignSearchStrategyAdd |
Стратегия показа на поиске. |
Да |
|
UnifiedCampaignNetworkStrategyAdd |
Стратегия показа в сетях. |
Да |
Структура UnifiedCampaignSearchStrategyAdd |
|||
|
UnifiedCampaignSearchStrategyTypeEnum |
Тип стратегии показа на поиске:
О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. |
Да |
|
UnifiedCampaignSearchStrategyPlacementTypes |
Места показов на поиске. Примечание При создании кампании тип размещения "Динамические места на поиске" принимает такое же значение, что и тип "Поисковая выдача" (поле |
Нет |
|
StrategyMaximumClicksAdd |
Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
При значении WB_MAXIMUM_CLICKS в параметре |
|
StrategyMaximumConversionRateAdd |
Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. |
При значении WB_MAXIMUM_CONVERSION_RATE в параметре |
|
StrategyAverageCpcAdd |
Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
При значении AVERAGE_CPC в параметре |
|
StrategyAverageCpaAdd |
Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. |
При значении AVERAGE_CPA в параметре |
|
StrategyAverageCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
При значении AVERAGE_CRR в параметре |
|
StrategyPayForConversionCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
При значении PAY_FOR_CONVERSION_CRR в параметре |
|
StrategyPayForConversionAdd |
Параметры стратегии Оптимизация конверсий, оплата за конверсии. |
При значении PAY_FOR_CONVERSION в параметре |
Структура UnifiedCampaignNetworkStrategyAdd |
|||
|
UnifiedCampaignNetworkStrategyTypeEnum |
Тип стратегии показа в сетях:
О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. |
Да |
|
UnifiedCampaignNetworkStrategyPlacementTypes |
Места показов в сетях. |
Нет |
|
StrategyMaximumClicksAdd |
Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. |
При значении WB_MAXIMUM_CLICKS в параметре |
|
StrategyMaximumConversionRateAdd |
Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. |
При значении WB_MAXIMUM_CONVERSION_RATE в параметре |
|
StrategyAverageCpcAdd |
Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. |
При значении AVERAGE_CPC в параметре |
|
StrategyAverageCpaAdd |
Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. |
При значении AVERAGE_CPA в параметре |
|
StrategyAverageCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
При значении AVERAGE_CRR в параметре |
|
StrategyPayForConversionAdd |
Параметры стратегии Оптимизация конверсий, оплата за конверсии. |
При значении PAY_FOR_CONVERSION в параметре |
|
StrategyPayForConversionCrrAdd |
Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
При значении PAY_FOR_CONVERSION_CRR в параметре |
UnifiedCampaignNetworkStrategyPlacementTypes |
|||
|
YesNoEnum |
Cети. |
Нет |
|
YesNoEnum |
Яндекс Карты. |
При наличии непустого значения в параметре |
Структура StrategyMaximumClicksAdd |
|||
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
Структура UnifiedCampaignSearchStrategyPlacementTypes |
|||
|
YesNoEnum |
Поисковая выдача. |
Нет |
|
YesNoEnum |
Товарная галерея. |
Нет |
|
YesNoEnum |
Динамические места на поиске. |
Нет |
|
YesNoEnum |
Яндекс Карты. |
При наличии непустого значения в параметре |
|
YesNoEnum |
Список организаций в результатах поиска. |
Нет |
Структура StrategyMaximumConversionRateAdd |
|||
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Да |
|
long |
Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Нет |
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода 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 |
Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре Если |
Нет |
Структура StrategyAverageCrrAdd |
|||
|
int |
Средняя доля расходов. |
Да |
|
long |
Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
Да |
|
long |
Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
Нет |
|
CustomPeriodBudget |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
|
ExplorationBudget |
Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, для стратегии устанавливается значение по умолчанию (рассчитывается на основе настроек стратегии). Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре Если |
Нет |
Структура StrategyPayForConversionAdd |
|||
|
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 |
Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с |
Нет |
Структура ExplorationBudget |
|||
|
long |
Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). |
Да, если в запросе есть структура |
|
YesNoEnum |
Признак пользовательского значения минимального бюджета. |
Да, если в запросе есть структура |
Структура CustomPeriodBudget |
|||
|
long |
Значение бюджета на период. |
Да |
|
string |
Начало бюджетного периода. |
Да |
|
string |
Окончание бюджетного периода. |
Да |
|
YesNoEnum |
Признак автопродления бюджета. |
Да |