Campaign parameters
Parameter name in Live 4 | Parameter name in version 5 | Service in version 5 |
---|---|---|
AdditionalMetrikaCounters | CounterIds nested in TextCampaign | Campaigns |
AddRelevantPhrases | Controlled by the presence of the RelevantKeywords parameter nested in TextCampaign: If this parameter is set, displays are enabled for additional relevant keywords; if it is omitted, they are disabled | Campaigns |
AgencyName | Agency nested in RepresentedBy | Campaigns |
AutoOptimization | No longer relevant | — |
BonusDiscount | BalanceBonus, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
CampaignCurrency | Currency | Campaigns |
CampaignId | Id | Campaigns |
ClickTrackingEnabled | Option with the value ADD_METRICA_TAG, nested in Settings, nested in TextCampaign | Campaigns |
ConsiderTimeTarget | Option with the value EXCLUDE_PAUSED_COMPETING_ADS nested in Settings, nested in TextCampaign | Campaigns |
ContextStrategy | Network, nested in BiddingStrategy For the equivalence of nested parameters, see the section Strategy parameters. | Campaigns |
Currency | Not supported. Bids and prices are always shown in the advertiser's currency. | — |
Clicks | Clicks nested in Statistics | Campaigns |
DayBudget | DailyBudget. For the equivalence of nested parameters, see the section Daily budget parameters. | Campaigns |
DayBudgetEnabled | No longer relevant | — |
DisabledDomains | ExcludedSites | Campaigns |
DisabledIps | BlockedIps | Campaigns |
EmailNotification | EmailSettings nested in Notification For the equivalence of nested parameters, see the section Email notification parameters. | Campaigns |
EnableRelatedKeywords | No longer relevant | — |
ExtendedAdTitleEnabled | Option with the value ENABLE_EXTENDED_AD_TITLE, nested in Settings, nested in TextCampaign | Campaigns |
FIO | ClientInfo | Campaigns |
IsActive, Status, StatusShow, StatusArchive, StatusActivating, StatusModerate | Status, StatusPayment, StatusClarifications and State (for more information, see Status and state of a campaign) | Campaigns |
Login | HTTP header of the Client-Login request | — |
MaintainNetworkCPC | Option with the value MAINTAIN_NETWORK_CPC, nested in Settings, nested in TextCampaign Restriction. The parameter is deprecated and no longer supported. | Campaigns |
ManagerName | Manager nested in RepresentedBy | Campaigns |
MinusKeywords | NegativeKeywords | Campaigns |
MobileBidAdjustment | BidModifier nested in MobileAdjustment | BidModifiers |
Name | Name | Campaigns |
Rest | Balance, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
SmsNotification | SmsSettings nested in Notification. For the equivalence of nested parameters, see the section SMS notification parameters. | Campaigns |
SourceCampaignID | SourceId | Campaigns |
StartDate | StartDate | Campaigns |
Strategy | Search nested in BiddingStrategy, nested in TextCampaign For the equivalence of nested parameters, see the section Strategy parameters. | Campaigns |
TimeTarget | TimeTargeting | Campaigns |
RelevantPhrasesBudgetLimit | BudgetPercent, nested in RelevantKeywords, nested in TextCampaign | Campaigns |
Shows | Impressions nested in Statistics | Campaigns |
StatusBehavior | No longer relevant | — |
StatusContextStop | No longer relevant | — |
StatusMetricaControl | Option with the value ENABLE_SITE_MONITORING, nested in Settings | Campaigns |
StatusOpenStat | Option with the value ADD_OPENSTAT_TAG, nested in Settings | Campaigns |
Sum | Sum, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) Spend, nested in SharedAccountFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
SumAvailableForTransfer | SumAvailableForTransfer, nested in CampaignFunds, nested in Funds | Campaigns |
Strategy parameters (Strategy and ContextStrategy in version 4) | ||
AverageCPA | AverageCpa nested in AverageCpa | Campaigns |
AveragePrice | AverageCpc nested in AverageCpc or WeeklyClickPackage | Campaigns |
ContextLimit | Controlled by the presence of the LimitPercent parameter nested in NetworkDefault: If this parameter is set, the budget is limited; if it is omitted, the budget is unlimited Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
ContextLimitSum | LimitPercent nested in NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
ContextPricePercent | BidPercent nested in NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
GoalID | GoalId nested in WbMaximumConversionRate, AverageCpa, or RoiOptimization | Campaigns |
ClicksPerWeek | ClicksPerWeek nested in WeeklyClickPackage | Campaigns |
MaxPrice | BidCeiling nested in WbMaximumClicks, WbMaximumConversionRate, AverageCpa, AverageRoi, WeeklyClickPackage | Campaigns |
Profitability | Profitability nested in AverageRoi | Campaigns |
ReserveReturn | ReserveReturn nested in AverageRoi | Campaigns |
ROICoef | RoiCoef nested in AverageRoi | Campaigns |
StrategyName | BiddingStrategyType nested in Search or Network | Campaigns |
WeeklySumLimit | WeeklySpendLimit nested inWbMaximumClicks, WbMaximumConversionRate, AverageCpc, AverageCpa, AverageRoi | Campaigns |
SMS notification parameters (SmsNotification in version 4) | ||
MetricaSms | The MONITORING value in the Events parameter | Campaigns |
ModerateResultSms | The MODERATION value in the Events parameter | Campaigns |
MoneyInSms | The MONEY_IN value in the Events parameter | Campaigns |
MoneyOutSms | The MONEY_OUT value in the Events parameter | Campaigns |
SmsTimeFrom | TimeFrom | Campaigns |
SmsTimeTo | TimeTo | Campaigns |
Email notification parameters (EmailNotification in version 4) | ||
Campaigns | ||
MoneyWarningValue | WarningBalance | Campaigns |
SendAccNews | SendAccountNews | Campaigns |
SendWarn | SendWarnings | Campaigns |
WarnPlaceInterval | CheckPositionInterval | Campaigns |
Time targeting parameters (TimeTarget in version 4) | ||
ShowOnHolidays | SuspendOnHolidays nested in HolidaysSchedule Note. The Yes value for the ShowOnHolidays parameter corresponds to the NO value for the SuspendOnHolidays parameter, and vice versa. | Campaigns |
HolidayShowFrom | StartHour nested in HolidaysSchedule | Campaigns |
HolidayShowTo | EndHour nested in HolidaysSchedule | Campaigns |
DaysHours and nested Hours, Days, BidCoefs | Schedule | Campaigns |
TimeZone | TimeZone (top-level parameter) | Campaigns |
WorkingHolidays | ConsiderWorkingWeekends | Campaigns |
Daily budget parameters (DayBudget in version 4) | ||
Amount | Amount | Campaigns |
SpendMode | Mode | Campaigns |
Parameter name in Live 4 | Parameter name in version 5 | Service in version 5 |
---|---|---|
AdditionalMetrikaCounters | CounterIds nested in TextCampaign | Campaigns |
AddRelevantPhrases | Controlled by the presence of the RelevantKeywords parameter nested in TextCampaign: If this parameter is set, displays are enabled for additional relevant keywords; if it is omitted, they are disabled | Campaigns |
AgencyName | Agency nested in RepresentedBy | Campaigns |
AutoOptimization | No longer relevant | — |
BonusDiscount | BalanceBonus, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
CampaignCurrency | Currency | Campaigns |
CampaignId | Id | Campaigns |
ClickTrackingEnabled | Option with the value ADD_METRICA_TAG, nested in Settings, nested in TextCampaign | Campaigns |
ConsiderTimeTarget | Option with the value EXCLUDE_PAUSED_COMPETING_ADS nested in Settings, nested in TextCampaign | Campaigns |
ContextStrategy | Network, nested in BiddingStrategy For the equivalence of nested parameters, see the section Strategy parameters. | Campaigns |
Currency | Not supported. Bids and prices are always shown in the advertiser's currency. | — |
Clicks | Clicks nested in Statistics | Campaigns |
DayBudget | DailyBudget. For the equivalence of nested parameters, see the section Daily budget parameters. | Campaigns |
DayBudgetEnabled | No longer relevant | — |
DisabledDomains | ExcludedSites | Campaigns |
DisabledIps | BlockedIps | Campaigns |
EmailNotification | EmailSettings nested in Notification For the equivalence of nested parameters, see the section Email notification parameters. | Campaigns |
EnableRelatedKeywords | No longer relevant | — |
ExtendedAdTitleEnabled | Option with the value ENABLE_EXTENDED_AD_TITLE, nested in Settings, nested in TextCampaign | Campaigns |
FIO | ClientInfo | Campaigns |
IsActive, Status, StatusShow, StatusArchive, StatusActivating, StatusModerate | Status, StatusPayment, StatusClarifications and State (for more information, see Status and state of a campaign) | Campaigns |
Login | HTTP header of the Client-Login request | — |
MaintainNetworkCPC | Option with the value MAINTAIN_NETWORK_CPC, nested in Settings, nested in TextCampaign Restriction. The parameter is deprecated and no longer supported. | Campaigns |
ManagerName | Manager nested in RepresentedBy | Campaigns |
MinusKeywords | NegativeKeywords | Campaigns |
MobileBidAdjustment | BidModifier nested in MobileAdjustment | BidModifiers |
Name | Name | Campaigns |
Rest | Balance, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
SmsNotification | SmsSettings nested in Notification. For the equivalence of nested parameters, see the section SMS notification parameters. | Campaigns |
SourceCampaignID | SourceId | Campaigns |
StartDate | StartDate | Campaigns |
Strategy | Search nested in BiddingStrategy, nested in TextCampaign For the equivalence of nested parameters, see the section Strategy parameters. | Campaigns |
TimeTarget | TimeTargeting | Campaigns |
RelevantPhrasesBudgetLimit | BudgetPercent, nested in RelevantKeywords, nested in TextCampaign | Campaigns |
Shows | Impressions nested in Statistics | Campaigns |
StatusBehavior | No longer relevant | — |
StatusContextStop | No longer relevant | — |
StatusMetricaControl | Option with the value ENABLE_SITE_MONITORING, nested in Settings | Campaigns |
StatusOpenStat | Option with the value ADD_OPENSTAT_TAG, nested in Settings | Campaigns |
Sum | Sum, nested in CampaignFunds, nested in Funds (if the shared account isn't enabled) Spend, nested in SharedAccountFunds, nested in Funds (if the shared account isn't enabled) | Campaigns |
SumAvailableForTransfer | SumAvailableForTransfer, nested in CampaignFunds, nested in Funds | Campaigns |
Strategy parameters (Strategy and ContextStrategy in version 4) | ||
AverageCPA | AverageCpa nested in AverageCpa | Campaigns |
AveragePrice | AverageCpc nested in AverageCpc or WeeklyClickPackage | Campaigns |
ContextLimit | Controlled by the presence of the LimitPercent parameter nested in NetworkDefault: If this parameter is set, the budget is limited; if it is omitted, the budget is unlimited Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
ContextLimitSum | LimitPercent nested in NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
ContextPricePercent | BidPercent nested in NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | Campaigns |
GoalID | GoalId nested in WbMaximumConversionRate, AverageCpa, or RoiOptimization | Campaigns |
ClicksPerWeek | ClicksPerWeek nested in WeeklyClickPackage | Campaigns |
MaxPrice | BidCeiling nested in WbMaximumClicks, WbMaximumConversionRate, AverageCpa, AverageRoi, WeeklyClickPackage | Campaigns |
Profitability | Profitability nested in AverageRoi | Campaigns |
ReserveReturn | ReserveReturn nested in AverageRoi | Campaigns |
ROICoef | RoiCoef nested in AverageRoi | Campaigns |
StrategyName | BiddingStrategyType nested in Search or Network | Campaigns |
WeeklySumLimit | WeeklySpendLimit nested inWbMaximumClicks, WbMaximumConversionRate, AverageCpc, AverageCpa, AverageRoi | Campaigns |
SMS notification parameters (SmsNotification in version 4) | ||
MetricaSms | The MONITORING value in the Events parameter | Campaigns |
ModerateResultSms | The MODERATION value in the Events parameter | Campaigns |
MoneyInSms | The MONEY_IN value in the Events parameter | Campaigns |
MoneyOutSms | The MONEY_OUT value in the Events parameter | Campaigns |
SmsTimeFrom | TimeFrom | Campaigns |
SmsTimeTo | TimeTo | Campaigns |
Email notification parameters (EmailNotification in version 4) | ||
Campaigns | ||
MoneyWarningValue | WarningBalance | Campaigns |
SendAccNews | SendAccountNews | Campaigns |
SendWarn | SendWarnings | Campaigns |
WarnPlaceInterval | CheckPositionInterval | Campaigns |
Time targeting parameters (TimeTarget in version 4) | ||
ShowOnHolidays | SuspendOnHolidays nested in HolidaysSchedule Note. The Yes value for the ShowOnHolidays parameter corresponds to the NO value for the SuspendOnHolidays parameter, and vice versa. | Campaigns |
HolidayShowFrom | StartHour nested in HolidaysSchedule | Campaigns |
HolidayShowTo | EndHour nested in HolidaysSchedule | Campaigns |
DaysHours and nested Hours, Days, BidCoefs | Schedule | Campaigns |
TimeZone | TimeZone (top-level parameter) | Campaigns |
WorkingHolidays | ConsiderWorkingWeekends | Campaigns |
Daily budget parameters (DayBudget in version 4) | ||
Amount | Amount | Campaigns |
SpendMode | Mode | Campaigns |