The identity and technical contract details declared by the specification.
messagesDeleteCreativeErrorAPIErrorInfo
object
3 properties
commonEnablingState
string
Enumeration of the enabling states with a default UNSPECIFIED state.
messagesReadCreativeResponse
object
1 property
commonAssetKind
string
List of asset kinds supported by Moloco Ads. - UNKNOWNASSETKIND: This value is not part of the specification. - CREATIVE: Creative asset type. - CSV: text/csv…
CreativeReviewPerExchangeReasonDetail
string
ReasonDetail describes the reason the Creative was DISAPPROVED. It applies to a few, standardized cases. - CTATEXTINVALID: The CTA text for native Creatives do…
dspCreativeReviewPerExchange
object
CreativeReviewPerExchange stores review status and review action per exchange.
3 properties
dspCreativeDynamicHtmlSrcPolicy
object
Policy defines how to select CatalogItems.
5 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
dspCreativeVastVideoSrc
object
Source of VAST (Video Ad Serving Template) video Creative.
4 properties
1 required
PolicyFunctionConfigGameConfig
object
1 property
messagesUpdateCreativeErrorAPIErrorInfoErrorReason
string
messagesListCreativesError
object
3 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
PolicyFunctionConfigModelConfig
object
4 properties
PolicyPolicyFunctionConfig
object
Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy - CatalogItem/CreativeElement list.
5 properties
dspCreativeCustomHtmlSrc
object
(Will be supported soon) Creative source based on custom html.
4 properties
4 required
messagesReadCreativeError
object
3 properties
messagesCopyCreativesSyncErrorAPIErrorInfo
object
3 properties
messagesCreateCreativeResponse
object
1 property
messagesCreateAssetUploadSessionErrorAPIErrorInfoErrorReason
string
adcloudcommonCreativeFeatureType
string
CreativeFeatureType.
messagesDeleteCreativesBulkError
object
3 properties
messagesDeleteCreativeError
object
3 properties
messagesCreateAssetUploadSessionError
object
3 properties
messagesCopyCreativesSyncRequest
object
5 properties
4 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…
messagesDeleteCreativesBulkErrorAPIErrorInfoErrorReason
string
messagesDeleteCreativeErrorAPIErrorInfoErrorReason
string
messagesDeleteCreativesBulkResponse
object
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
PolicyFunctionConfigMcmItemRecommendationConfig
object
2 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
PolicyPolicyFunction
string
PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - INCART: GLOBALTREND will be deprecated and replaced by TREND. Du…
messagesListCreativesErrorAPIErrorInfoErrorReason
string
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
messagesDeleteCreativesBulkErrorAPIErrorInfo
object
3 properties
dspCreativeNativeSrc
object
Source of native Creative.
10 properties
5 required
CreativeHtmlRequirementAttributesCustomCloseType
string
The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOMCLOSETYPENONE: It does not use useCustomClose()…
messagesCopyCreativesSyncErrorAPIErrorInfoErrorReason
string
messagesListCreativeReviewsErrorAPIErrorInfoErrorReason
string
- CREATIVEREVIEWFAILEDTOCONSTRUCTCRID: An error occurs while constructing the crid.
dspCreativeReview
object
CreativeReview contains information related to Creatives' review status per exchange.
4 properties
dspCreativeOverview
object
CreativeOverview is an overview information of Creative entity. It is for the lighter response by omitting some fields and data. Also, it has different behavio…
14 properties
PolicyEvaluatorType
string
EvaluatorType defines the type of evaluator for the model.
PolicyFunctionConfigTrendConfig
object
TREND PolicyFunction's config.
1 property
messagesCreateCreativeError
object
3 properties
CreativeReviewCreativeGroupInfo
object
Information of CreativeGroup that are using this Creative.
2 properties
messagesUpdateCreativeResponse
object
1 property
CreativeVideoSrcTranscodingInfoStatus
string
- INPROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found fr…
messagesReadCreativeErrorAPIErrorInfo
object
3 properties
messagesUpdateCreativeErrorAPIErrorInfo
object
3 properties
messagesCreateAssetUploadSessionErrorAPIErrorInfo
object
3 properties
dspCreativeTemplateHtmlSrc
object
(Will be supported soon) Creative source based on MRAID template.
6 properties
2 required
messagesListCreativesErrorAPIErrorInfo
object
3 properties
CreativeRichCustomHtmlSrcPlayableADSourceData
object
2 properties
messagesCreateAssetUploadSessionResponse
object
Response that contains information for the created asset upload session.
2 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
CopyCreativesSyncResponseCopyCreativesSyncResult
object
The result which contains Creative ID and its detailed result of copying.
3 properties
CreativeVideoSrcTranscodingInfo
object
2 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
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
messagesCopyCreativesSyncError
object
3 properties
messagesCreateCreativeErrorAPIErrorInfoErrorReason
string
- CREATIVEMUSTBEASSETURL: image URL should be asset url but user used wrong url by its prefix. - CREATIVEVIDEOTYPESHOULDHAVESINGLECOMPANIONIMAGE: video type sh…
messagesListCreativeReviewsResponse
object
1 property
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…
messagesUpdateCreativeError
object
3 properties
messagesListCreativeReviewsError
object
3 properties
PolicyFunctionConfigNextItemSelectionConfig
object
NEXTITEMSELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level.
messagesCopyCreativesSyncResponse
object
2 properties
CreativeReviewPerExchangeReviewAction
object
The details of an action taken on the CreativeReview.
4 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
messagesDeleteCreativeResponse
object
messagesListCreativeReviewsErrorAPIErrorInfo
object
3 properties
CreateAssetUploadSessionRequestAssetUploadSessionInfo
object
2 properties
2 required
messagesReadCreativeErrorAPIErrorInfoErrorReason
string
PolicyItemCapper
object
Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across Creati…
1 property
messagesListCreativesResponse
object
2 properties
messagesCreateCreativeErrorAPIErrorInfo
object
3 properties
dspCreativeReviewPerExchangeStatus
string
Enum of each Creative's approval status. Creative has not been submitted for review. - UNDERREVIEW: Creative is currently under review. - APPROVED: Creative ha…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MOLOCO publishes across the network.
