Documentation

get: MobileAppCampaign parameters

Attention! All monetary campaign parameters (daily budget, weekly budget, and average price for automatic strategies) are passed via the Yandex.Direct API as integer numbers. The passed value is a monetary value in the advertiser's currency, multiplied by 1,000,000.

Response structure in JSON format:

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "MobileAppCampaign": {  /* MobileAppCampaignGetItem */
        "BiddingStrategy
[no-highlight[

Display strategy.

]no-highlight]
": { /* MobileAppCampaignStrategy */ "Search
[no-highlight[

Display strategy in search results.

]no-highlight]
": { /* MobileAppCampaignSearchStrategy */ "BiddingStrategyType": ( "AVERAGE_CPC" | ...
[no-highlight[

“AVERAGE_CPC“ | “AVERAGE_CPI“ | “HIGHEST_POSITION“ | “SERVING_OFF“ | “WB_MAXIMUM_APP_INSTALLS“ | “UNKNOWN“ | “WB_MAXIMUM_CLICKS“ | “WEEKLY_CLICK_PACKAGE“

]no-highlight]
| "WEEKLY_CLICK_PACKAGE" ), /* required */ "WbMaximumClicks
[no-highlight[

Parameters for the Weekly budget strategy (maximum clicks).

]no-highlight]
": { /* StrategyMaximumClicks */ "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "WbMaximumAppInstalls
[no-highlight[

Parameters for the Weekly budget strategy (maximum number of installations).

]no-highlight]
": { /* StrategyMaximumAppInstalls */ "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "AverageCpc
[no-highlight[

Parameters for the Average CPC strategy.

]no-highlight]
": { /* StrategyAverageCpc */ "AverageCpc
[no-highlight[

The average CPC in the advertiser‘s currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long) /* nillable */ }, "AverageCpi
[no-highlight[

Parameters for the Average price per app install strategy.

]no-highlight]
": { /* StrategyAverageCpi */ "AverageCpi
[no-highlight[

The average cost of an app installation in the advertiser‘s currency, multiplied by 1,000,000.

The minimum acceptable value is shown in the section Currency parameters and limits.

]no-highlight]
": (long), "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), /* nillable */ "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "WeeklyClickPackage
[no-highlight[

Parameters for the Weekly click package strategy.

]no-highlight]
": { /* StrategyWeeklyClickPackage */ "ClicksPerWeek
[no-highlight[

Desired number of clicks per week.

]no-highlight]
": (long), "AverageCpc
[no-highlight[

The average CPC in the advertiser‘s currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can‘t specify both of them.
]no-highlight]
": (long), /* nillable */ "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can‘t specify both of them.
]no-highlight]
": (long) /* nillable */ } }, "Network
[no-highlight[

Display strategy in ad networks.

]no-highlight]
": { /* MobileAppCampaignNetworkStrategy */ "BiddingStrategyType": ( "AVERAGE_CPC" | ...
[no-highlight[

“AVERAGE_CPC“ | “AVERAGE_CPI“ | “NETWORK_DEFAULT“ | “MAXIMUM_COVERAGE“ | “SERVING_OFF“ | “UNKNOWN“ | “WB_MAXIMUM_APP_INSTALLS“ | “WB_MAXIMUM_CLICKS“ | “WEEKLY_CLICK_PACKAGE“

]no-highlight]
| "WEEKLY_CLICK_PACKAGE" ), /* required */ "NetworkDefault
[no-highlight[

Parameters for the “Bid in ad networks based on the bid in search” strategy.

]no-highlight]
": { /* StrategyNetworkDefault */ "LimitPercent
[no-highlight[

The maximum percentage of the budget to spend on displays in ad networks. The value is a multiple of ten: 10, 20, ..., 100. The default value is 100.

]no-highlight]
": (int), "BidPercent
[no-highlight[

The limit on the bid in ad networks. Set as a percentage of the bid in search results. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the bid in ad networks equal to the price in search results. The default value is 100.

]no-highlight]
": (int) }, "WbMaximumClicks
[no-highlight[

Parameters for the Weekly budget strategy (maximum clicks).

]no-highlight]
": { /* StrategyMaximumClicks */ "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "WbMaximumAppInstalls
[no-highlight[

Parameters for the Weekly budget strategy (maximum number of installations).

]no-highlight]
": { /* StrategyMaximumAppInstalls */ "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "AverageCpc
[no-highlight[

Parameters for the Average CPC strategy.

]no-highlight]
": { /* StrategyAverageCpc */ "AverageCpc
[no-highlight[

The average CPC in the advertiser‘s currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long) /* nillable */ }, "AverageCpi
[no-highlight[

Parameters for the Average price per app install strategy.

]no-highlight]
": { /* StrategyAverageCpi */ "AverageCpi
[no-highlight[

The average cost of an app installation in the advertiser‘s currency, multiplied by 1,000,000.

The minimum acceptable value is shown in the section Currency parameters and limits.

]no-highlight]
": (long), "WeeklySpendLimit
[no-highlight[

The weekly budget in the advertiser‘s currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

]no-highlight]
": (long), /* nillable */ "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don‘t recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
]no-highlight]
": (long) /* nillable */ }, "WeeklyClickPackage
[no-highlight[

Parameters for the Weekly click package strategy.

]no-highlight]
": { /* StrategyWeeklyClickPackage */ "ClicksPerWeek
[no-highlight[

Desired number of clicks per week.

]no-highlight]
": (long), "AverageCpc
[no-highlight[

The average CPC in the advertiser‘s currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can‘t specify both of them.
]no-highlight]
": (long), /* nillable */ "BidCeiling
[no-highlight[

The maximum bid in the advertiser‘s currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can‘t specify both of them.
]no-highlight]
": (long) /* nillable */ } } }, "Settings
[no-highlight[

Array of settings that only accept the values YES or NO.

]no-highlight]
": [{ /* MobileAppCampaignSettingGet */ "Option": ( "ADD_TO_FAVORITES" | ...
[no-highlight[

“ADD_TO_FAVORITES“ | “DAILY_BUDGET_ALLOWED“ | “ENABLE_AREA_OF_INTEREST_TARGETING“ | “MAINTAIN_NETWORK_CPC“ | “REQUIRE_SERVICING“ | “SHARED_ACCOUNT_ENABLED“

]no-highlight]
| "SHARED_ACCOUNT_ENABLED" ), /* required */ "Value
[no-highlight[

Setting value.

]no-highlight]
": ( "YES" | "NO" ) /* required */ }, ... ] } }, ... ], "LimitedBy": (long) } }
Parameter Type Description
MobileAppCampaignGetItem structure
Settings array of MobileAppCampaignSettingGetArray of settings that only accept the values YES or NO.
BiddingStrategy MobileAppCampaignStrategy Display strategy.
MobileAppCampaignSettingGet structure
Option MobileAppCampaignSettingsEnum

