update
Запрос
Структура запроса в формате JSON:
"params" : { /* required */
"Strategies" : [{ /* required */
"Id": (long), /* required */
"AttributionModel" : ("LC"|"LSC"|"FC"|"LYDC"|"LSCCD"|"FCCD"|"LYDCCD"),
"Name" : (string) /* required */,
"CounterIds" : {
"Items" : [ (long) ] /* required */
},
"PriorityGoals" : {
"Items" : [{ /* required */
"GoalId" : (long) /* required */,
"Value" : (long) /* required */,
"IsMetrikaSourceOfValue" : ("YES"|"NO")
} ]
},
"WbMaximumClicks" : {
"WeeklySpendLimit" : (long) /* required */,
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long)
},
"WbMaximumConversionRate" : {
"WeeklySpendLimit" : (long) /* required */,
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long),
"GoalId" : (long) /* required */
},
"AverageCpc" : {
"AverageCpc" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpa" : {
"AverageCpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long),
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversion" : {
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpaPerCampaign" : {
"AverageCpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long),
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionPerCampaign" : {
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversionPerFilter" : {
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpaPerFilter" : {
"FilterAverageCpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long),
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCpcPerCampaign" : {
"AverageCpc" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long)
},
"AverageCpcPerFilter" : {
"FilterAverageCpc" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling" : (long)
},
"AverageCrr" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"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" : {
"Crr" : (integer) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
}
} ]
}
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
Strategies | array of StrategiesUpdateItem | Пакетная стратегия | Да |
Структура StrategiesUpdateItem | |||
Id | long | Идентификатор пакетной стратегии. | Да |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
Значение по умолчанию — LYDC. | Нет |
Name | String | Название пакетной стратегии. | Да |
CounterIds | ArrayOfInteger | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
PriorityGoals | PriorityGoalsArray | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. Ограничение — 30 ключевых целей. | Нет |
WbMaximumClicks | StrategyMaximumClicksUpdate | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | Нет |
WbMaximumConversionRate | StrategyMaximumConversionRateUpdate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | Нет |
AverageCpc | StrategyAverageCpcUpdate | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | Нет |
AverageCpa | StrategyAverageCpaUpdate | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | Нет |
AverageCrr | StrategyAverageCrrUpdate | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | Нет |
PayForConversionCrr | StrategyPayForConversionCrrUpdate | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | Нет |
PayForConversion | StrategyPayForConversionUpdate | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | Нет |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaignUpdate | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. | Нет |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaignUpdate | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. | Нет |
PayForConversionPerFilter | StrategyPayForConversionPerFilterUpdate | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. | Нет |
AverageCpaPerFilter | StrategyAverageCpaPerFilterUpdate | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. | Нет |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaignUpdate | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. | Нет |
AverageCpcPerFilter | StrategyAverageCpcPerFilterUpdate | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. | Нет |
Структура 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 |
Структура StrategyMaximumClicksUpdate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyMaximumConversionRateUpdate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
Структура StrategyAverageCpcUpdate | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaUpdate | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrrUpdate | |||
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, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaPerCampaignUpdate | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionPerCampaignUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyPayForConversionPerFilterUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaPerFilterUpdate | |||
FilterAverageCpa | long | Средняя цена достижения цели по умолчанию на каждый фильтр в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCpcPerCampaignUpdate | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyAverageCpcPerFilterUpdate | |||
FilterAverageCpc | long | Да | |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyPayForConversionCrrUpdate | |||
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 | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
Strategies | array of StrategiesUpdateItem | Пакетная стратегия | Да |
Структура StrategiesUpdateItem | |||
Id | long | Идентификатор пакетной стратегии. | Да |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
Значение по умолчанию — LYDC. | Нет |
Name | String | Название пакетной стратегии. | Да |
CounterIds | ArrayOfInteger | Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа). | Нет |
PriorityGoals | PriorityGoalsArray | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. Если массив не задан, автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. Ограничение — 30 ключевых целей. | Нет |
WbMaximumClicks | StrategyMaximumClicksUpdate | Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету. | Нет |
WbMaximumConversionRate | StrategyMaximumConversionRateUpdate | Параметры стратегии Оптимизация конверсий, без указания средней цены конверсии. | Нет |
AverageCpc | StrategyAverageCpcUpdate | Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика. | Нет |
AverageCpa | StrategyAverageCpaUpdate | Параметры стратегии Оптимизация конверсий, удерживать среднюю цену конверсии. | Нет |
AverageCrr | StrategyAverageCrrUpdate | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. | Нет |
PayForConversionCrr | StrategyPayForConversionCrrUpdate | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. | Нет |
PayForConversion | StrategyPayForConversionUpdate | Параметры стратегии Оптимизация конверсий, оплата за конверсии. | Нет |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaignUpdate | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. | Нет |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaignUpdate | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. | Нет |
PayForConversionPerFilter | StrategyPayForConversionPerFilterUpdate | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. | Нет |
AverageCpaPerFilter | StrategyAverageCpaPerFilterUpdate | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. | Нет |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaignUpdate | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. | Нет |
AverageCpcPerFilter | StrategyAverageCpcPerFilterUpdate | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. | Нет |
Структура 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 |
Структура StrategyMaximumClicksUpdate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyMaximumConversionRateUpdate | |||
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
Структура StrategyAverageCpcUpdate | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaUpdate | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCrrUpdate | |||
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, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaPerCampaignUpdate | |||
AverageCpa | long | Средняя цена достижения цели в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyPayForConversionPerCampaignUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyPayForConversionPerFilterUpdate | |||
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. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
Структура StrategyAverageCpaPerFilterUpdate | |||
FilterAverageCpa | long | Средняя цена достижения цели по умолчанию на каждый фильтр в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. Если поле не задано, значение миниального бюджета не изменится. Чтобы установить значение по умолчанию, передайте ExplorationBudget=NULL. Чтобы установить пользовательское значение минимального бюджета, задайте значение в параметре MinimumExplorationBudget и укажите IsMinimumExplorationBudgetCustom="YES". Если IsMinimumExplorationBudgetCustom установлен в NO, операция завершится с ошибкой. | Нет |
Структура StrategyAverageCpcPerCampaignUpdate | |||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Да |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyAverageCpcPerFilterUpdate | |||
FilterAverageCpc | long | Да | |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. | Нет |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. | Нет |
BudgetType | BudgetTypeEnum | Тип бюджета:
Если при редактировании кампании тип бюджета изменился, изначальный тип необходимо передать со значеним NULL. Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL. | Нет |
BidCeiling | long | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. | Нет |
Структура StrategyPayForConversionCrrUpdate | |||
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 | |||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). | Да, если в запросе есть структура ExplorationBudget. |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. | Да, если в запросе есть структура ExplorationBudget. |
Структура CustomPeriodBudget | |||
SpendLimit | long | Значение бюджета на период. | Да |
StartDate | string | Начало бюджетного периода. | Да |
EndDate | string | Окончание бюджетного периода. | Да |
AutoContinue | YesNoEnum | Признак автопродления бюджета. | Да |
Ответ
Структура ответа в формате JSON:
{
"result" : { /* required */
"UpdateResults" : [{
"Warnings" : [{
"Code" : (integer) /* required */,
"Message" : (string) /* required */,
"Details" : (string)
} ],
"Errors" : [{
"Code" : (integer) /* required */,
"Message" : (string) /* required */,
"Details" : (string)
} ],
"Id" : (long)
} ]
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / UpdateResponse (для SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Результаты добавления пакетной стратегии. |
Структура ActionResult | ||
Id | long | Идентификатор созданной пакетной стратегии. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |
Параметр | Тип | Описание |
Структура result (для JSON) / UpdateResponse (для SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Результаты добавления пакетной стратегии. |
Структура ActionResult | ||
Id | long | Идентификатор созданной пакетной стратегии. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |