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