Setting name:

  • ADD_TO_FAVORITES
    [no-highlight[

    Add the campaign to your favorites, in order to filter by it in the web interface.

    The default value is NO.

    ]no-highlight]
  • ENABLE_AREA_OF_INTEREST_TARGETING
    [no-highlight[

    Enable area of interest targeting (enhanced geographical targeting).

    The default value is YES.

    ]no-highlight]
  • MAINTAIN_NETWORK_CPC
    [no-highlight[

    Keep the average CPC in ad networks lower than the average CPC in search results.

    The default value is YES.

    ]no-highlight]
  • REQUIRE_SERVICING
    [no-highlight[

    Switch the campaign to being handled by a personal manager.

    If the advertiser doesn‘t have any campaigns handled by a personal manager, only the NO value can be set. If you try to set YES, the value NO is set and a warning appears. The default value is NO.

    If the advertiser already has at least one campaign handled by a manager, you can set either YES or NO. Omitting this setting is the same as the YES value. You can‘t change the value from YES to NO.

    ]no-highlight]
  • SHARED_ACCOUNT_ENABLED
    [no-highlight[

    The shared account is enabled.

    ]no-highlight]
  • DAILY_BUDGET_ALLOWED
    [no-highlight[

    You can control the daily budget of the campaign.

    ]no-highlight]
