update: параметры UnifiedCampaign
Для работы с Единой перфоманс-кампанией используется адрес https://api.direct.yandex.com/v501/
.
Структура запроса в формате JSON:
{
"method": "update",
"params": {
"Campaigns": [{ /* CampaignUpdateItem */
...
"UnifiedCampaign": { /* UnifiedCampaignUpdateItem */
"BiddingStrategy": { /* UnifiedCampaignStrategy */
"Search": { /* UnifiedCampaignSearchStrategy */
"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" )
}
"WbMaximumClicks": { /* StrategyMaximumClicks */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRate */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"GoalId": (long),
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpc": { /* StrategyAverageCpc */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpa": { /* StrategyAverageCpa */
"AverageCpa": (long),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr": { /* StrategyPayForConversionCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversion" : { /* StrategyPayForConversion */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
}
},
"Network": { /* UnifiedCampaignNetworkStrategy */
"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 */
"WbMaximumClicks": { /* StrategyMaximumClicks */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRate */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"GoalId": (long),
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"AverageCpc": { /* StrategyAverageCpc */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpa": { /* StrategyAverageCpa */
"AverageCpa": (long),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr": { /* StrategyPayForConversionCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversion" : { /* StrategyPayForConversion */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
}
}
},
"Settings": [{ /* UnifiedCampaignSetting */
"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": { /* ArrayOfInteger */
"Items": [(int), ... ] /* required */
}, /* nillable */
"PriorityGoals": { /* PriorityGoalsUpdateSetting */
"Items": [{ /* PriorityGoalsUpdateItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"Operation": ( "SET" ), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
}, /* nillable */
"TrackingParams" : (string),
"AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"PackageBiddingStrategy": {
"StrategyId": (long),
"StrategyFromCampaignId": (long),
"Platforms" : {
"SearchResult" : ( "YES" | "NO" ) /* required */,
"ProductGallery" : ( "YES" | "NO" ) /* required */,
"Network" : ( "YES" | "NO" ) /* required */
}
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}
}, ... ] /* required */
}
}
Параметр | Тип | Описание | Обязательный |
Структура UnifiedCampaignUpdateItem | |||
---|---|---|---|
Settings | array of UnifiedCampaignSetting | Массив настроек, допускающих только значения YES или NO. | Нет |
CounterIds | ArrayOfInteger, nillable | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
TrackingParams | string | Параметры URL для шаблонов. | |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
| Нет |
PackageBiddingStrategy | UnifiedCampaignPackageBiddingStrategyUpdate, nillable | Привязывает кампанию к указанной стратегии. При значении Null (nil) отвязывает кампанию от пакетной стратегии, в этом случае обязательно передать новое значение BiddingStrategy. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение BiddingStrategy и сбросьте значение параметра PackageBiddingStrategy: null. | Нет |
BiddingStrategy | UnifiedCampaignStrategy | Стратегия показа. | Нет |
PriorityGoals | PriorityGoalsUpdateSetting, nillable | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. null (nil) — удалить набор ключевых целей. В этом случае автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. | Нет |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. | Нет |
Структура UnifiedCampaignSetting | |||
Option | UnifiedCampaignSettingsEnum | Имя настройки: | Да |
Value | YesNoEnum | Значение настройки. | Да |
Структура PriorityGoalsUpdateSetting | |||
Items | array of PriorityGoalsUpdateItem | Новый набор ключевых целей и ценностей конверсий, которым нужно заменить существующий набор. | Да |
Структура PriorityGoalsUpdateItem | |||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». | Да |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. | Да |
Operation | OperationEnum | Тип действия над набором ключевых целей. В настоящее время доступно только значение SET. | Да |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. | При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура UnifiedCampaignPackageBiddingStrategyUpdate | |||
StrategyId | long | Идентификатор пакетной стратегии. | Нет |
StrategyFromCampaignId | long | Идентификатор кампании, из которой создается пакетная стратегия. | Нет |
Platforms | UnifiedCampaignPlatforms | Платформа размещения рекламы. | Нет |
Структура UnifiedCampaignPlatforms | |||
SearchResult | YesNoEnum | Поисковая выдача. | Да |
ProductGallery | YesNoEnum | Товарная галерея. | Да |
Network | YesNoEnum | Рекламная сеть Яндекса. | Да |
Структура UnifiedCampaignStrategy | |||
Search | UnifiedCampaignSearchStrategy | Стратегия показа на поиске. | Нет |
Network | UnifiedCampaignNetworkStrategy | Стратегия показа в сетях. | Нет |
Структура UnifiedCampaignSearchStrategy | |||
BiddingStrategyType | UnifiedCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
PlacementTypes | UnifiedCampaignSearchStrategyPlacementTypes | Места показов на поиске. | Нет |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpa | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversion | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignNetworkStrategy | |||
BiddingStrategyType | UnifiedCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpa | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversion | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignSearchStrategyPlacementTypes | |||
SearchResults | YesNoEnum | Поисковая выдача. | Нет |
ProductGallery | YesNoEnum | Товарная галерея. | Нет |
Структура StrategyMaximumClicks | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyMaximumConversionRate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpc | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpa | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrr | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionCrr | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyPayForConversion | |||
Cpa | long | Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура ExplorationBudget | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |
Параметр | Тип | Описание | Обязательный |
Структура UnifiedCampaignUpdateItem | |||
---|---|---|---|
Settings | array of UnifiedCampaignSetting | Массив настроек, допускающих только значения YES или NO. | Нет |
CounterIds | ArrayOfInteger, nillable | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
TrackingParams | string | Параметры URL для шаблонов. | |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
| Нет |
PackageBiddingStrategy | UnifiedCampaignPackageBiddingStrategyUpdate, nillable | Привязывает кампанию к указанной стратегии. При значении Null (nil) отвязывает кампанию от пакетной стратегии, в этом случае обязательно передать новое значение BiddingStrategy. При заполнении этого поля нельзя передавать следующие параметры:
Чтобы передавать эти параметры, необходимо отвязать кампанию от пакетной стратегии: укажите новое значение BiddingStrategy и сбросьте значение параметра PackageBiddingStrategy: null. | Нет |
BiddingStrategy | UnifiedCampaignStrategy | Стратегия показа. | Нет |
PriorityGoals | PriorityGoalsUpdateSetting, nillable | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. null (nil) — удалить набор ключевых целей. В этом случае автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. | Нет |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве. Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get. | Нет |
Структура UnifiedCampaignSetting | |||
Option | UnifiedCampaignSettingsEnum | Имя настройки: | Да |
Value | YesNoEnum | Значение настройки. | Да |
Структура PriorityGoalsUpdateSetting | |||
Items | array of PriorityGoalsUpdateItem | Новый набор ключевых целей и ценностей конверсий, которым нужно заменить существующий набор. | Да |
Структура PriorityGoalsUpdateItem | |||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». | Да |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. | Да |
Operation | OperationEnum | Тип действия над набором ключевых целей. В настоящее время доступно только значение SET. | Да |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. | При значении AVERAGE_CRR или PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
Структура UnifiedCampaignPackageBiddingStrategyUpdate | |||
StrategyId | long | Идентификатор пакетной стратегии. | Нет |
StrategyFromCampaignId | long | Идентификатор кампании, из которой создается пакетная стратегия. | Нет |
Platforms | UnifiedCampaignPlatforms | Платформа размещения рекламы. | Нет |
Структура UnifiedCampaignPlatforms | |||
SearchResult | YesNoEnum | Поисковая выдача. | Да |
ProductGallery | YesNoEnum | Товарная галерея. | Да |
Network | YesNoEnum | Рекламная сеть Яндекса. | Да |
Структура UnifiedCampaignStrategy | |||
Search | UnifiedCampaignSearchStrategy | Стратегия показа на поиске. | Нет |
Network | UnifiedCampaignNetworkStrategy | Стратегия показа в сетях. | Нет |
Структура UnifiedCampaignSearchStrategy | |||
BiddingStrategyType | UnifiedCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
PlacementTypes | UnifiedCampaignSearchStrategyPlacementTypes | Места показов на поиске. | Нет |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpa | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversion | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignNetworkStrategy | |||
BiddingStrategyType | UnifiedCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях: О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа. | Да |
WbMaximumClicks | StrategyMaximumClicks | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | При значении WB_MAXIMUM_CLICKS в параметре BiddingStrategyType |
WbMaximumConversionRate | StrategyMaximumConversionRate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | При значении WB_MAXIMUM_CONVERSION_RATE в параметре BiddingStrategyType |
AverageCpc | StrategyAverageCpc | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | При значении AVERAGE_CPC в параметре BiddingStrategyType |
AverageCpa | StrategyAverageCpa | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | При значении AVERAGE_CPA в параметре BiddingStrategyType |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | При значении AVERAGE_CRR в параметре BiddingStrategyType |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | При значении PAY_FOR_CONVERSION_CRR в параметре BiddingStrategyType |
PayForConversion | StrategyPayForConversion | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | При значении PAY_FOR_CONVERSION в параметре BiddingStrategyType |
Структура UnifiedCampaignSearchStrategyPlacementTypes | |||
SearchResults | YesNoEnum | Поисковая выдача. | Нет |
ProductGallery | YesNoEnum | Товарная галерея. | Нет |
Структура StrategyMaximumClicks | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyMaximumConversionRate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
Структура StrategyAverageCpc | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpa | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrr | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionCrr | |||
Crr | int | Средняя доля расходов. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyPayForConversion | |||
Cpa | long | Цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Нет |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты должен быть не менее, чем значение параметра Cpa, умноженное на 20. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура ExplorationBudget | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |