campaign.$type
|
Yes
|
Campaign type
|
String
|
HybridExtendedCampaign –
OdnoklassnikiCampaign - MyTarget
|
campaign.advertiserId
|
Yes
|
Advertiser Id
|
String
|
|
campaign.id
|
No
|
campaignId (only by receiving)
|
String
|
|
campaign.backtwistType
|
Yes
|
Budget allocation type
|
Long
|
Maximum = 0,
Optimization = 1
|
campaign.betOptimizationType
|
Yes
|
Optimization Type
|
Long
|
NoOptimization = -1,
CPC = 1,
CPM = 2
|
campaign.bet
|
Yes
|
Bet
|
Double
|
Positive number with 2 digit precision.
Maximum value is 1000
|
campaign.defaultClickUrl
|
Yes
|
Click url by default
|
String
|
|
campaign.startDate
|
Yes
|
Start date
|
Date
|
|
campaign.endDate
|
No
|
End date
|
Date
|
|
campaign.excludeGeoIds
|
No
|
Ids Array of excluded Geo
|
String[]
|
|
campaign.geoIds
|
No
|
Ids Array of enabled Geo
|
String[]
|
|
campaign.geoTargetMail
|
No
|
Active geos Id
|
String[]
|
|
campaign.frequencyCaps[].event
|
No
|
Event type
|
Long
|
Impression = 1,
Complete = 2,
Click = 3
|
campaign.frequencyCaps[].count
|
No
|
Quantity
|
Long
|
|
campaign.frequencyCaps[].interval
|
No
|
Time interval (in hours)
|
Long
|
Maximum value is 2208 hours
|
campaign.frequencyCaps[].type
|
No
|
Restriction type
|
Long
|
Globally = 0,
Site = 1,
Place = 2
|
campaign.linkedSystems[].systemId
|
No, only for HybridExtendedCampaign
|
Ssp Id
|
Long
|
|
campaign.status
|
Yes
|
Campaign status
|
Long
|
Active = 1,
NotActive = 2,
Archive = 3
|
campaign.multiPriceLimitations[].priceFormationType
|
Yes
|
Budget type
|
Long
|
Click = 0,
Impression = 1,
View = 2,
Budget = 3
|
campaign.multiPriceLimitations[].amount
|
Yes
|
Budget per day
|
Double
|
Positive number with 2 digit precision.
Maximum value is 100000
|
campaign.multiPriceLimitations[].totalAmount
|
No
|
Total budget
|
Double
|
Positive number with 2 digit precision.
Maximum value is 100000
|
campaign.name
|
Yes
|
Name
|
String
|
а-я,А-Я,a-z, A-Z, ‘ ’, ‘-’
limit length is 30 symbols
|
campaign.audienceGroup.$type
|
Yes, only for HybridExtendedCampaign
|
Audience container type
|
String
|
GroupElement – group container
|
campaign.audienceGroup.operatorType
|
Yes, only for HybridExtendedCampaign
|
Operator type
|
Long
|
Or = 0,
And = 1
|
campaign.audienceGroup.elements[].$type
|
Yes, only for HybridExtendedCampaign
|
Audience type
|
String
|
Audience based on cid - RemarketingElement
|
campaign.audienceGroup.elements[].isIncluded
|
Yes, only for HybridExtendedCampaign
|
Activate / exclude the audience
|
Bool
|
|
campaign.audienceGroup.elements[].audienceId
|
Yes, only for HybridExtendedCampaign
|
Audience Id
|
String
|
|
campaign.mtAudiences[].id
|
Yes, only for OdnoklassinikiCampaign
|
Audience Id
|
String
|
|
campaign.mtAudiences[].isIncluded
|
Yes, only for OdnoklassinikiCampaign
|
Audience inclusion indicator, always "true"
|
Bool
|
|
campaign.bannerType
|
Yes, only for OdnoklassinikiCampaign
|
Banner type in MyTarge
|
Long
|
7 - archive
8 - native banner
|
campaign.packageId
|
Yes, only for OdnoklassinikiCampaign
|
Campaign type in MyTarget
|
Long
|
1479 - CPC Html5
2268 - CPC Native
|
campaign.bidding
|
Yes, only for OdnoklassinikiCampaign
|
Auction strategy in MyTarget
|
Long
|
0 - fixed bet
1 - Minimum costs
2 - Maximum number of clicks or impressions
|
banners[].id
|
Only when responding
|
Banner Id
|
String
|
|
banners[].clickUrl
|
Yes
|
Click Url
|
String
|
|
banners[].name
|
Yes
|
Name
|
String
|
a-z, A-Z, ‘ ’, ‘-’
limit length is 30 symbols
|
banners[].status
|
Yes
|
Banner status
|
Long
|
1 - active
3 - NotActive
4 - archived
|
banners[].adLibraryId
|
Yes, if the creation is through an existing Ad
|
Ad Id
|
String
|
|
banners[].content.$type
|
Yes
|
Banner type
|
String
|
ImageOrFlashBanner – picture
Html5Banner - Html5
|
banners[].content.clickUrl
|
Yes
|
Click Url
|
String
|
|
banners[].content.altText
|
No
|
Alternative text (required only for Yandex SSP)
|
String
|
|
banners[].content.name
|
Yes
|
Name
|
String
|
a-z, A-Z, ‘ ’, ‘-’
limit length is 30 symbols
|
banners[].content.width
|
No
|
Width
|
Long
|
|
banners[].content.height
|
No
|
Height
|
Long
|
|
banners[].content.fileContent.base64Data
|
Yes, for Image
|
File content in base64 format
|
String
|
|
banners[].content.fileContent.contentType
|
Yes, for Image
|
File Content-Type
|
String
|
|
banners[].content.fileContent.fileName
|
Yes, for Image
|
File name
|
String
|
|
banners[].content.archive.base64Data
|
Yes, for Html5
|
File content in base64 format
|
String
|
|
banners[].content.archive.contentType
|
Yes, for Html5
|
File Content-Type
|
String
|
|
banners[].content.archive.fileName
|
Yes, for Html5
|
File name
|
String
|
|