--- updatedAt: 2026-06-08T03:35:06.000Z agentTools: projectIndex: https://developer.moloco.cloud/llms.txt --- # List up Creatives. List up all creatives of the AdAccount or the Product. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Moloco Ads Campaign Management API", "description": "Moloco Ads Campaign Management API provides functionalities for Moloco Ads Campaigns.", "version": "1.10", "contact": { "name": "Moloco Inc.", "url": "https://www.moloco.com" } }, "paths": { "/cm/v1/creatives": { "get": { "summary": "List up Creatives.", "description": "List up all creatives of the AdAccount or the Product.", "operationId": "DspApi_ListCreatives", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messagesListCreativesResponse" } } } }, "default": { "description": "Error. Detailed cause can be found in the `details` field.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/messagesListCreativesError" } } } } }, "parameters": [ { "name": "ad_account_id", "description": "The AdAccount ID to which the Creatives belong to.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "product_id", "description": "The Product ID to which the Creatives belong to.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "types", "description": "The type of the Creatives to be listed.\nIf not specified, all types of Creatives will be listed.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - IMAGE: Image Creative. The image Creative source must be specified for this type.\n - VIDEO: Video Creative. The video Creative source must be specified for this type.\n - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.\n - NATIVE: Deprecated. v1.5 is the last version supporting this version.\nNative Creative. The native Creative source must be specified for this type.\n - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type.\n - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type.\n - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type.\n - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type.\n - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type.\n - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type.\n - AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag.", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "UNKNOWN_TYPE", "IMAGE", "VIDEO", "VAST_VIDEO", "NATIVE", "NATIVE_IMAGE", "NATIVE_VIDEO", "CUSTOM_HTML", "TEMPLATE_HTML", "RICH_CUSTOM_HTML", "DYNAMIC_HTML", "AD_TAG" ] } } }, { "name": "order_by.key", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "UNKNOWN_ORDER_BY", "UPDATED_AT" ], "default": "UNKNOWN_ORDER_BY" } }, { "name": "order_by.is_descending", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "inquiry_option", "description": "InquiryOption to specify which information to retrieve.\n\n - INQUIRY_ENTITY: Only the target entity itself is returned in response.\nThis InquiryOption is faster than other options as it reads the single entity from the database.\n - INQUIRY_OVERVIEW: The target entity's overview information is returned in response.\nIn general, the overview information includes the brief content of the target entity and its related entities.\nThis InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.\n - INQUIRY_ALL: The target entity and its summary information is returned in response.\nThis InquiryOption is equivalent to INQUIRY_ENTITY + INQUIRY_OVERVIEW, and it's slow and big.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "UNKNOWN_INQUIRY_OPTION", "INQUIRY_ENTITY", "INQUIRY_OVERVIEW", "INQUIRY_ALL" ], "default": "UNKNOWN_INQUIRY_OPTION" } } ], "tags": [ "Creative" ] } } }, "security": [ { "Bearer": [] } ], "servers": [ { "url": "https://api.moloco.cloud" } ], "components": { "securitySchemes": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "CreativeHtmlRequirementAttributesAutoPlayAudioType": { "type": "string", "enum": [ "UNKNOWN_AUTO_PLAY_AUDIO_TYPE", "AUTO_PLAY_AUDIO_TYPE_MUTED", "AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY", "AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE" ], "default": "UNKNOWN_AUTO_PLAY_AUDIO_TYPE", "description": "The Creative plays audio automatically; i.e., it starts muted. It may not be specified.\n\nIt is NOT SPECIFIED.\n\n - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically.\n - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange." }, "CreativeHtmlRequirementAttributesCustomCloseType": { "type": "string", "enum": [ "UNKNOWN_CUSTOM_CLOSE_TYPE", "CUSTOM_CLOSE_TYPE_NONE", "CUSTOM_CLOSE_TYPE_ENABLED", "CUSTOM_CLOSE_TYPE_CONTROLLABLE" ], "default": "UNKNOWN_CUSTOM_CLOSE_TYPE", "description": "The Creative uses useCustomClose() functionally in MRAID. It may not be specified.\n\nIt is NOT SPECIFIED.\n\n - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose().\n - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose().\n - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange." }, "CreativeHtmlSizeAttributesFixed": { "type": "object", "properties": { "width": { "type": "integer", "format": "int64" }, "height": { "type": "integer", "format": "int64" } } }, "CreativeRichCustomHtmlSrcPlayableADSourceData": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceType", "description": "Type of the source." }, "value": { "type": "string", "description": "When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file.\nWhen type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string." } } }, "CreativeRichCustomHtmlSrcPlayableADSourceType": { "type": "string", "enum": [ "UNKNOWN_PLAYABLE_AD_SOURCE_TYPE", "PLAYABLE_AD_SOURCE_TYPE_URL", "PLAYABLE_AD_SOURCE_TYPE_TAG" ], "default": "UNKNOWN_PLAYABLE_AD_SOURCE_TYPE", "description": " - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style).\n - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus)." }, "CreativeVideoSrcTranscodingInfo": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/CreativeVideoSrcTranscodingInfoStatus", "description": "Status of the transcoding." }, "failed_reason": { "type": "string", "description": "Error message for the FAILED status." } } }, "CreativeVideoSrcTranscodingInfoStatus": { "type": "string", "enum": [ "UNKNOWN_STATUS", "IN_PROGRESS", "SUCCEEDED", "FAILED" ], "default": "UNKNOWN_STATUS", "description": " - IN_PROGRESS: The transcoding is in progress.\n - SUCCEEDED: The transcoding has succeeded.\n - FAILED: The transcoding has failed.\nDetailed reason can be found from failed_reason." }, "PolicyEvaluatorType": { "type": "string", "enum": [ "UNKNOWN_EVALUATOR", "EVALUATOR_TEST_CATALOG_DEPENDENT", "EVALUATOR_TEST_CATALOG_INDEPENDENT", "EVALUATOR_RANDOM", "EVALUATOR_LR" ], "default": "UNKNOWN_EVALUATOR", "description": "EvaluatorType defines the type of evaluator for the model." }, "PolicyFunctionConfigGameConfig": { "type": "object", "properties": { "game_id": { "type": "string", "description": "Game id. it should correspond to GameID of dcr/api.proto." } } }, "PolicyFunctionConfigMcmItemRecommendationConfig": { "type": "object", "properties": { "mcm_platform_id": { "type": "string", "title": "Platform identifier for MCM Item Recommendation. (e.g. MOLOCO_PORTAL_DEMO)" }, "inventory_id": { "type": "string", "title": "Inventory identifier for MCM Item Recommendation. (e.g. home_recommendation)" } } }, "PolicyFunctionConfigModelConfig": { "type": "object", "properties": { "sourcer_type": { "$ref": "#/components/schemas/PolicySourcerType" }, "evaluator_type": { "$ref": "#/components/schemas/PolicyEvaluatorType" }, "evaluator_suffix": { "type": "string" }, "user_signal_window_hours": { "type": "integer", "format": "int32" } } }, "PolicyFunctionConfigNextItemSelectionConfig": { "type": "object", "description": "NEXT_ITEM_SELECTION PolicyFunction's config.\nNEXT tunes its item selection logic at the Config level rather than the PolicyFunction level." }, "PolicyFunctionConfigTrendConfig": { "type": "object", "properties": { "name": { "type": "string" } }, "description": "TREND PolicyFunction's config." }, "PolicyItemCapper": { "type": "object", "properties": { "frequency": { "$ref": "#/components/schemas/PolicyItemCapperFrequency" } }, "description": "Item-specific capper configurations.\nThe configuration in this message is enforced:\n - across AdAccounts,\n - across Campaigns,\n - across AdGroups,\n - across CreativeGroups, and\n - across Creatives." }, "PolicyItemCapperFrequency": { "type": "object", "properties": { "period": { "type": "string", "description": "The period is represented in a format {INTEGER}[smhdw].\nFor example, \"1m\" indicates 1 minute. When this field is empty,\nthe system default cooling time is used." }, "max_exposures": { "type": "integer", "format": "int32", "description": "The max number of exposures of a CatalogItem within a period of time." } }, "description": "Frequency represents frequency capping. One can specify\n\"at most 3 exposures per 1 hour\" by setting:\n {\n \"period\": \"1h\",\n \"max_exposures\": 3\n }\nThis means, when a user sees a CatalogItem 3 times, he/she won't\nsee the same CatalogItem again for 1 hour." }, "PolicyPolicyFunction": { "type": "string", "enum": [ "UNKNOWN_POLICY", "RANDOM_SELECTION", "MOST_RECENT_VIEW", "IN_CART", "GLOBAL_TREND", "TREND", "COMBINED_EVENTS_RECENCY", "FREQUENTLY_BOUGHT_TOGETHER", "FREQUENTLY_SEEN_TOGETHER", "KEYWORD_SEARCH_WITH_CLIENT_RESULT", "COMBINED_EVENTS_RECENCY_WITH_KEYWORD_SEARCH", "MODEL", "GAME", "RMP_AUDIENCE_EXTENSION", "MCM_ITEM_RECOMMENDATION", "NEXT_ITEM_SELECTION" ], "default": "UNKNOWN_POLICY", "description": "PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game.\n\n - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test.\n - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE}\n - GAME: GAME policy is used to select Creative elements of game.\n - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension.\n - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation.\n - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection." }, "PolicyPolicyFunctionConfig": { "type": "object", "properties": { "trend": { "$ref": "#/components/schemas/PolicyFunctionConfigTrendConfig", "description": "TREND PolicyFunction's config." }, "model": { "$ref": "#/components/schemas/PolicyFunctionConfigModelConfig" }, "game": { "$ref": "#/components/schemas/PolicyFunctionConfigGameConfig" }, "mcm_item_recommendation": { "$ref": "#/components/schemas/PolicyFunctionConfigMcmItemRecommendationConfig" }, "next_item_selection": { "$ref": "#/components/schemas/PolicyFunctionConfigNextItemSelectionConfig" } }, "description": "Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message\nto get a function: Policy -> CatalogItem/CreativeElement list." }, "PolicySourcerType": { "type": "string", "enum": [ "UNKNOWN_SOURCER", "SOURCER_TEST_CATALOG_DEPENDENT", "SOURCER_TEST_CATALOG_INDEPENDENT", "SOURCER_DEFAULT", "SOURCER_USER_SIGNAL", "SOURCER_TRENDS", "SOURCER_RELATED_ITEMS", "SOURCER_AUCTION_ITEMS" ], "default": "UNKNOWN_SOURCER", "description": "SourcerType defines the type of sourcer for the model." }, "adcloudcommonCreativeFeatureType": { "type": "string", "enum": [ "UNKNOWN_CREATIVE_FEATURE_TYPE", "GENERAL", "DYNAMIC_CREATIVE" ], "default": "UNKNOWN_CREATIVE_FEATURE_TYPE", "description": "CreativeFeatureType." }, "commonEnablingState": { "type": "string", "enum": [ "UNSPECIFIED", "ENABLED", "DISABLED" ], "default": "UNSPECIFIED", "description": "Enumeration of the enabling states with a default UNSPECIFIED state." }, "dspAdvertiserInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID of the advertiser." }, "title": { "type": "string", "description": "A descriptive name of the advertiser." }, "description": { "type": "string", "description": "A description of the advertiser." } }, "description": "AdvertiserInfo contains some basic information about an advertiser.\nIt may be returned to Creative reviewers or other users with other non-advertiser roles\nto perform their duty without leaking any private advertiser information." }, "dspCreative": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Creative. Automatically set by server on creation." }, "ad_account_id": { "type": "string", "description": "ID of the AdAccount the Creative belongs to.", "readOnly": true }, "product_id": { "type": "string", "description": "ID of the Product the Creative belongs to.", "readOnly": true }, "title": { "type": "string", "description": "A descriptive name of the Creative." }, "enabling_state": { "$ref": "#/components/schemas/commonEnablingState", "description": "Whether this Creative is enabled by the AdAccount.\n\nIf the value of this field is unset or set to UNSPECIFIED in the Creative\ncreation request, it will be set to ENABLED by default by the server.\n\nA disabled Creative will still get reviewed, but won't be served automatically after approval.\n\nAn active serving Creative can be paused at any time by setting this field to DISABLED." }, "advertiser_info": { "$ref": "#/components/schemas/dspAdvertiserInfo", "description": "Basic information about the Creative's AdAccount.", "readOnly": true }, "type": { "$ref": "#/components/schemas/dspCreativeType", "description": "Type of the Creative." }, "original_filename": { "type": "string", "description": "Original Creative filename given by user." }, "size_in_bytes": { "type": "integer", "format": "int64", "description": "Estimated size of the Creative in bytes." }, "custom_key_values": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom key/values managed by the Moloco Ads client platform. It's\nup to the client ads platform to define the schema for the values and their\noptionality.\n\nThe keys are recommended, but not required, to be prefixed with the reversed\ninternet domain of the AdCloud client platform company. For example, keys defined\nby the client ads platform company \"example.com\" should have \"com.example.\" as\nthe prefix.\n\nFor complex values, JSON payload is recommended.\n\nMoloco doesn't interpret these data in any way for ads serving. Upon serving,\nthe custom key/values in the AdAccount, Campaign, and Creative models will\nbe combined into the serving Creative proto in the order of precedence, with\nCreative's value having the highest precedence on the same key." }, "image": { "$ref": "#/components/schemas/dspCreativeImageSrc" }, "video": { "$ref": "#/components/schemas/dspCreativeVideoSrc" }, "vast_video": { "$ref": "#/components/schemas/dspCreativeVastVideoSrc" }, "native": { "$ref": "#/components/schemas/dspCreativeNativeSrc" }, "custom_html": { "$ref": "#/components/schemas/dspCreativeCustomHtmlSrc" }, "template_html": { "$ref": "#/components/schemas/dspCreativeTemplateHtmlSrc" }, "rich_custom_html": { "$ref": "#/components/schemas/dspCreativeRichCustomHtmlSrc" }, "dynamic_html": { "$ref": "#/components/schemas/dspCreativeDynamicHtmlSrc" }, "feature_type": { "$ref": "#/components/schemas/adcloudcommonCreativeFeatureType", "description": "CreativeFeatureType." }, "creator_tag": { "type": "string", "description": "Creator tag to identify who is the resource creator." }, "created_at": { "type": "string", "format": "date-time", "description": "Created time.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Last updated time. Should not modify on the client side." } }, "description": "Creative contains all data and assets required to visually render an ad.\n\nOne and only one of the sources must be specified for the Creative.", "required": [ "title", "original_filename" ] }, "dspCreativeCustomHtmlSrc": { "type": "object", "properties": { "html": { "type": "string", "description": "HTML for the custom HTML ad." }, "width": { "type": "integer", "format": "int64", "description": "Width of the Creative." }, "height": { "type": "integer", "format": "int64", "description": "Height of the Creative." }, "image_url": { "type": "string", "description": "URL of the image." } }, "description": "(Will be supported soon) Creative source based on custom html.", "required": [ "html", "width", "height", "image_url" ] }, "dspCreativeDynamicHtmlSrc": { "type": "object", "properties": { "template_id": { "type": "string", "description": "ID of the template used to render this Creative." }, "template_env": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment used to render this Creative." }, "rendered_entry_html": { "type": "string", "description": "The entry HTML of the rendered Creative." }, "html_requirement_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlRequirementAttributes", "description": "Requirements of this Creative. Based on this field and inventory's excludable Creative attributes,\nMoloco can filter out this Creative at serving time." }, "html_size_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlSizeAttributes", "description": "Size-related attributes of this Creative." }, "policy": { "$ref": "#/components/schemas/dspCreativeDynamicHtmlSrcPolicy", "description": "Policy defines how to select CatalogItems." } }, "description": "(Will be supported soon) Dynamic Creative. An instance of this would be used for Creatives to be rendered when\nthe Creative is shown to user, i.e. an impression takes place, unlike bid-time rendering\nfor static images.", "required": [ "template_id", "rendered_entry_html" ] }, "dspCreativeDynamicHtmlSrcPolicy": { "type": "object", "properties": { "function": { "$ref": "#/components/schemas/PolicyPolicyFunction", "description": "Algorithm for selecting CatalogItems or CreativeElements for a game.\nPolicyFunction can be thought of as a function: PolicyFunctionConfig -> Policy -> CatalogItem list.\nIn case a PolicyFunction does not need PolicyFunctionConfig, it can be thought of as\nPolicy -> CatalogItem/CreativeElement list." }, "function_config": { "$ref": "#/components/schemas/PolicyPolicyFunctionConfig" }, "num_items": { "type": "integer", "format": "int32", "description": "Number of items to be selected." }, "catalog": { "type": "string", "description": "Catalog ID. To know the types of catalogs supported, contact customer support." }, "item_capper": { "$ref": "#/components/schemas/PolicyItemCapper" } }, "description": "Policy defines how to select CatalogItems." }, "dspCreativeHtmlRequirementAttributes": { "type": "object", "properties": { "flags": { "type": "array", "items": { "$ref": "#/components/schemas/dspCreativeHtmlRequirementAttributesFlag" }, "description": "Flags for describing features that the enclosing Creative requires." }, "use_custom_close": { "$ref": "#/components/schemas/CreativeHtmlRequirementAttributesCustomCloseType" }, "auto_play_audio": { "$ref": "#/components/schemas/CreativeHtmlRequirementAttributesAutoPlayAudioType" } }, "description": "Requirements for displaying the Creative. During bidding, Moloco ensures only\nCreatives with HTML requirements satisfied by the inventory are served." }, "dspCreativeHtmlRequirementAttributesFlag": { "type": "string", "enum": [ "UNKNOWN_FLAG", "MRAID2", "IN_BANNER_VIDEO" ], "default": "UNKNOWN_FLAG", "description": "This value is not part of the specification.\n\n - MRAID2: AdX: 32 MraidType: MRAID.\n - IN_BANNER_VIDEO: AdX: 95 VideoType: In-Banner Video (Publisher Blockable).", "title": "This is similar to AdX' Creative attributes:\n https://storage.googleapis.com/adx-rtb-dictionaries/buyer-declarable-creative-attributes.txt\nSince the purpose of these flags is filtering, we also take into consideration\nwhat inventories can ban:\n https://storage.googleapis.com/adx-rtb-dictionaries/publisher-excludable-creative-attributes.txt" }, "dspCreativeHtmlSizeAttributes": { "type": "object", "properties": { "interstitial": { "type": "boolean", "description": "Passes as long as the inventory is for an interstitial ad." }, "fixed": { "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/CreativeHtmlSizeAttributesFixed" }, "description": "Passes as long as the inventory size matches with one of the elements in the list.\nIf the Creative can be rotated, then one should specify both configurations.\n\nFor non-interstitial ads, at least one dimension is required." } }, "description": "Size-related attributes for a resizable Creative, such as an HTML-based one.\nThis message acts as a filter condition; if an inventory is matched with the condition\nin this message, the enclosing Creative passes; i.e., the Creative is not filtered out." }, "dspCreativeImageSrc": { "type": "object", "properties": { "image_url": { "type": "string", "description": "URL of the image." }, "filename": { "type": "string", "description": "Original filename of the image." }, "width": { "type": "integer", "format": "int64", "description": "Width of the Creative.", "readOnly": true }, "height": { "type": "integer", "format": "int64", "description": "Height of the Creative.", "readOnly": true }, "size_in_bytes": { "type": "integer", "format": "int64", "description": "Size of the image in bytes." } }, "description": "Source of image Creative.\n\nSupported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).\n\nBanner dimensions:\n - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100\n - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60\n - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50\n - 970x250, 994x250, 1029x258\n\nFull screen dimensions:\n - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640\n - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736\n - 428x846, 480x320, 640x360\n\nMedium dimensions:\n - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500\n\nTablet dimensions:\n - 728x90, 768x1024, 1024x90, 1024x768, 1280x90" }, "dspCreativeNativeSrc": { "type": "object", "properties": { "icon_image": { "$ref": "#/components/schemas/dspCreativeImageSrc", "description": "App icon image for the native Creative. Width and height must be equal. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF)." }, "main_image": { "$ref": "#/components/schemas/dspCreativeImageSrc", "description": "Main image for the native Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF).\n\nFor native image ads, the following dimensions are supported:\n- 720x720, 720x960, 720x1280\n- 1200x222, 1200x600, 1200x628, 1200x844, 1200x1600\n\nFor native video ads, the following dimensions are supported:\n- 360x480, 360x640, 480x360, 480x480, 640x360\n- 720x720, 720x960, 720x1280, 800x418, 1200x628, 1280x720" }, "shrunk_main_image": { "$ref": "#/components/schemas/dspCreativeImageSrc", "description": "Thumbnail image displayed alongside the native video Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF)." }, "title": { "type": "string", "description": "Title of the native ad." }, "text": { "type": "string", "description": "Text message to show." }, "cta_text": { "type": "string", "description": "Call to action text (e.g. \"Get a quote\")." }, "sponsored_by": { "type": "string", "description": "Brand name of the sponsor/advertiser." }, "star_rating": { "type": "number", "format": "float", "description": "Star rating value of the app. Value should be in the range of [0, 5]." }, "video": { "$ref": "#/components/schemas/dspCreativeVideoSrc", "description": "Video asset for native video ads.\n\nOnly one of the video and vast_video fields may be specified, not both." }, "vast_video": { "$ref": "#/components/schemas/dspCreativeVastVideoSrc", "description": "Vast video for native video ads.\n\nOnly one of the video and vast_video fields may be specified, not both." } }, "description": "Source of native Creative.", "required": [ "icon_image", "main_image", "title", "text", "cta_text" ] }, "dspCreativeOverview": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the Creative." }, "ad_account_id": { "type": "string", "description": "ID of the AdAccount this Creative belongs to." }, "product_id": { "type": "string", "description": "ID of the Product this Creative belongs to." }, "title": { "type": "string", "description": "A descriptive name of the Creative." }, "type": { "$ref": "#/components/schemas/dspCreativeType", "description": "Type of the Creative." }, "original_filename": { "type": "string", "description": "Original Creative filename given by user." }, "image": { "$ref": "#/components/schemas/dspCreativeImageSrc" }, "video": { "$ref": "#/components/schemas/dspCreativeVideoSrc" }, "vast_video": { "$ref": "#/components/schemas/dspCreativeVastVideoSrc" }, "native": { "$ref": "#/components/schemas/dspCreativeNativeSrc" }, "feature_type": { "$ref": "#/components/schemas/adcloudcommonCreativeFeatureType", "description": "CreativeFeatureType." }, "creator_tag": { "type": "string", "description": "Creator tag to identify who is the resource creator." }, "created_at": { "type": "string", "format": "date-time", "description": "Created time." }, "updated_at": { "type": "string", "format": "date-time", "description": "Last updated time. Should not modify on the client side." } }, "description": "CreativeOverview is an overview information of Creative entity.\nIt is for the lighter response by omitting some fields and data.\nAlso, it has different behavior for the source field depends on the Creative source type.\nIt doesn't return source field for the *_HTML Creative types." }, "dspCreativeRichCustomHtmlSrc": { "type": "object", "properties": { "entry_html": { "type": "string", "description": "The entry HTML code of the Creative.\n\nThis field is read only. For write purposes, use playable_ad_source instead.", "readOnly": true }, "html_requirement_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlRequirementAttributes", "description": "Requirements of this Creative.\n\nBased on this field and inventory's excludable Creative attributes, Moloco\ncan filter out this Creative." }, "html_size_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlSizeAttributes", "description": "Size-related attributes of this Creative." }, "max_video_duration_seconds": { "type": "integer", "format": "int64", "description": "Max duration of video sources, in seconds. It will be set to 0 if no video\nsource is found in this Creative." }, "playable_ad_source": { "$ref": "#/components/schemas/CreativeRichCustomHtmlSrcPlayableADSourceData", "description": "PlayableAD source which is created by the third party like Facbook or Tresensa.\nFor non-playableAD rich_custom_html, it can be left as blank but entryHTML should be filled.\nThis field is available for only creation." }, "filename": { "type": "string", "description": "The filename of HTML file." } }, "description": "Creative source based on arbitrary HTML.\nAn instance of this is typically used for a playable Creative from AdAccounts.\nYou can create RichCustomHtmlSrc by one of two methods:\n1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL)\n2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG).", "required": [ "html_requirement_attributes" ] }, "dspCreativeTemplateHtmlSrc": { "type": "object", "properties": { "template_id": { "type": "string", "description": "ID of the template used to render this Creative." }, "template_env": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment used to render this Creative." }, "rendered_entry_html": { "type": "string", "description": "The entry HTML of the rendered Creative." }, "html_requirement_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlRequirementAttributes", "description": "Requirements of this Creative. Based on this field and inventory's excludable Creative attributes,\nMoloco can filter out this Creative at serving time." }, "html_size_attributes": { "$ref": "#/components/schemas/dspCreativeHtmlSizeAttributes", "description": "Size-related attributes of this Creative." }, "max_video_duration_seconds": { "type": "integer", "format": "int64", "description": "Max duration of video sources. Will be 0 if no video source is found in this Creative." } }, "description": "(Will be supported soon) Creative source based on MRAID template.", "required": [ "template_id", "rendered_entry_html" ] }, "dspCreativeType": { "type": "string", "enum": [ "UNKNOWN_TYPE", "IMAGE", "VIDEO", "VAST_VIDEO", "NATIVE", "NATIVE_IMAGE", "NATIVE_VIDEO", "CUSTOM_HTML", "TEMPLATE_HTML", "RICH_CUSTOM_HTML", "DYNAMIC_HTML", "AD_TAG" ], "default": "UNKNOWN_TYPE", "description": "Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified.\n\n - UNKNOWN_TYPE: This value is not part of the specification.\n - IMAGE: Image Creative. The image Creative source must be specified for this type.\n - VIDEO: Video Creative. The video Creative source must be specified for this type.\n - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type.\n - NATIVE: Deprecated. v1.5 is the last version supporting this version.\nNative Creative. The native Creative source must be specified for this type.\n - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type.\n - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type.\n - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type.\n - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type.\n - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type.\n - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type.\n - AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag." }, "dspCreativeVastVideoSrc": { "type": "object", "properties": { "vast_tag": { "type": "string", "description": "VAST tag to be used in VAST wrapper.\nE.g. [Example here](https://github.com/InteractiveAdvertisingBureau/VAST_Samples/blob/master/VAST%201-2.0%20Samples/Tremor-Video-Samples/vast_wrapper_linear_1.xml)." }, "width": { "type": "integer", "format": "int64", "description": "Width of the Creative.", "readOnly": true }, "height": { "type": "integer", "format": "int64", "description": "Height of the Creative.", "readOnly": true }, "length_seconds": { "type": "integer", "format": "int64", "description": "Vast video length in seconds." } }, "description": "Source of VAST (Video Ad Serving Template) video Creative.", "required": [ "vast_tag" ] }, "dspCreativeVideoSrc": { "type": "object", "properties": { "video_url": { "type": "string", "description": "URL of the video media. Currently we support only mp4 format." }, "filename": { "type": "string", "description": "Original filename of the video." }, "width": { "type": "integer", "format": "int64", "description": "Width of the Creative." }, "height": { "type": "integer", "format": "int64", "description": "Height of the Creative." }, "length_seconds": { "type": "integer", "format": "int64", "description": "Video length in seconds." }, "fps": { "type": "integer", "format": "int64", "description": "Number of frames per second for the video." }, "size_in_bytes": { "type": "integer", "format": "int64", "description": "Size of the video in bytes. Note it doesn't include the bytes for the companion images." }, "companion_images": { "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/dspCreativeImageSrc" }, "description": "Endcard image shown after video play ends. The orientation must match the video orientation. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF)." }, "auto_endcard": { "type": "boolean", "description": "Whether the endcard is generated automatically by MCP or manually uploaded by the user." }, "playable_endcard": { "$ref": "#/components/schemas/dspCreativeRichCustomHtmlSrc", "description": "HTML-based playable endcard that is shown after video play is ended.\nEither a playable or an image (via `companion_images`) or a dynamic html (via `dynamic_html_endcard`) must be used." }, "dynamic_html_endcard": { "$ref": "#/components/schemas/dspCreativeDynamicHtmlSrc", "description": "HTML-based dynamic html endcard that is shown after video play is ended.\nEither a dynamic html or an image (via `companion_images`) or a playable (via `playable_endcard`) must be used." }, "transcoding_info": { "$ref": "#/components/schemas/CreativeVideoSrcTranscodingInfo", "description": "Transcoding information of the video.", "readOnly": true } }, "description": "Source of video Creative.\n\nSupported format: MP4. Maximum file size: 300MB (before transcoding).\nAt least one of width or height must be ≥ 640px. Duration: 6–180 seconds.", "required": [ "video_url", "width", "height", "length_seconds" ] }, "messagesListCreativesError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/messagesListCreativesErrorAPIErrorInfo" } } } }, "messagesListCreativesErrorAPIErrorInfo": { "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/messagesListCreativesErrorAPIErrorInfoErrorReason" }, "error_log_id": { "type": "string" }, "context": { "type": "object", "additionalProperties": { "type": "string" } } } }, "messagesListCreativesErrorAPIErrorInfoErrorReason": { "type": "string", "enum": [ "ERROR_REASON_UNKNOWN" ], "default": "ERROR_REASON_UNKNOWN" }, "messagesListCreativesResponse": { "type": "object", "properties": { "creatives": { "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/dspCreative" }, "description": "The list of the Creatives.\nThis field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL." }, "creative_overviews": { "type": "array", "items": { "type": "object", "$ref": "#/components/schemas/dspCreativeOverview" }, "description": "The list of the Creative overviews.\nThis field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL." } } } } } } ```