The identity and technical contract details declared by the specification.
messagesUpdateCreativeGroupErrorAPIErrorInfoErrorReason
string
- CREATIVEGROUPFEATURETYPENOTMATCHCREATIVEFEATURETYPE: The feature type of Creative should match the feature type of Creative Group. - CREATIVEGROUPNEEDSPRODUC…
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.
messagesDeleteCreativeGroupErrorAPIErrorInfoErrorReason
string
messagesReadCreativeGroupResponse
object
4 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
dspCreativeDynamicHtmlSrcPolicy
object
Policy defines how to select CatalogItems.
5 properties
dspCreativeGroupAction
object
The details of an action taken on the CreativeGroup.
6 properties
dspCreativeDynamicHtmlSrc
object
(Will be supported soon) Dynamic Creative. An instance of this would be used for Creatives to be rendered when the Creative is shown to user, i.e. an impressio…
6 properties
2 required
dspAdvertiserInfo
object
AdvertiserInfo contains some basic information about an advertiser. It may be returned to Creative reviewers or other users with other non-advertiser roles to…
3 properties
CampaignGoalOptimizeAppRoas
object
6 properties
1 required
dspCreativeGroupOverview
object
CreativeGroupOverview is an overview information of CreativeGroup entity. Retrieved when the inquiryoption = INQUIRYOVERVIEW.
17 properties
CampaignGoalOptimizeAppRetention
object
Detailed configuration of OPTIMIZERETENTIONFORAPPUA goal.
4 properties
dspCreativeVastVideoSrc
object
Source of VAST (Video Ad Serving Template) video Creative.
4 properties
1 required
PolicyFunctionConfigGameConfig
object
1 property
messagesReadCreativeGroupError
object
3 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
googlerpcStatus
object
3 properties
messagesUpdateCreativeGroupError
object
3 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…
CreativeFeatureDynamicCreative
object
Detailed configuration of DYNAMICCREATIVE feature.
15 properties
dspCreativeRichCustomHtmlSrc
object
Creative source based on arbitrary HTML. An instance of this is typically used for a playable Creative from AdAccounts. You can create RichCustomHtmlSrc by one…
6 properties
1 required
PolicyPolicyFunctionConfig
object
Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy - CatalogItem/CreativeElement list.
5 properties
adcloudcommonFloatingPointRange
object
2 properties
messagesDeleteCreativeGroupError
object
3 properties
PolicyFunctionConfigModelConfig
object
4 properties
commonGender
string
Enumeration of gender types. This value is not part of the specification.
dspCreativeCustomHtmlSrc
object
(Will be supported soon) Creative source based on custom html.
4 properties
4 required
commonTimeInterval
object
Interval with start and end timestamps in RFC3339 format.
2 properties
CampaignGoalOptimizeCpaRepeatedForAppUaMode
string
dspCreativeGroupReferrerInfo
object
CreativeGroupReferrerInfo is CreativeGroup's relational data. It contains which Campaign and AdGroup use the CreativeGroup.
13 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…
CampaignGoalOptimizeClicksToAppMode
string
CustomAudienceSetCustomAudienceCondition
object
3 properties
adcloudcommonCreativeFeatureType
string
CreativeFeatureType.
dspCreativeGroupPublisherProperties
object
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…
dspCreativeGroup
object
CreativeGroup is a group of Creatives that may serve with the same purpose, to be referenced by a Campaign.
18 properties
1 required
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.
dspCreativeFeature
object
CreativeFeature indicates the feature of the CreativeGroup and its configuration.
2 properties
CampaignGoalOptimizeAppReattribution
object
Detailed configuration of OPTIMIZEREATTRIBUTIONFORAPP goal.
2 properties
CampaignGoalOptimizeCpaForWebUa
object
3 properties
1 required
TrackingLinkVerificationAttemptUrlDataType
string
The type of the UrlData that this attempt belongs to.
AudienceTargetingConditionMediaChannelType
string
- UNKNOWNMEDIACHANNELTYPE: This value is not part of the specification.
AudienceTargetingConditionDeviceOsFilter
object
Device OS and version filter condition.
3 properties
1 required
dspCreativeType
string
Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified. - UNKNOWNTYPE: This value is not part of the specifi…
CustomAudienceSetAppEvent
object
3 properties
TrackingLinkUrlData
object
5 properties
1 required
CampaignGoalOptimizeFixedCpmPacing
object
General fixed-cpm goal with pacing option. Currently for FIXEDCPMFORCTV and FIXEDCPMGENERIC.
3 properties
1 required
messagesCopyCreativeGroupsSyncRequest
object
6 properties
4 required
CampaignGoalOptimizeClicksToWebMode
string
dspCreativeGroupStatus
string
Enumeration of all possible CreativeGroup status. - UNKNOWNSTATUS: This value is not part of the specification. - DRAFT: The CreativeGroup is created but not s…
commonPostbackEventCount
object
Postback Event Count. It specifies an interval for a list of events from an app bundle.
3 properties
CampaignGoalOptimizeLandingForWebUaMode
string
dspTrackingLinkVerificationAttempt
object
TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink.
12 properties
CampaignGoalOptimizeFixedCpm
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
CampaignGoalOptimizeCpaForAppUaMode
string
commonLatLng
object
Point defines a geo location by latitude, longitude.
2 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…
dspCreativeHtmlRequirementAttributesFlag
string
This value is not part of the specification. - MRAID2: AdX: 32 MraidType: MRAID. - INBANNERVIDEO: AdX: 95 VideoType: In-Banner Video (Publisher Blockable).
CreativeHtmlSizeAttributesFixed
object
2 properties
messagesListCreativeGroupsError
object
3 properties
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
PolicyFunctionConfigMcmItemRecommendationConfig
object
2 properties
CampaignGoalOptimizeLandingForWebUa
object
2 properties
messagesCreateCreativeGroupErrorAPIErrorInfoErrorReason
string
- CREATIVEMUSTBEASSETURL: image URL should be asset url but user used wrong url by its prefix. - CREATIVEVIDEOTYPESHOULDHAVESINGLECOMPANIONIMAGE: video type sh…
CampaignGoalOptimizeAppInstalls
object
4 properties
dspCreativeImageSrc
object
Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x…
5 properties
AudienceTargetingConditionRecentCampaignActivityFilter
object
Recent Campaign activities for the targeted user.
3 properties
3 required
dspReadCreativeGroupOverview
object
ReadCreativeGroupOverview is an overview information of CreativeGroup entity. Retrieved when the inquiryoption = INQUIRYOVERVIEW.
4 properties
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…
PolicyPolicyFunction
string
PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - INCART: GLOBALTREND will be deprecated and replaced by TREND. Du…
CampaignGoalOptimizeAppRoasMode
string
CampaignGoalOptimizeCpaForAppRe
object
Detailed configuration of OPTIMIZECPAFORAPPRE goal.
4 properties
1 required
messagesDeleteCreativeGroupsBulkResponse
object
commonAdExchange
string
Enumeration of ad exchanges supported by Moloco Ads. - SIGNALPLAY: MANPLUS == SIGNALPLAY. just added for distinguishing video and banner report - MOLOCOSDK: Us…
PolicyItemCapperFrequency
object
Frequency represents frequency capping. One can specify "at most 3 exposures per 1 hour" by setting: { "period": "1h", "maxexposures": 3 } This means, when a u…
2 properties
TrackingLinkUrlDataVerificationStatus
string
Enumeration of various TrackingLink verification status. This value is not part of the specification. - UNVERIFIED: The TrackingLink is not yet verified. - VER…
dspCreativeNativeSrc
object
Source of native Creative.
10 properties
5 required
UrlDataUnverifiedStatusData
object
UnverifiedStatusData represents the information that the link is statically checked, but has not been verified with the MMP integration.
2 properties
CreativeHtmlRequirementAttributesCustomCloseType
string
The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOMCLOSETYPENONE: It does not use useCustomClose()…
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…
UrlDataVerifyingStatusData
object
VerifyingStatusData represents the information that a resolved URL has been sent to the MMP, but we have not received any postback yet. We stay at this state i…
1 property
CampaignGoalOptimizeRoasForAppRe
object
Detailed configuration of OPTIMIZEROASFORAPPRE goal.
4 properties
1 required
CampaignGoalOptimizeCpaRepeatedForAppUa
object
Detailed configuration of OPTIMIZECPAREPEATEDFORAPPUA goal.
3 properties
1 required
CampaignGoalOptimizeAppRetentionMode
string
PolicyEvaluatorType
string
EvaluatorType defines the type of evaluator for the model.
messagesListCreativeGroupsErrorAPIErrorInfoErrorReason
string
PolicyFunctionConfigTrendConfig
object
TREND PolicyFunction's config.
1 property
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.
adcloudcommonTrackingCompany
string
Enumeration for tracking companies supported by Moloco Ads. - WEB: Unnamed trackers - AIRBRIDGE: Moloco's e2e tracker (test purpose only) - KOCHAVAFORPUBLISHER…
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
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…
messagesUpdateCreativeGroupResponse
object
3 properties
CreativeVideoSrcTranscodingInfoStatus
string
- INPROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found fr…
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
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
CampaignGoalOptimizeClicksToWeb
object
Detailed configuration of OPTIMIZECPCFORWEBVISIT goal.
3 properties
dspCreativeTemplateHtmlSrc
object
(Will be supported soon) Creative source based on MRAID template.
6 properties
2 required
messagesDeleteCreativeGroupResponse
object
messagesReadCreativeGroupErrorAPIErrorInfo
object
3 properties
CampaignGoalOptimizeAppReattributionMode
string
CreativeRichCustomHtmlSrcPlayableADSourceData
object
2 properties
dspCreativeGroupInactiveReason
string
InActiveReason indicates why the CreativeGroup is not used for bidding. This value is not part of the specification. - NOCREATIVE: NOCREATIVE implies that the…
protobufAny
object
1 property
messagesDeleteCreativeGroupErrorAPIErrorInfo
object
3 properties
dspCreative
object
Creative contains all data and assets required to visually render an ad. One and only one of the sources must be specified for the Creative.
22 properties
2 required
CreativeVideoSrcTranscodingInfo
object
2 properties
CampaignGoalOptimizeCpcForAppReMode
string
messagesCreateCreativeGroupErrorAPIErrorInfo
object
3 properties
dspCreativeHtmlSizeAttributes
object
Size-related attributes for a resizable Creative, such as an HTML-based one. This message acts as a filter condition; if an inventory is matched with the condi…
2 properties
messagesListCreativeGroupsErrorAPIErrorInfo
object
3 properties
messagesUpdateCreativeGroupErrorAPIErrorInfo
object
3 properties
dspTrackingLink
object
TrackingLink represents an AdAccount's configuration for.
12 properties
3 required
dspCreativeVideoSrc
object
Source of video Creative. Supported format: MP4. Maximum file size: 300MB (before transcoding). At least one of width or height must be ≥ 640px. Duration: 6–18…
12 properties
4 required
messagesCreateCreativeGroupError
object
3 properties
AudienceTargetingConditionWeeklyScheduleFilter
object
WeeklyScheduleFilter specifies a time range on certain days of a week.
3 properties
1 required
messagesReadCreativeGroupErrorAPIErrorInfoErrorReason
string
PolicySourcerType
string
SourcerType defines the type of sourcer for the model.
CreativeHtmlRequirementAttributesAutoPlayAudioType
string
The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTOPLAYAUDIOTYPEMUTED: It does not play audio a…
CreativeRichCustomHtmlSrcPlayableADSourceType
string
- PLAYABLEADSOURCETYPEURL: Source is a URL of the playable ad html. (facebook style). - PLAYABLEADSOURCETYPETAG: Source is a playable ad html tag generated by…
messagesCreateCreativeGroupResponse
object
3 properties
CampaignGoalOptimizeCpaForAppReMode
string
CampaignGoalOptimizeFixedCpmPacingPacingMode
string
Force pacing option.
PolicyFunctionConfigNextItemSelectionConfig
object
NEXTITEMSELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level.
messagesListCreativeGroupsResponse
object
2 properties
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
dspCreativeHtmlRequirementAttributes
object
Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served.
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…
CopyCreativeGroupsSyncResponseCopyCreativeGroupsSyncFailedLog
object
The failed log which contains failed CreativeGroup ID and reason.
2 properties
CreativeGroupActionType
string
Enumeration of all supported CreativeGroup action types. - UNKNOWNTYPE: This value is not part of the specification. - CREATE: The user created the CreativeGro…
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
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
CreativeVideoSrcTargetAdPosition
string
Target ad position for the video source.
messagesCopyCreativeGroupsSyncResponse
object
2 properties
commonDeviceType
string
Enumeration of device types supported by Moloco Ads. This value is not part of the specification.
PolicyItemCapper
object
Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across Creati…
1 property
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…
UrlDataVerifiedStatusData
object
VerifiedStatusData represents the information of the completed verification.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MOLOCO publishes across the network.