get: параметры SmartCampaign
Структура ответа в формате JSON:
{
"result": {
"Campaigns": [{ /* CampaignGetItem */
...
"SmartCampaign": { /* SmartCampaignGetItem */
"CounterId": (long),
"TrackingParams" : (string),
"AttributionModel": ( "LC" | "LSC" | "FC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"BiddingStrategy": { /* SmartCampaignStrategy */
"Search": { /* SmartCampaignSearchStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"BidCeiling": (long) /* nillable */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"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) /* nillable */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"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" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (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" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"AverageRoi": { /* StrategyAverageRoi */
"ReserveReturn": (int),
"RoiCoef": (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 */
"Profitability": (long), /* nillable */
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"PayForConversionCrr": { /* 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 */
},
"AverageCrr": { /* 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 */
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"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 */
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"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": { /* SmartCampaignNetworkStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (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 */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"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) /* nillable */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"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" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (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" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"AverageRoi": { /* StrategyAverageRoi */
"ReserveReturn": (int),
"RoiCoef": (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 */
"Profitability": (long), /* nillable */
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* 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" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
}
},
"PayForConversionCrr": { /* 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 */
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"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 */
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"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": [{ /* SmartCampaignSettingGet */
"Option": ( "ADD_TO_FAVORITES" | "REQUIRE_SERVICING" | "SHARED_ACCOUNT_ENABLED" | "DAILY_BUDGET_ALLOWED" | "ENABLE_AREA_OF_INTEREST_TARGETING" ) /* required */,
"Value" : ("YES"|"NO") /* required */
}, ... ],
"PriorityGoals": { /* PriorityGoalsArray */
"Items": [{ /* PriorityGoalsItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
}, /* nillable */
"PackageBiddingStrategy" : { /* nillable */
"StrategyId" : (long), /* required */
"Platforms" : { /* required */
"Search" : ( "YES" | "NO" ) /* required */,
"Network" : ( "YES"| "NO" ) /* required */
}
},
"CanBeUsedAsPackageBiddingStrategySource" : ( "YES" | "NO" )
}
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура SmartCampaignGetItem | ||
---|---|---|
CounterId | long | Идентификатор счетчика Яндекс Метрики, установленного на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). |
TrackingParams | string | Параметры URL для шаблонов. |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
|
BiddingStrategy | SmartCampaignStrategy | Стратегия показа. |
Settings | array of SmartCampaignSettingGet | Массив настроек, допускающих только значения YES или NO. |
PriorityGoals | PriorityGoalsArray, nillable | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. null (nil) — удалить набор ключевых целей. В этом случае автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. Ограничение — 30 ключевых целей. |
PackageBiddingStrategy | SmartCampaignPackageBiddingStrategyGet, nillable | Информация о пакетной стратегии. Null (nil) – кампания не находится в составе пакетной стратегии. |
CanBeUsedAsPackageBiddingStrategySource | string | Показывает, может ли стратегия этой кампании быть пакетной. |
Структура SmartCampaignSettingGet | ||
Option | SmartCampaignSettingsGetEnum | Имя настройки: |
Value | YesNoEnum | Значение настройки. |
Структура PriorityGoalsArray | ||
Items | array of PriorityGoalsItem | Набор ключевых целей и ценностей конверсий по ним. |
Структура SmartCampaignPackageBiddingStrategyGet | ||
StrategyId | long | Идентификатор пакетной стратегии. |
Platforms | SmartCampaignPlatforms | Платформа размещения рекламы. |
Структура SmartCampaignPlatforms | ||
Search | YesNoEnum | Поисковая выдача. |
Network | YesNoEnum | Рекламная сеть Яндекса. |
Структура PriorityGoalsItem | ||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. |
Структура SmartCampaignStrategy | ||
Search | SmartCampaignSearchStrategy | Стратегия показа на поиске. |
Network | SmartCampaignNetworkStrategy | Стратегия показа в сетях. |
Структура SmartCampaignSearchStrategy | ||
BiddingStrategyType | SmartCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. |
AverageRoi | StrategyAverageRoi | Параметры стратегии Оптимизация рентабельности. |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии на каждый фильтр. |
Структура SmartCampaignNetworkStrategy | ||
BiddingStrategyType | SmartCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях:
|
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. |
AverageRoi | StrategyAverageRoi | Параметры стратегии Оптимизация рентабельности. |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
PayForConversionPerCampaign | PayForConversionPerCampaign | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. |
PayForConversionPerFilter | PayForConversionPerFilter | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии на каждый фильтр. |
Структура StrategyAverageCpaPerCampaign | ||
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 | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCpaPerFilter | ||
FilterAverageCpa | 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 | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCpcPerCampaign | ||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageCpcPerFilter | ||
FilterAverageCpc | long | |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageRoi | ||
ReserveReturn | int | Максимальный процент сэкономленных средств, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра RoiCoef. Значение от 0 до 100, кратное десяти: 0, 10, 20... 100. |
RoiCoef | long | Желаемая средняя рентабельность инвестиций за неделю. Значение представляет собой отношение прибыли от продаж к расходам на рекламу, умноженное на 1 000 000. Значение должно быть целым числом. Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Profitability | long, nillable | Процент выручки, являющийся себестоимостью товаров или услуг. Значение представляет собой процент, умноженный на 1 000 000. Значение должно быть целым числом от 0 до 100 000 000 (что соответствует 100%). Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCrr | ||
Crr | int | Средняя доля расходов. |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyPayForConversionCrr | ||
Crr | int | Средняя доля расходов. |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyPayForConversionPerCampaign | ||
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 | Тип бюджета:
|
Структура StrategyPayForConversionPerFilter | ||
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 | Тип бюджета:
|
Структура ExplorationBudget | ||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. |
Структура CustomPeriodBudget | ||
SpendLimit | long | Значение бюджета на период. |
StartDate | string | Начало бюджетного периода. |
EndDate | string | Окончание бюджетного периода. |
AutoContinue | YesNoEnum | Признак автопродления бюджета. |
Параметр | Тип | Описание |
Структура SmartCampaignGetItem | ||
---|---|---|
CounterId | long | Идентификатор счетчика Яндекс Метрики, установленного на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). |
TrackingParams | string | Параметры URL для шаблонов. |
AttributionModel | AttributionModelEnum | Модель атрибуции, используемая для оптимизации конверсий (см. раздел Модели атрибуции помощи Директа). Возможные значения:
|
BiddingStrategy | SmartCampaignStrategy | Стратегия показа. |
Settings | array of SmartCampaignSettingGet | Массив настроек, допускающих только значения YES или NO. |
PriorityGoals | PriorityGoalsArray, nillable | Ключевые цели, на достижение которых направлена автоматическая корректировка ставок. null (nil) — удалить набор ключевых целей. В этом случае автоматическая корректировка направлена на получение максимального количества вовлеченных сессий, см. раздел Показатели вовлеченных сессий помощи Директа. Ограничение — 30 ключевых целей. |
PackageBiddingStrategy | SmartCampaignPackageBiddingStrategyGet, nillable | Информация о пакетной стратегии. Null (nil) – кампания не находится в составе пакетной стратегии. |
CanBeUsedAsPackageBiddingStrategySource | string | Показывает, может ли стратегия этой кампании быть пакетной. |
Структура SmartCampaignSettingGet | ||
Option | SmartCampaignSettingsGetEnum | Имя настройки: |
Value | YesNoEnum | Значение настройки. |
Структура PriorityGoalsArray | ||
Items | array of PriorityGoalsItem | Набор ключевых целей и ценностей конверсий по ним. |
Структура SmartCampaignPackageBiddingStrategyGet | ||
StrategyId | long | Идентификатор пакетной стратегии. |
Platforms | SmartCampaignPlatforms | Платформа размещения рекламы. |
Структура SmartCampaignPlatforms | ||
Search | YesNoEnum | Поисковая выдача. |
Network | YesNoEnum | Рекламная сеть Яндекса. |
Структура PriorityGoalsItem | ||
GoalId | long | Идентификатор цели Яндекс Метрики, на достижение которой будет направлена автоматическая корректировка ставок. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. Значение 12 соответствует цели «Вовлеченные сессии». |
Value | long | Ценность конверсии — денежная оценка выгоды, получаемой рекламодателем при достижении указанной цели, в валюте рекламодателя, умноженная на 1 000 000. Чем больше ценность конверсии, тем выше приоритет достижения указанной цели. |
IsMetrikaSourceOfValue | YesNoEnum | Источник ценности ключевой цели — цель Метрики. Значение YES используется только для стратегий с долей рекламных расходов. |
Структура SmartCampaignStrategy | ||
Search | SmartCampaignSearchStrategy | Стратегия показа на поиске. |
Network | SmartCampaignNetworkStrategy | Стратегия показа в сетях. |
Структура SmartCampaignSearchStrategy | ||
BiddingStrategyType | SmartCampaignSearchStrategyTypeEnum | Тип стратегии показа на поиске: |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. |
AverageRoi | StrategyAverageRoi | Параметры стратегии Оптимизация рентабельности. |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии на каждый фильтр. |
Структура SmartCampaignNetworkStrategy | ||
BiddingStrategyType | SmartCampaignNetworkStrategyTypeEnum | Тип стратегии показа в сетях:
|
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Параметры стратегии Оптимизация количества конверсий, CPA на всю кампанию. |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Параметры стратегии Оптимизация количества конверсий, CPA на каждый фильтр. |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Параметры стратегии Оптимизация количества кликов, CPC на всю кампанию. |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Параметры стратегии Оптимизация количества кликов, CPC на каждый фильтр. |
AverageRoi | StrategyAverageRoi | Параметры стратегии Оптимизация рентабельности. |
AverageCrr | StrategyAverageCrr | Параметры стратегии Оптимизация доли рекламных расходов, удерживать среднюю долю расходов. |
PayForConversionCrr | StrategyPayForConversionCrr | Параметры стратегии Оптимизация доли рекламных расходов, оплата за конверсии. |
PayForConversionPerCampaign | PayForConversionPerCampaign | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии. |
PayForConversionPerFilter | PayForConversionPerFilter | Параметры стратегии Оптимизация количества конверсий, оплата за конверсии на каждый фильтр. |
Структура StrategyAverageCpaPerCampaign | ||
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 | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCpaPerFilter | ||
FilterAverageCpa | 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 | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCpcPerCampaign | ||
AverageCpc | long | Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageCpcPerFilter | ||
FilterAverageCpc | long | |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Структура StrategyAverageRoi | ||
ReserveReturn | int | Максимальный процент сэкономленных средств, который можно возвращать в рекламу (расходовать) в случае, если прогнозируемое значение рентабельности превышает значение параметра RoiCoef. Значение от 0 до 100, кратное десяти: 0, 10, 20... 100. |
RoiCoef | long | Желаемая средняя рентабельность инвестиций за неделю. Значение представляет собой отношение прибыли от продаж к расходам на рекламу, умноженное на 1 000 000. Значение должно быть целым числом. Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Значение 13 — ключевые цели. Допускается, если в массиве PriorityGoals указана хотя бы одна цель, отличная от вовлеченных сессий. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long, nillable | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
BidCeiling | long, nillable | Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000. Минимальное и максимальное значение ставки для каждой валюты представлены в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. Примечание. Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии. |
Profitability | long, nillable | Процент выручки, являющийся себестоимостью товаров или услуг. Значение представляет собой процент, умноженный на 1 000 000. Значение должно быть целым числом от 0 до 100 000 000 (что соответствует 100%). Если значение не кратно 10 000, последние 4 цифры обнуляются (что соответствует отбрасыванию лишних знаков после запятой). |
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyAverageCrr | ||
Crr | int | Средняя доля расходов. |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
ExplorationBudget | ExplorationBudget | Минимальный бюджет. Подробнее в справке Директа. |
Структура StrategyPayForConversionCrr | ||
Crr | int | Средняя доля расходов. |
GoalId | long | Идентификатор цели Яндекс Метрики. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. Список целей получают с помощью метода GetStatGoals API версии 4 или Live 4. |
WeeklySpendLimit | long | Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get. |
CustomPeriodBudget | CustomPeriodBudget | Бюджет на период. Подробнее см. в справке Директа. При создании кампании нельзя указать одновременно с WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Тип бюджета:
|
Структура StrategyPayForConversionPerCampaign | ||
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 | Тип бюджета:
|
Структура StrategyPayForConversionPerFilter | ||
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 | Тип бюджета:
|
Структура ExplorationBudget | ||
MinimumExplorationBudget | long | Значение минимального бюджета. Допустимое значение: от 0 до значения недельного бюджета (если он задан). |
IsMinimumExplorationBudgetCustom | YesNoEnum | Признак пользовательского значения минимального бюджета. |
Структура CustomPeriodBudget | ||
SpendLimit | long | Значение бюджета на период. |
StartDate | string | Начало бюджетного периода. |
EndDate | string | Окончание бюджетного периода. |
AutoContinue | YesNoEnum | Признак автопродления бюджета. |