Value YesNoEnumSetting value.
MobileAppCampaignStrategy structure
Search MobileAppCampaignSearchStrategy Display strategy in search results.
Network MobileAppCampaignNetworkStrategy Display strategy in ad networks.
MobileAppCampaignSearchStrategy structure
BiddingStrategyType MobileAppCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

  • HIGHEST_POSITION
    [no-highlight[

    “Manual bid management”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • WB_MAXIMUM_CLICKS
    [no-highlight[

    “Weekly budget”, maximum clicks

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • WB_MAXIMUM_APP_INSTALLS
    [no-highlight[

    “Weekly budget”, maximum number of installations

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • AVERAGE_CPC
    [no-highlight[

    “Average CPC”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • AVERAGE_CPI
    [no-highlight[

    “Average price per app install”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • WEEKLY_CLICK_PACKAGE
    [no-highlight[

    “Weekly click package”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • SERVING_OFF
    [no-highlight[

    Displays are disabled

    ]no-highlight]
  • UNKNOWN
    [no-highlight[

    Reserved for strategies that are not supported in this version of the API.

    ]no-highlight]
WbMaximumClicks StrategyMaximumClicks Parameters for the Weekly budget strategy (maximum clicks).
WbMaximumAppInstalls StrategyMaximumAppInstalls Parameters for the Weekly budget strategy (maximum number of installations).
AverageCpc StrategyAverageCpc Parameters for the Average CPC strategy.
WeeklyClickPackage StrategyWeeklyClickPackage Parameters for the Weekly click package strategy.
AverageCpi StrategyAverageCpi Parameters for the Average price per app install strategy.
MobileAppCampaignNetworkStrategy structure
BiddingStrategyType MobileAppCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

  • NETWORK_DEFAULT
    [no-highlight[

    The bid on the ad network is based on the bid on search

    ]no-highlight]
  • MAXIMUM_COVERAGE
    [no-highlight[

    Separate bid management on search and in ad networks

    ]no-highlight]
  • WB_MAXIMUM_CLICKS
    [no-highlight[

    “Weekly budget”, maximum clicks

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • WB_MAXIMUM_APP_INSTALLS
    [no-highlight[

    “Weekly budget”, maximum number of installations

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • AVERAGE_CPC
    [no-highlight[

    “Average CPC”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • AVERAGE_CPI
    [no-highlight[

    “Average price per app install”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • WEEKLY_CLICK_PACKAGE
    [no-highlight[

    “Weekly click package”

    See the description in the Help for Yandex.Direct.

    ]no-highlight]
  • SERVING_OFF
    [no-highlight[

    Displays are disabled

    ]no-highlight]
  • UNKNOWN
    [no-highlight[

    Reserved for strategies that are not supported in this version of the API.

    ]no-highlight]
NetworkDefault StrategyNetworkDefault Parameters for the “Bid in ad networks based on the bid in search” strategy.
WbMaximumClicks StrategyMaximumClicks Parameters for the Weekly budget strategy (maximum clicks).
WbMaximumAppInstalls StrategyMaximumAppInstalls Parameters for the Weekly budget strategy (maximum number of installations).
AverageCpc StrategyAverageCpc Parameters for the Average CPC strategy.
WeeklyClickPackage StrategyWeeklyClickPackage Parameters for the Weekly click package strategy.
AverageCpi StrategyAverageCpi Parameters for the Average price per app install strategy.
StrategyMaximumClicks structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
BidCeiling long, nillable

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyMaximumAppInstalls structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
BidCeiling long, nillable

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyAverageCpc structure
AverageCpc long

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
WeeklySpendLimit long, nillable

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
StrategyAverageCpi structure
AverageCpi long

The average cost of an app installation in the advertiser's currency, multiplied by 1,000,000.

The minimum acceptable value is shown in the section Currency parameters and limits.

WeeklySpendLimit long, nillable

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
BidCeiling long, nillable

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyWeeklyClickPackage structure
ClicksPerWeek longDesired number of clicks per week.
AverageCpc long, nillable

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average CPC is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
BidCeiling long, nillable

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
method.
Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
StrategyNetworkDefault structure
LimitPercent intThe maximum percentage of the budget to spend on displays in ad networks. The value is a multiple of ten: 10, 20, ..., 100. The default value is 100.
BidPercent intThe limit on the bid in ad networks. Set as a percentage of the bid in search results. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the bid in ad networks equal to the price in search results. The default value is 100.