MOLOCO Campaign API
The Campaign API from MOLOCO — 9 operation(s) for campaign.
MOLOCO Campaign API is one of 41 APIs that MOLOCO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Campaign. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 15 operations across 9 paths, and defines 311 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://, https://api.moloco.cloud.
15 operations
9 paths
311 schemas
1 DELETE6 GET4 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
MOLOCO Campaign API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuth).
An API key is passed in the header as Authorization (Bearer).
Bearer— Note that the bearer authentication has been deprecated. Please refer [API and SSO Credential Management](https://mcm-docs.moloco.com/docs/api-key-and-sso-secr…
Paths & Operations 15
Across 9 paths, the API surfaces 15 operations — 1 DELETE, 6 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Campaign 15
GET
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews
ListCampaignReviews
POST
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews
CreateCampaignReview
PUT
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews-bulk
UpdateCampaignReviewsBulk
PUT
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-reviews/{brand_entity_id}
UpdateCampaignReview
GET
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns
ListCampaigns
POST
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns
CreateCampaign
GET
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}
ReadCampaign
PUT
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}
UpdateCampaign
POST
/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaigns/{campaign_id}/items
QueryItemsCampaign
GET
/cm/v1/campaign-overviews
Query given Campaigns' setting overview
GET
/cm/v1/campaigns
List up Campaigns.
POST
/cm/v1/campaigns
Create a new Campaign.
GET
/cm/v1/campaigns/{campaign_id}
Read an existing Campaign.
DELETE
/cm/v1/campaigns/{campaign_id}
Delete an existing Campaign.
PUT
/cm/v1/campaigns/{campaign_id}
Update an existing Campaign.
Schemas 311
The contract defines 311 schemas that model the data the API accepts and returns. The most detailed are dspAudienceTargetingCondition (90 properties), dspCampaign (27 properties), ProductAppProperties (25 properties), dspCreative (22 properties). Each schema is shown below with its type and property counts.
SearchSettingKeywordSetting
object
KeywordSetting describes target keyword targeting settings for the campaign
3 properties
1 required
AudienceSettingEventBasedListCondition
object
Condition describes event based audience targeting condition for the campaign
4 properties
3 required
commonCampaignEnablingState
string
campaign’s enabling state that the advertiser can enable/disable. It will affect the campaign’s state.
campaignAdOperationType
string
rmpcommonBudgetPeriod
string
TargetingPlacementSetting
object
PlacementSetting describes target placement targeting settings for the campaign
7 properties
publicUpdateCampaignRequestCampaignParamsCampaignLandingPageParams
object
Detailed settings for the landing page.
7 properties
1 required
CampaignLandingPageProductListSetting
object
Detailed configuration of the product list page.
AudienceSettingEventBasedList
object
EventBasedList describes event based audience targeting settings for the campaign
2 properties
2 required
commonCampaignKeywordMatchType
string
CampaignKeywordMatchType enumerates available match types for positive keyword targeting.
v1ItemSearchResultRow
object
ItemSearchResultRow represents a row of item search results.
18 properties
publicRepresentedError
object
3 properties
3 required
KeywordSettingNegativeKeyword
object
NegativeKeyword describes target negative keyword targeting settings for the campaign
1 property
1 required
publicUpdateCampaignResponse
object
UpdateCampaign response.
1 property
1 required
commonfilterFilterOperator
string
v1CampaignReview
object
Definition of a campaign review.
8 properties
4 required
PlacementSettingCategorySetting
object
Targeting setting of the Category Placement.
2 properties
1 required
publicItemSearchResponse
object
ItemSearch response
2 properties
2 required
KeywordSettingPositiveKeyword
object
PositiveKeyword describes target positive keyword targeting settings for the campaign
3 properties
2 required
TargetingCustomSettingCustomTarget
object
CustomTarget describes target custom targeting for the campaign
2 properties
2 required
v1CampaignUpsertOption
object
CampaignUpsertOption describes the option when campaign is created or updated.
2 properties
commonAssetBanner
object
7 properties
PlacementSettingRankingSetting
object
Targeting setting of the Ranking Placement.
2 properties
1 required
v1Campaign
object
Definition of a campaign.
21 properties
7 required
publicListCampaignsResponse
object
ListCampaigns response.
2 properties
1 required
commonReviewStatus
string
TargetingAudienceSettingPredefinedAudience
object
PredefinedAudience describes predefined audience used for the campaign.
1 property
1 required
publicCreateCampaignReviewResponse
object
CreateCampaignReview response.
1 property
1 required
CampaignGoalMaximizeSales
object
Detailed configuration of MAXIMIZESALES goal.
v1ItemSearchResultRowCategoryPath
object
1 property
AudienceConfigAudienceTargetingEventType
string
CampaignGoalOptimizeFixedCommissionRate
object
Detailed configuration of FIXEDCOMMISSIONRATE goal.
1 property
1 required
managementv1CampaignGoal
object
CampaignGoal describes which cost-metric goal a campaign aims for.
6 properties
1 required
PlacementSettingHomeSetting
object
Targeting setting of the Home Placement.
2 properties
1 required
publicUpdateCampaignRequestCampaignParams
object
List of params required to update a campaign.
15 properties
4 required
commonAsset
object
Detailed settings for the asset.
10 properties
TargetingAudienceSettingPredefinedAudienceListOperator
string
managementv1CampaignGoalOptimizeRoas
object
Detailed configuration of OPTIMIZEROAS goal.
1 property
1 required
SmartSelectionSettingExclude
object
Exclusion filters for Smart Selection.
1 property
TargetingPlacementSettingProductDetailSetting
object
Targeting setting of the Product Detail Placement.
2 properties
1 required
PlacementSettingSearchSetting
object
Targeting setting of the Search Placement.
3 properties
1 required
commonBrandEntityType
string
commonfilterQueryFilter
object
4 properties
commonOrderByDirection
string
CampaignLandingPageCampaignLandingPageType
string
publicCreateCampaignRequestCampaignParamsAssetParams
object
Detailed settings for the campaign asset.
5 properties
rmpcommonOrderByColumn
string
CampaignGoalOptimizeFixedCpm
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
commonAssetLogo
object
2 properties
publicListCampaignReviewsResponse
object
ListCampaignReviews response.
1 property
1 required
CampaignCampaignState
string
v1Targeting
object
Targeting describes the detailed targeting spec for the campaign.
3 properties
commonAssetCallToAction
object
1 property
PlacementSettingCheckoutSetting
object
Targeting setting of the Checkout Placement.
2 properties
1 required
AudienceSettingEventBasedListOperator
string
publicCreateCampaignResponse
object
CreateCampaign response.
1 property
1 required
publicUpdateCampaignReviewResponse
object
UpdateCampaignReview response.
1 property
1 required
PlacementSettingCartSetting
object
Targeting setting of the Cart Placement.
2 properties
1 required
publicReadCampaignResponse
object
ReadCampaign response.
1 property
1 required
RepresentedErrorDetail
object
3 properties
2 required
rmpcommonCampaignGoalType
string
CampaignGoalType enumerates available goal types of campaign, which is Immutable. - FIXEDCPC: Goal type for the campaigns should be set to OptimizeFixedCpc mes…
rmpcommonDimension
object
2 properties
2 required
publicUpdateCampaignReviewsBulkResponse
object
UpdateCampaignReviewsBulk response.
1 property
1 required
TargetingAudienceSettingPredefinedAudienceList
object
PredefinedAudienceList describes predefined audiences used for the campaign.
2 properties
2 required
commonKeywordType
string
KeywordType enumerates available keyword types for keyword targeting.
CampaignCampaignItemSelectionType
string
Type of item selection for campaign. Choose MANUALSELECTION to select items manually or SMARTSELECTION to let Moloco choose items automatically.
commonReviewInformation
object
3 properties
rmpcommonCurrency
string
Currency enumerates available currencies. - UNKNOWNCURRENCY: Unknown currency. - USD: US Dollar. - KRW: Korean Won. - JPY: Japanese Yen. - EUR: EU Euro. - GBP:…
publicCreateCampaignRequestCampaignParamsCampaignLandingPageParams
object
Detailed settings for the landing page.
4 properties
1 required
commonAssetHeadline
object
3 properties
rmpcommonMoneyMicro
object
A monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation. For example, {"currency": "USD", "amountm…
2 properties
2 required
commonCampaignLandingPage
object
Detailed settings for the landing page.
8 properties
1 required
TargetingCustomSetting
object
CustomSetting describes target custom targeting settings for the campaign
1 property
1 required
TargetingAudienceSetting
object
AudienceSetting describes audience targeting settings for the campaign
4 properties
publicItemSearchRequestOrderBy
object
2 properties
CampaignCampaignItemSelection
object
Item selection config of the campaign.
2 properties
commonErrorCategory
string
AudienceConfigAudienceTargetingCriteria
string
commonfilterFilterColumn
string
rmpcommonAdType
string
SmartSelectionSettingIncludeCategoryPath
object
Hierarchical category path represented as ordered levels.
1 property
rmpcommonTimeInterval
object
Campaign's interval with start and end timestamps in RFC3339 format. The Campaign will conceptually run during [schedulestart, scheduleend] inclusively. It is…
2 properties
1 required
commonAssetMetadata
object
1 property
CampaignItemSelectionSmartSelectionSetting
object
Configuration for Smart Selection filtering (e.g. brands, categories, on-sale, exclusions list).
2 properties
publicUpdateCampaignRequestCampaignParamsAssetParams
object
Detailed settings for the campaign asset.
8 properties
managementv1CampaignGoalOptimizeFixedCpc
object
Detailed configuration of FIXEDCPC goal.
1 property
1 required
rmpcommonBudget
object
Budget describes the amount of budget to be consumed during the designated period.
2 properties
2 required
CampaignLandingPageCustomUrlSetting
object
Detailed configuration of a custom url landing page.
1 property
1 required
SmartSelectionSettingInclude
object
Inclusion filters for Smart Selection.
3 properties
commonAssetCustomText
object
Custom text for the asset.
3 properties
commonCampaignLandingPageProductDetailSetting
object
Detailed configuration of the product detail page.
1 property
1 required
rmpcommonMediaType
string
rmpcommonMoney
object
A monetary amount in a specific currency. For example, {currency: "USD", amount: 12.34} means $12.34. Price of the single item.
2 properties
2 required
publicCreateCampaignRequestCampaignParams
object
List of params required to create a campaign.
16 properties
4 required
MmpIntegrationMmpContext
object
1 property
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
messagesListCampaignsError
object
3 properties
CampaignGoalOptimizeClicksToApp
object
Detailed configuration of OPTIMIZECPCFORAPPUA goal.
3 properties
dspPostbackIntegration
object
PostbackIntegration represents the postback integration information.
2 properties
commonEnablingState
string
Enumeration of the enabling states with a default UNSPECIFIED state.
CvConfigurationForSkanV4EventsPostback
object
4 properties
messagesUpdateCampaignResponse
object
2 properties
AppPropertiesIosSecondaryMeasurement
string
Secondary measurement used for iOS apps. - IOSSECONDARYMEASUREMENTUNKNOWN: Zero value. Every non-iOS app must have this value. - IOSSECONDARYMEASUREMENTNONE: U…
dspAdAccount
object
AdAccount represents a person or organization who owns Products and aims to promote the Products with advertising Campaigns.
10 properties
1 required
CustomerActivityActivityCondition
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
messagesListCampaignsResponse
object
1 property
messagesCreateCampaignResponse
object
3 properties
dspCreativeDynamicHtmlSrcPolicy
object
Policy defines how to select CatalogItems.
5 properties
dspCampaign
object
Campaign represents a single advertising Campaign.
27 properties
6 required
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
dspCreativeGroupAction
object
The details of an action taken on the CreativeGroup.
6 properties
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
CampaignGoalOptimizeAppRetention
object
Detailed configuration of OPTIMIZERETENTIONFORAPPUA goal.
4 properties
dspCreativeVastVideoSrc
object
Source of VAST (Video Ad Serving Template) video Creative.
4 properties
1 required
messagesDeleteCampaignError
object
3 properties
PolicyFunctionConfigGameConfig
object
1 property
dspCampaignGoal
object
CampaignGoal describes the details of goal of a Campaign.
17 properties
1 required
messagesListCampaignsErrorAPIErrorInfoErrorReason
string
commonLaunchNotice
object
LaunchNotice contains notice information to be confirmed when launching a campaign.
2 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
googlerpcStatus
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…
dspAdGroupAudienceExtension
object
AdGroupAudienceExtension holds the adgroup settings for PAS audience extension.
2 properties
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
PolicyFunctionConfigModelConfig
object
4 properties
dspCreativeCustomHtmlSrc
object
(Will be supported soon) Creative source based on custom html.
4 properties
4 required
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
CustomerSetStatusDetailErrorId
string
Error id is an indicator of the error type.
messagesCreateCampaignErrorAPIErrorInfoErrorReason
string
- CAMPAIGNSKANMUSTBEUNSETFORNONIOSCAMPAIGN: Cannot specify skadninput for non IOS campaign. - CAMPAIGNSKANMUSTBESETFORIOSCAMPAIGN: Must specify skadninput for…
dspCustomerSetStatus
string
Unknown status. - PREPARING: Premature status. - READY: Ready. - FAILED: Failed to be ready.
dspSharedAudienceTarget
object
SharedAudienceTarget represents a persisted AudienceTargetingCondition that can be shared across multiple Campaigns. It can be referenced by ID by other object…
10 properties
1 required
CampaignGoalOptimizeCpaRepeatedForAppUaMode
string
dspCreativeGroupReferrerInfo
object
CreativeGroupReferrerInfo is CreativeGroup's relational data. It contains which Campaign and AdGroup use the CreativeGroup.
13 properties
messagesCreateCampaignErrorAPIErrorInfo
object
3 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
ProductWebProperties
object
WebProperties defines the Web type Product specific properties. Should contain only one of 'app' or 'web'.
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…
CustomAudienceSetCustomAudienceCondition
object
3 properties
messagesListCampaignsErrorAPIErrorInfo
object
3 properties
adcloudcommonCreativeFeatureType
string
CreativeFeatureType.
dspCreativeGroupPublisherProperties
object
2 properties
messagesReadCampaignErrorAPIErrorInfoErrorReason
string
- CAMPAIGNALREADYARCHIVED: The target campaign is already archived.
CampaignGoalOptimizeCpaForAppUa
object
Detailed configuration of OPTIMIZECPAFORAPPUA goal.
5 properties
1 required
messagesDeleteCampaignResponse
object
adcloudcommonCreativeType
string
Enumeration of creative types supported by Moloco Ads. This value is not part of the specification.
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
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
dspProductType
string
Product type. - UNKNOWNTYPE: This value is not part of the specification. - APP: App type. - WEB: Web type.
SKAdNetworkInputTargetingState
string
Enumeration of all supported targeting state w.r.t SKAdNetwork traffic. TARGETALL, TARGETSKADNONLY, TARGETNONSKADNONLY is a predefined set of traffic. TARGETCU…
AppPropertiesIosPrimaryMeasurement
string
Primary measurement used for iOS apps. - IOSPRIMARYMEASUREMENTUNKNOWN: Zero value. Every non-iOS app must have this value. - IOSPRIMARYMEASUREMENTNONE: Unset v…
TrackingLinkUrlData
object
5 properties
1 required
CampaignGoalOptimizeFixedCpmPacing
object
General fixed-cpm goal with pacing option. Currently for FIXEDCPMFORCTV and FIXEDCPMGENERIC.
3 properties
1 required
MmpContextAdjustContext
object
2 properties
CampaignGoalOptimizeClicksToWebMode
string
commonPostbackEventCount
object
Postback Event Count. It specifies an interval for a list of events from an app bundle.
3 properties
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…
CampaignGoalOptimizeLandingForWebUaMode
string
dspTrackingLinkVerificationAttempt
object
TrackingLinkVerificationAttempt represents an attempt to verify a TrackingLink.
12 properties
CampaignGoalOptimizeFixedCpm_2
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
CampaignGoalOptimizeCpaForAppUaMode
string
messagesDeleteCampaignErrorAPIErrorInfo
object
3 properties
commonLatLng
object
Point defines a geo location by latitude, longitude.
2 properties
dspProduct
object
Product represents an app (per device OS) or a website that an AdAccount want to promote with a Campaign. A Campaign should be associated with a single Product.
15 properties
3 required
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…
messagesReadCampaignResponse
object
2 properties
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
AudienceTargetingConditionPlacementReason
string
The reason of the placement. It is used to track the reason why customers set the allowed or blocked app's.
dspAdTrackingAllowance
string
AdTrackingAllowance represents targeting conditions regarding personalized ad tracking. This value is not part of the specification. - NONLATONLY: Campaign wil…
ConversionValueConfigurationItemCvConfigurationForSkanV4Events
object
1 property
messagesCreateCampaignError
object
3 properties
ProductAppProperties
object
AppProperties defines the App type Product specific properties. Should contain only one of 'app' or 'web'.
25 properties
1 required
AudienceTargetingConditionLocationSet
object
LocationSet represents target areas to allow or block. If multiple fields are set, a union of them is used.
2 properties
messagesUpdateCampaignErrorAPIErrorInfo
object
3 properties
PolicyFunctionConfigMcmItemRecommendationConfig
object
2 properties
CustomerSetCustomerSetStatusDetail
object
5 properties
adclouddspAdCapper
object
AdCapper represents capping settings for an AdGroup.
1 property
CampaignGoalOptimizeLandingForWebUa
object
2 properties
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
TargetFuturePreferenceInfoProductScope
string
ProductScope indicates the scope of Product of which the target prefers.
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
ProductSuspensionActionType
string
The type which the current action achieves. - SUSPENDUNTIL: The current action is for product suspension until someday. - SUSPENDINDEFINITELY: The current acti…
CampaignGoalOptimizeCpaForAppRe
object
Detailed configuration of OPTIMIZECPAFORAPPRE goal.
4 properties
1 required
commonBannerApi
string
MmpIntegrationConversionValueConfigurationItem
object
Conversion value configuration. Show the valid item among the history in the storage entity. (Most recent item of which the effective date is not later than cu…
7 properties
dspCustomerSetIdType
string
- UNKNOWNIDTYPE: Unknown user ID type. - GOOGLEADID: Google Android advertising ID type. - APPLEIDFA: Apple iOS advertising ID type.
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
CvConfigurationForCustomEventsEventList
object
1 property
dspCustomerSet
object
CustomerSet represents a group of user identifiers can be used in Moloco Ads. (e.g. Targeting, Audience Lift model generation and so on).
13 properties
3 required
CvConfigurationAutoRefreshAutoRefreshResult
string
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.
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
AppPropertiesAppEventType
string
AppEventType indicates standardized event types representing each in-app event.
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…
SKAdNetworkInputCustomOption
string
CustomOption enumerates all the available traffic. While the targetingstate other than 'TARGETCUSTOM' is a pre-defined set of traffic, CustomOption enables con…
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
dspMmpIntegrationStatus
string
LaunchNoticeNoticeMessage
string
- UNKNOWNMESSAGE: Default fallback for unrecognized message types. - MMPPROBABILISTICATTRIBUTIONSTATUSDISABLED: MMP Probabilistic Attribution (PA) is disabled.…
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…
CreativeVideoSrcTranscodingInfoStatus
string
- INPROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found fr…
dspWeeklyFlexibleBudgetSchedule
object
1 property
commonTimeUnit
string
A unit of time, e.g. second, minute, etc. This value is not part of the specification.
dspMmpIntegration
object
MmpIntegration represents the MMP integration information.
11 properties
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
messagesReadCampaignErrorAPIErrorInfo
object
3 properties
AudienceTargetingConditionNewUserFilter
object
Filter to target new users only.
1 property
1 required
CustomerSetFileUpdateInfo
object
3 properties
dspDailyBudgetSchedule
object
1 property
messagesDeleteCampaignErrorAPIErrorInfoErrorReason
string
ConversionValueConfigurationItemCvConfigurationForSingleEventEventInfo
object
2 properties
CampaignGoalOptimizeClicksToWeb
object
Detailed configuration of OPTIMIZECPCFORWEBVISIT goal.
3 properties
CustomerSetFileUpdateHistory
object
3 properties
dspCreativeTemplateHtmlSrc
object
(Will be supported soon) Creative source based on MRAID template.
6 properties
2 required
TargetFuturePreferenceInfoCustomProducts
object
CustomProducts stores Products' ids of which the target prefers.
1 property
CampaignGoalOptimizeAppReattributionMode
string
ConversionValueConfigurationItemCvConfigurationForCustomEvents
object
1 property
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…
FileUpdateInfoUpdateStatus
string
- INPROGRESS: Update is in progress. - SUCCESS: Update succeed. - FAILED: Update failed. Please check the contents format.
protobufAny
object
1 property
ConversionValueConfigurationItemCvConfigurationAutoRefresh
object
Settings for automatically importing and updating SKAdNetwork conversion value configuration from MMP.
4 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
ConversionValueConfigurationItemCvConfigurationForSingleEvent
object
1 property
CreativeVideoSrcTranscodingInfo
object
2 properties
CampaignGoalOptimizeCpcForAppReMode
string
CustomerSetStatusDetailConnectionMethod
string
Connection method is an indicator of how the customer set file is updated. - CLOUDAPI: Update via cloud API - MCPUPLOAD: MCP Upload - AFAUDIENCEBUILDER: AF Aud…
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
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
dspSKAdNetworkInput
object
SKAdNetworkInput represents various configurations w.r.t SKAdNetwork traffic. It's meaningful only for IOS. Use case in MCP: https://help.moloco.com/hc/en-us/a…
4 properties
AudienceTargetingConditionWeeklyScheduleFilter
object
WeeklyScheduleFilter specifies a time range on certain days of a week.
3 properties
1 required
messagesUpdateCampaignErrorAPIErrorInfoErrorReason
string
- CAMPAIGNSKANMUSTBEUNSETFORNONIOSCAMPAIGN: Cannot specify skadninput for non IOS campaign. - CAMPAIGNSKANMUSTBESETFORIOSCAMPAIGN: Must specify skadninput for…
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…
CampaignGoalOptimizeCpaForAppReMode
string
CampaignGoalOptimizeFixedCpmPacingPacingMode
string
Force pacing option.
ConversionValueConfigurationItemCvConfigurationForMultipleEvents
object
1 property
ConversionValueConfigurationItemConversionValueScheme
string
PolicyFunctionConfigNextItemSelectionConfig
object
NEXTITEMSELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level.
LaunchNoticeNoticeType
string
NoticeType defines the severity or category of the notice. - WARNING: Warning: Informational message that does not block the launch but requires attention. - D…
messagesReadCampaignError
object
3 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
AdAccountTargetFuturePreferenceInfo
object
TargetFuturePreferenceInfo contains each target's future preference information. If the newly created Campaign satisfies the condition of target future prefere…
2 properties
CampaignServingStatus
object
ServingStatus stores current serving status of the campaign, such as whether it is blocked and when it is blocked.
2 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…
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
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
CreativeVideoSrcTargetAdPosition
string
Target ad position for the video source.
messagesQueryCampaignOverviewsResponse
object
10 properties
dspBudgetSchedule
object
BudgetSchedule represents the AdAccount's plan for budget spending. Any change in this object takes effect immediately.
3 properties
ProductSuspensionAction
object
Product suspension action to block campaign activation under the product. The value can be updated only on Moloco's end.
8 properties
dspDayOfWeekBudgetSchedule
object
Budget for each day of the week; all 7-day budgets need be filled for use.
7 properties
commonDeviceType
string
Enumeration of device types supported by Moloco Ads. This value is not part of the specification.
ConversionValueConfigurationItemCvConfigurationForCustomEventsEventInfo
object
6 properties
3 required
messagesCampaignInput
object
3 properties
1 required
PolicyItemCapper
object
Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across Creati…
1 property
ProductSuspensionActionKind
string
The kind to represent whether the current action is newly created, or is for updating the previous action. - CREATE: This suspension action is independently cr…
AppPropertiesAppScreenshots
object
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…
ProductDynamicCreativeProperty
object
Dynamic Creative specific properties.
1 property
UrlDataVerifiedStatusData
object
VerifiedStatusData represents the information of the completed verification.
1 property
messagesUpdateCampaignError
object
3 properties
dspPostbackIntegrationStatus
object
4 properties
dspCustomerActivity
object
CustomerActivity represents a group of target customers to whom we're going to show an ad. CustomerActivity determines a dynamic (not pre-determined) set of ta…
9 properties
dspCampaignGoal_2
object
CampaignGoal describes the details of goal of a Campaign.
17 properties
1 required
CampaignGoalOptimizeFixedCpm_3
object
Detailed configuration of FIXEDCPM goal.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MOLOCO 12
Other APIs MOLOCO publishes across the network.
MOLOCO Ad Account API
MOLOCO Ad Group API
MOLOCO Ad Manager Account API
MOLOCO Analytics API
MOLOCO Asset API
MOLOCO Audience Target API
MOLOCO Campaign Summary API
MOLOCO Change History API
MOLOCO Cohort Summary API
MOLOCO Creative API
MOLOCO Creative Group API
MOLOCO Customer Set API
#Campaign
Where this information came from
This is an independent, third-party profile of MOLOCO Campaign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.