get: CpmBannerCampaign 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 */
      ...
      "CpmBannerCampaign": {  /* CpmBannerCampaignGetItem */
        "BiddingStrategy": {  /* CpmBannerCampaignStrategy */
          "Search": {  /* CpmBannerCampaignSearchStrategy */
            "BiddingStrategyType": ( "SERVING_OFF" | "UNKNOWN" ) /* required */
          }, 
          "Network": {  /* CpmBannerCampaignNetworkStrategy */
            "BiddingStrategyType": ( "MANUAL_CPM" | ... | "WB_MAXIMUM_IMPRESSIONS" ), /* required */
            "WbMaximumImpressions": {  /* StrategyWbMaximumImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpMaximumImpressions": {  /* StrategyCpMaximumImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            },
            "WbDecreasedPriceForRepeatedImpressions": {  /* StrategyWbDecreasedPriceForRepeatedImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpDecreasedPriceForRepeatedImpressions": {  /* StrategyCpDecreasedPriceForRepeatedImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            }
          } 
        },
        "Settings": [{  /* CpmBannerCampaignSettingGet */
          "Option": ( "ADD_METRICA_TAG" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "FrequencyCap": {  /* FrequencyCapSetting */
          "Impressions": (int), /* required */
          "PeriodDays": (int) /* required */ /* nillable */
        } /* nillable */
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
CpmBannerCampaignGetItem structure
BiddingStrategyCpmBannerCampaignStrategyDisplay strategy.
Settingsarray of CpmBannerCampaignSettingGetArray of settings that only accept the values YES or NO.
CounterIdsArrayOfInteger, nillableIDs of Yandex.Metrica tags installed on the advertiser's website (see Yandex.Metrica: advertising campaign efficiency evaluation in the Help for Direct). Maximum of 5 items in the array.
FrequencyCapFrequencyCapSetting, nillableLimits the frequency of impressions per user. If the structure is omitted, the frequency of impressions is not limited.
CpmBannerCampaignSettingGet structure
OptionCpmBannerCampaignSettingsGetEnum

Setting name:

ValueYesNoEnumSetting value.
FrequencyCapSetting structure
ImpressionsintMaximum number of impressions per user during a period.
PeriodDaysint, nillable

Number of days from 1 to 30.

null (nil) — The limit applies to the entire time the advertising campaign is running.

CpmBannerCampaignStrategy structure
NetworkCpmBannerCampaignNetworkStrategyDisplay strategy in ad networks.
CpmBannerCampaignSearchStrategy structure
BiddingStrategyTypeCpmBannerCampaignSearchStrategyTypeEnumThe type of display strategy in search results. Only one value is available: SERVING_OFF.
CpmBannerCampaignNetworkStrategy structure
BiddingStrategyTypeCpmBannerCampaignNetworkStrategyTypeEnumThe type of display strategy in ad networks:
WbMaximumImpressionsStrategyWbMaximumImpressionsParameters of the Maximize impressions for lowest price weekly strategy.
CpMaximumImpressionsStrategyCpMaximumImpressionsParameters of the Maximize impressions for lowest price strategy for a period.
WbDecreasedPriceForRepeatedImpressionsStrategyWbDecreasedPriceForRepeatedImpressionsParameters of the Decrease price for repeat impressions weekly strategy.
CpDecreasedPriceForRepeatedImpressionsStrategyCpDecreasedPriceForRepeatedImpressionsParameters of the Decrease price for repeat impressions strategy for a period.
StrategyWbMaximumImpressions structure
AverageCpmlong

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

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

SpendLimitlong

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.

StrategyCpMaximumImpressions structure
AverageCpmlong

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

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

SpendLimitlong

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

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

StartDatestringDate of the start of the period, in the format YYYY-MM-DD. Can't be earlier than the current date or the campaign start date.
EndDatestringDate of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date.
AutoContinueYesNoEnumExtend the campaign period automatically in order to use the remaining budget.
StrategyWbDecreasedPriceForRepeatedImpressions structure
AverageCpmlong

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

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

SpendLimitlong

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.

StrategyCpDecreasedPriceForRepeatedImpressions structure
AverageCpmlong

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

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

SpendLimitlong

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

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

StartDatestringDate of the start of the period, in the format YYYY-MM-DD. Can't be earlier than the current date or the campaign start date.
EndDatestringDate of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date.
AutoContinueYesNoEnumExtend the campaign period automatically in order to use the remaining budget.