The identity and technical contract details declared by the specification.
adcloudcommonEventType
string
Enumeration of event types supported by Moloco Ads. This value is not part of the specification. - BIDMADE: A bid has been made for a bid request. - BIDWON: Th…
adcloudcommonInterval
object
Interval represents a contiguous integer range [start, end).
2 properties
CampaignGoalOptimizeClicksToApp
object
Detailed configuration of OPTIMIZECPCFORAPPUA goal.
3 properties
commonEnablingState
string
Enumeration of the enabling states with a default UNSPECIFIED state.
messagesUpdateAdGroupError
object
3 properties
CampaignGoalOptimizeAppInstallsMode
string
- FIXED: Read-only for AdCloud.
commonCircle
object
Circle defines a circle with a center geo location and radius in km.
2 properties
CampaignGoalOptimizeCpaForWebUaMode
string
CampaignGoalOptimizeAppRoas
object
6 properties
1 required
CampaignGoalOptimizeAppRetention
object
Detailed configuration of OPTIMIZERETENTIONFORAPPUA goal.
4 properties
dspCampaignGoal
object
CampaignGoal describes the details of goal of a Campaign.
17 properties
1 required
commonTagsThrottleCondition
object
Tags Thrrottle Condition. It specifies a throttle rate for a list of tags. All the tags in a list will have same throttle rate.
2 properties
AudienceTargetingConditionCoppaAcceptance
string
Indicates whether to bid according to the COPPA(Children's Online Privacy Protection Act) value of BidRequest. - UNKNOWNCOPPA: Doesn't filter BidRequest accord…
dspAdGroupAudienceExtension
object
AdGroupAudienceExtension holds the adgroup settings for PAS audience extension.
2 properties
adcloudcommonFloatingPointRange
object
2 properties
commonGender
string
Enumeration of gender types. This value is not part of the specification.
commonTimeInterval
object
Interval with start and end timestamps in RFC3339 format.
2 properties
messagesListAdGroupsResponse
object
2 properties
CampaignGoalOptimizeCpaRepeatedForAppUaMode
string
AudienceTargetingConditionSkanTraffic
string
Indicates whether to bid according to bid requests that support SKAN(SKAdNetwork) or not. - UNKNOWNSKAN: Doesn't filter BidRequest according to support skan or…
messagesDeleteAdGroupError
object
3 properties
CampaignGoalOptimizeClicksToAppMode
string
CustomAudienceSetCustomAudienceCondition
object
3 properties
dspCampaignGoalType
string
Type enumerates available Campaign goal types. Corresponding details to the type must be specified. - OPTIMIZENONE: Goal type for the Campaigns which do not us…
messagesListAdGroupsErrorAPIErrorInfoErrorReason
string
CampaignGoalOptimizeCpaForAppUa
object
Detailed configuration of OPTIMIZECPAFORAPPUA goal.
5 properties
1 required
adcloudcommonCreativeType
string
Enumeration of creative types supported by Moloco Ads. This value is not part of the specification.
CampaignGoalOptimizeAppReattribution
object
Detailed configuration of OPTIMIZEREATTRIBUTIONFORAPP goal.
2 properties
CampaignGoalOptimizeCpaForWebUa
object
3 properties
1 required
AudienceTargetingConditionDeviceOsFilter
object
Device OS and version filter condition.
3 properties
1 required
AudienceTargetingConditionMediaChannelType
string
- UNKNOWNMEDIACHANNELTYPE: This value is not part of the specification.
messagesCreateAdGroupResponse
object
1 property
CustomAudienceSetAppEvent
object
3 properties
messagesCreateAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPPRICINGMODELNOTSUPPORTEDFORCAMPAIGNTYPE: unsupported pricing model id for direct sold ad or house ad. - ADGROUPTARGETDUPLICATEDADPLATFORM: AdGroup has…
messagesUpdateAdGroupErrorAPIErrorInfo
object
3 properties
CampaignGoalOptimizeFixedCpmPacing
object
General fixed-cpm goal with pacing option. Currently for FIXEDCPMFORCTV and FIXEDCPMGENERIC.
3 properties
1 required
CampaignGoalOptimizeClicksToWebMode
string
commonPostbackEventCount
object
Postback Event Count. It specifies an interval for a list of events from an app bundle.
3 properties
CampaignGoalOptimizeLandingForWebUaMode
string
CampaignGoalOptimizeFixedCpm
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
messagesDeleteAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPCANNOTDELETEONLYCHILD: Cannot delete the specified AdGroup, which is the only child of the Campaign.
CampaignGoalOptimizeCpaForAppUaMode
string
commonLatLng
object
Point defines a geo location by latitude, longitude.
2 properties
dspAdGroupOverview
object
AdGroupOverview is an overview information of AdGroup entity.
12 properties
dspCampaignState
string
CampaignState represents various states of a Campaign. This value is not part of the specification. - SUBMITTED: All the required data are entered and passed a…
AudienceTargetingConditionPlacementReason
string
The reason of the placement. It is used to track the reason why customers set the allowed or blocked app's.
AudienceTargetingConditionLocationSet
object
LocationSet represents target areas to allow or block. If multiple fields are set, a union of them is used.
2 properties
messagesListAdGroupsErrorAPIErrorInfo
object
3 properties
adclouddspAdCapper
object
AdCapper represents capping settings for an AdGroup.
1 property
CampaignGoalOptimizeLandingForWebUa
object
2 properties
CampaignGoalOptimizeAppInstalls
object
4 properties
messagesDeleteAdGroupErrorAPIErrorInfo
object
3 properties
AudienceTargetingConditionRecentCampaignActivityFilter
object
Recent Campaign activities for the targeted user.
3 properties
3 required
dspAudienceTargetingConditionVideoType
string
This value is not part of the specification.
commonAdvertiserIdType
string
Enumeration of supported ID types for advertises. This value is not part of the specification. - ANDROIDIDFA: IDFA used in Android. - IOSIDFA: IDFA used in iOS…
CampaignGoalOptimizeAppRoasMode
string
CampaignGoalOptimizeCpaForAppRe
object
Detailed configuration of OPTIMIZECPAFORAPPRE goal.
4 properties
1 required
messagesCreateAdGroupErrorAPIErrorInfo
object
3 properties
commonAdExchange
string
Enumeration of ad exchanges supported by Moloco Ads. - SIGNALPLAY: MANPLUS == SIGNALPLAY. just added for distinguishing video and banner report - MOLOCOSDK: Us…
messagesReadAdGroupError
object
3 properties
adcloudcommonCurrency
string
Enumeration of currencies supported by Moloco Ads. This value is not part of the specification. - USD: US Dollar. - KRW: Korean Won. - JPY: Japanese Yen. - EUR…
CampaignGoalOptimizeRoasForAppRe
object
Detailed configuration of OPTIMIZEROASFORAPPRE goal.
4 properties
1 required
CampaignGoalOptimizeCpaRepeatedForAppUa
object
Detailed configuration of OPTIMIZECPAREPEATEDFORAPPUA goal.
3 properties
1 required
CampaignGoalOptimizeAppRetentionMode
string
adcloudcommonMoney
object
Represents a monetary amount in micros for a specified currency. It's the amount in the specified currency's base denomination unit multiplied with 1 million.…
2 properties
adcloudcommonDayOfWeek
string
Enumeration for week days. This value is not part of the specification.
dspAudienceTargetingCondition
object
AudienceTargetingCondition specifies conditions for AudienceTargeting. This condition object contains various filters on multiple dimensions of bid-request, ap…
90 properties
commonPostbackEventsCondition
object
Postback Events Condition.
7 properties
messagesReadAdGroupErrorAPIErrorInfoErrorReason
string
adclouddspAudience
object
Audience is a final form of AudienceTargeting specification. It is represented by a list of IDs of SharedAudienceTargets and an ad-hoc target condition. All co…
2 properties
adcloudcommonTimezonePolicy
string
TimezonePolicy defines the time configuration. - DEVICETIME: Time object is given in the device's time (depends on user device timezone). - UTCTIME: Time objec…
commonTimeUnit
string
A unit of time, e.g. second, minute, etc. This value is not part of the specification.
CampaignGoalOptimizeCpcForAppRe
object
Detailed configuration of OPTIMIZECPCFORAPPRE goal.
4 properties
AudienceTargetingConditionNewUserFilter
object
Filter to target new users only.
1 property
1 required
commonAudienceData
object
Audience Data. It is a filter based on AudienceData stored in UPT.
2 properties
messagesUpdateAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPTARGETDUPLICATEDADPLATFORM: AdGroup has duplicated targeting ad platform. - ADGROUPADPLATFORMSSHOULDBESUBSETOFCAMPAIGN: AdGroup's targeting ad platfor…
CampaignGoalOptimizeClicksToWeb
object
Detailed configuration of OPTIMIZECPCFORWEBVISIT goal.
3 properties
messagesCreateAdGroupError
object
3 properties
CampaignGoalOptimizeAppReattributionMode
string
messagesDeleteAdGroupResponse
object
CampaignGoalOptimizeCpcForAppReMode
string
AudienceTargetingConditionWeeklyScheduleFilter
object
WeeklyScheduleFilter specifies a time range on certain days of a week.
3 properties
1 required
CampaignGoalOptimizeCpaForAppReMode
string
messagesUpdateAdGroupResponse
object
1 property
CampaignGoalOptimizeFixedCpmPacingPacingMode
string
Force pacing option.
messagesReadAdGroupResponse
object
1 property
AudienceTargetingConditionCustomAudienceSet
object
CustomAudienceSet represents a group of target users to whom we're going to show an ad. CustomAudienceSet is consist of a dynamic (not pre-determined) set of t…
4 properties
commonTimeDuration
object
Represents a time duration with an amount and a unit.
2 properties
messagesListAdGroupsError
object
3 properties
LocationSetZipCodeSet
object
2 properties
commonDisplayManagerVersion
object
Display Manager Version.
2 properties
commonDeviceOs
string
Enumeration of device OS types supported by Moloco Ads. This value is not part of the specification. - ANDROID: Android device OS. - IOS: iOS device OS. - VERS…
CustomAudienceSetApp
object
App matches a user based on app engagement within a time window. Use AppEvent when targeting a specific event by name.
2 properties
dspAdGroup
object
AdGroup represents the seed information for a full AdGroup used by bidders.
18 properties
1 required
AudienceTargetingConditionLocationFilter
object
LocationFilter represents a geolocationcal condition using different related conditions. The condition will be met if any of the listed conditions is met.
4 properties
commonDeviceType
string
Enumeration of device types supported by Moloco Ads. This value is not part of the specification.
messagesReadAdGroupErrorAPIErrorInfo
object
3 properties
dspCampaignType
string
CampaignType represents the type of a Campaign. It captures the goal of the Campaign at a high level. This value is not part of the specification. - GENERIC: C…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MOLOCO publishes across the network.
