get: CpmBannerCampaign parameters
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 */
},
"WbAverageCpv" : { /* StrategyWbAverageCpvAdd */
"AverageCpv" : (long) /* required */,
"SpendLimit" : (long) /* required */
},
"CpAverageCpv" : { /* StrategyCpAverageCpvAdd */
"AverageCpv" : (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 */
"VideoTarget": ("VIEWS"|"CLICKS")
}
}, ... ],
"LimitedBy": (long)
}
}
Parameter | Type | Description |
CpmBannerCampaignGetItem structure | ||
---|---|---|
BiddingStrategy | CpmBannerCampaignStrategy | Display strategy. |
Settings | array of CpmBannerCampaignSettingGet | Array of settings that only accept the values YES or NO. |
CounterIds | ArrayOfInteger, nillable | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). |
FrequencyCap | FrequencyCapSetting, nillable | Limits the frequency of impressions per user. If the structure is omitted, the frequency of impressions is not limited. |
VideoTarget | VideoTargetEnum | Goal for video ads. Available values:
In the AUTOBUDGET_AVG_CPV and AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD strategies, the value is reset to null. |
CpmBannerCampaignSettingGet structure | ||
Option | CpmBannerCampaignSettingsGetEnum | Setting name: |
Value | YesNoEnum | Setting value. |
FrequencyCapSetting structure | ||
Impressions | int | Maximum number of impressions per user during a period. |
PeriodDays | int, nillable | Number of days from 1 to 30. null (nil) — The limit applies to the entire time the advertising campaign is running. |
CpmBannerCampaignStrategy structure | ||
Search | CpmBannerCampaignSearchStrategy | Display strategy in search results. |
Network | CpmBannerCampaignNetworkStrategy | Display strategy in ad networks. |
CpmBannerCampaignSearchStrategy structure | ||
BiddingStrategyType | CpmBannerCampaignSearchStrategyTypeEnum | The type of display strategy in search results. The only available value is SERVING_OFF. |
CpmBannerCampaignNetworkStrategy structure | ||
BiddingStrategyType | CpmBannerCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks: |
WbMaximumImpressions | StrategyWbMaximumImpressions | Parameters of the Maximize impressions for lowest price weekly strategy. |
CpMaximumImpressions | StrategyCpMaximumImpressions | Parameters of the Maximize impressions for lowest price strategy for a period. |
WbDecreasedPriceForRepeatedImpressions | StrategyWbDecreasedPriceForRepeatedImpressions | Parameters of the Decrease price for repeat impressions weekly strategy. |
CpDecreasedPriceForRepeatedImpressions | StrategyCpDecreasedPriceForRepeatedImpressions | Parameters of the Decrease price for repeat impressions strategy for a period. |
WbAverageCpv | StrategyWbAverageCpv | Parameters of the Maximum video views (weekly) strategy. |
CpAverageCpv | StrategyCpAverageCpv | Parameters of the Maximum video views (for the period) strategy. |
StrategyWbMaximumImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | 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.get method. |
StrategyCpMaximumImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |
StrategyWbDecreasedPriceForRepeatedImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | 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.get method. |
StrategyCpDecreasedPriceForRepeatedImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |
StrategyWbAverageCpv structure | ||
AverageCpv | long | Average CPV 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. |
SpendLimit | 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.get method. |
StrategyCpAverageCpv structure | ||
AverageCpv | long | Average CPV 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |
Parameter | Type | Description |
CpmBannerCampaignGetItem structure | ||
---|---|---|
BiddingStrategy | CpmBannerCampaignStrategy | Display strategy. |
Settings | array of CpmBannerCampaignSettingGet | Array of settings that only accept the values YES or NO. |
CounterIds | ArrayOfInteger, nillable | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). |
FrequencyCap | FrequencyCapSetting, nillable | Limits the frequency of impressions per user. If the structure is omitted, the frequency of impressions is not limited. |
VideoTarget | VideoTargetEnum | Goal for video ads. Available values:
In the AUTOBUDGET_AVG_CPV and AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD strategies, the value is reset to null. |
CpmBannerCampaignSettingGet structure | ||
Option | CpmBannerCampaignSettingsGetEnum | Setting name: |
Value | YesNoEnum | Setting value. |
FrequencyCapSetting structure | ||
Impressions | int | Maximum number of impressions per user during a period. |
PeriodDays | int, nillable | Number of days from 1 to 30. null (nil) — The limit applies to the entire time the advertising campaign is running. |
CpmBannerCampaignStrategy structure | ||
Search | CpmBannerCampaignSearchStrategy | Display strategy in search results. |
Network | CpmBannerCampaignNetworkStrategy | Display strategy in ad networks. |
CpmBannerCampaignSearchStrategy structure | ||
BiddingStrategyType | CpmBannerCampaignSearchStrategyTypeEnum | The type of display strategy in search results. The only available value is SERVING_OFF. |
CpmBannerCampaignNetworkStrategy structure | ||
BiddingStrategyType | CpmBannerCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks: |
WbMaximumImpressions | StrategyWbMaximumImpressions | Parameters of the Maximize impressions for lowest price weekly strategy. |
CpMaximumImpressions | StrategyCpMaximumImpressions | Parameters of the Maximize impressions for lowest price strategy for a period. |
WbDecreasedPriceForRepeatedImpressions | StrategyWbDecreasedPriceForRepeatedImpressions | Parameters of the Decrease price for repeat impressions weekly strategy. |
CpDecreasedPriceForRepeatedImpressions | StrategyCpDecreasedPriceForRepeatedImpressions | Parameters of the Decrease price for repeat impressions strategy for a period. |
WbAverageCpv | StrategyWbAverageCpv | Parameters of the Maximum video views (weekly) strategy. |
CpAverageCpv | StrategyCpAverageCpv | Parameters of the Maximum video views (for the period) strategy. |
StrategyWbMaximumImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | 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.get method. |
StrategyCpMaximumImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |
StrategyWbDecreasedPriceForRepeatedImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | 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.get method. |
StrategyCpDecreasedPriceForRepeatedImpressions structure | ||
AverageCpm | long | 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |
StrategyWbAverageCpv structure | ||
AverageCpv | long | Average CPV 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. |
SpendLimit | 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.get method. |
StrategyCpAverageCpv structure | ||
AverageCpv | long | Average CPV 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. |
SpendLimit | long | 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. |
StartDate | string | Date 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. |
EndDate | string | Date of the end of the period, in the format YYYY-MM-DD. Can't be later than the campaign end date. |
AutoContinue | YesNoEnum | Extend the campaign period automatically in order to use the remaining budget. |