The identity and technical contract details declared by the specification.
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…
commonLatLng
object
Point defines a geo location by latitude, longitude.
2 properties
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…
CustomAudienceSetAppEvent
object
3 properties
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
CampaignGoalOptimizeFixedCpm
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
messagesDeleteAdGroupErrorAPIErrorInfo
object
3 properties
messagesCreateAdGroupErrorAPIErrorInfo
object
3 properties
adcloudcommonCreativeType
string
Enumeration of creative types supported by Moloco Ads. This value is not part of the specification.
LocationSetZipCodeSet
object
2 properties
CampaignGoalOptimizeAppReattribution
object
Detailed configuration of OPTIMIZEREATTRIBUTIONFORAPP goal.
2 properties
dspAdGroup
object
AdGroup represents the seed information for a full AdGroup used by bidders.
18 properties
1 required
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…
AudienceTargetingConditionWeeklyScheduleFilter
object
WeeklyScheduleFilter specifies a time range on certain days of a week.
3 properties
1 required
CampaignGoalOptimizeAppInstalls
object
4 properties
commonTimeInterval
object
Interval with start and end timestamps in RFC3339 format.
2 properties
adclouddspAdCapper
object
AdCapper represents capping settings for an AdGroup.
1 property
messagesListAdGroupsErrorAPIErrorInfoErrorReason
string
messagesDeleteAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPCANNOTDELETEONLYCHILD: Cannot delete the specified AdGroup, which is the only child of the Campaign.
messagesReadAdGroupError
object
3 properties
CampaignGoalOptimizeCpaForAppReMode
string
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…
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…
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…
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
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…
CampaignGoalOptimizeAppReattributionMode
string
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
CampaignGoalOptimizeCpaRepeatedForAppUa
object
Detailed configuration of OPTIMIZECPAREPEATEDFORAPPUA goal.
3 properties
1 required
CampaignGoalOptimizeClicksToAppMode
string
CampaignGoalOptimizeLandingForWebUaMode
string
CampaignGoalOptimizeFixedCpmPacing
object
General fixed-cpm goal with pacing option. Currently for FIXEDCPMFORCTV and FIXEDCPMGENERIC.
3 properties
1 required
commonCircle
object
Circle defines a circle with a center geo location and radius in km.
2 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…
messagesReadAdGroupErrorAPIErrorInfo
object
3 properties
commonEnablingState
string
Enumeration of the enabling states with a default UNSPECIFIED state.
commonDisplayManagerVersion
object
Display Manager Version.
2 properties
commonDeviceType
string
Enumeration of device types supported by Moloco Ads. This value is not part of the specification.
messagesUpdateAdGroupErrorAPIErrorInfo
object
3 properties
messagesListAdGroupsError
object
3 properties
dspAudienceTargetingConditionVideoType
string
This value is not part of the specification.
adcloudcommonInterval
object
Interval represents a contiguous integer range [start, end).
2 properties
messagesUpdateAdGroupError
object
3 properties
CampaignGoalOptimizeCpaForAppUaMode
string
messagesReadAdGroupResponse
object
1 property
messagesCreateAdGroupResponse
object
1 property
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
CampaignGoalOptimizeAppRoasMode
string
CampaignGoalOptimizeCpaForAppUa
object
Detailed configuration of OPTIMIZECPAFORAPPUA goal.
5 properties
1 required
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
CampaignGoalOptimizeAppRoas
object
6 properties
1 required
dspCampaignGoal
object
CampaignGoal describes the details of goal of a Campaign.
17 properties
1 required
CampaignGoalOptimizeCpaForWebUa
object
3 properties
1 required
CampaignGoalOptimizeAppRetention
object
Detailed configuration of OPTIMIZERETENTIONFORAPPUA goal.
4 properties
CampaignGoalOptimizeRoasForAppRe
object
Detailed configuration of OPTIMIZEROASFORAPPRE goal.
4 properties
1 required
AudienceTargetingConditionPlacementReason
string
The reason of the placement. It is used to track the reason why customers set the allowed or blocked app's.
CampaignGoalOptimizeLandingForWebUa
object
2 properties
CampaignGoalOptimizeClicksToWebMode
string
CustomAudienceSetCustomAudienceCondition
object
3 properties
AudienceTargetingConditionLocationSet
object
LocationSet represents target areas to allow or block. If multiple fields are set, a union of them is used.
2 properties
dspAdGroupAudienceExtension
object
AdGroupAudienceExtension holds the adgroup settings for PAS audience extension.
2 properties
AudienceTargetingConditionMediaChannelType
string
- UNKNOWNMEDIACHANNELTYPE: This value is not part of the specification.
commonPostbackEventCount
object
Postback Event Count. It specifies an interval for a list of events from an app bundle.
3 properties
commonGender
string
Enumeration of gender types. This value is not part of the specification.
dspAdGroupOverview
object
AdGroupOverview is an overview information of AdGroup entity.
12 properties
messagesCreateAdGroupError
object
3 properties
messagesListAdGroupsResponse
object
2 properties
messagesCreateAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPPRICINGMODELNOTSUPPORTEDFORCAMPAIGNTYPE: unsupported pricing model id for direct sold ad or house ad. - ADGROUPTARGETDUPLICATEDADPLATFORM: AdGroup has…
CampaignGoalOptimizeAppRetentionMode
string
commonAudienceData
object
Audience Data. It is a filter based on AudienceData stored in UPT.
2 properties
AudienceTargetingConditionNewUserFilter
object
Filter to target new users only.
1 property
1 required
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…
CampaignGoalOptimizeFixedCpmPacingPacingMode
string
Force pacing option.
CampaignGoalOptimizeCpcForAppRe
object
Detailed configuration of OPTIMIZECPCFORAPPRE goal.
4 properties
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
messagesUpdateAdGroupResponse
object
1 property
CampaignGoalOptimizeCpcForAppReMode
string
CampaignGoalOptimizeAppInstallsMode
string
- FIXED: Read-only for AdCloud.
CampaignGoalOptimizeClicksToWeb
object
Detailed configuration of OPTIMIZECPCFORWEBVISIT goal.
3 properties
messagesListAdGroupsErrorAPIErrorInfo
object
3 properties
messagesDeleteAdGroupResponse
object
dspAudienceTargetingCondition
object
AudienceTargetingCondition specifies conditions for AudienceTargeting. This condition object contains various filters on multiple dimensions of bid-request, ap…
90 properties
commonAdExchange
string
Enumeration of ad exchanges supported by Moloco Ads. - SIGNALPLAY: MANPLUS == SIGNALPLAY. just added for distinguishing video and banner report - MOLOCOSDK: Us…
AudienceTargetingConditionRecentCampaignActivityFilter
object
Recent Campaign activities for the targeted user.
3 properties
3 required
CampaignGoalOptimizeCpaRepeatedForAppUaMode
string
messagesUpdateAdGroupErrorAPIErrorInfoErrorReason
string
- ADGROUPTARGETDUPLICATEDADPLATFORM: AdGroup has duplicated targeting ad platform. - ADGROUPADPLATFORMSSHOULDBESUBSETOFCAMPAIGN: AdGroup's targeting ad platfor…
adcloudcommonFloatingPointRange
object
2 properties
messagesReadAdGroupErrorAPIErrorInfoErrorReason
string
CampaignGoalOptimizeCpaForWebUaMode
string
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…
messagesDeleteAdGroupError
object
3 properties
CampaignGoalOptimizeCpaForAppRe
object
Detailed configuration of OPTIMIZECPAFORAPPRE goal.
4 properties
1 required
adcloudcommonDayOfWeek
string
Enumeration for week days. This value is not part of the specification.
commonTimeUnit
string
A unit of time, e.g. second, minute, etc. This value is not part of the specification.
commonTimeDuration
object
Represents a time duration with an amount and a unit.
2 properties
commonPostbackEventsCondition
object
Postback Events Condition.
7 properties
CampaignGoalOptimizeClicksToApp
object
Detailed configuration of OPTIMIZECPCFORAPPUA goal.
3 properties
AudienceTargetingConditionDeviceOsFilter
object
Device OS and version filter condition.
3 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MOLOCO publishes across the network.
