--- title: "List up Creatives." method: GET path: "/cm/v1/creatives" tags: ["Creative"] --- # List up Creatives. `GET /cm/v1/creatives` List up all creatives of the AdAccount or the Product. ## Query parameters - `ad_account_id` string, required - `product_id` string - `types` string[] - `order_by.key` 'UNKNOWN_ORDER_BY' | 'UPDATED_AT' - `order_by.is_descending` boolean - `inquiry_option` 'UNKNOWN_INQUIRY_OPTION' | 'INQUIRY_ENTITY' | 'INQUIRY_OVERVIEW' | 'INQUIRY_ALL' ## Response `200` A successful response. - MessagesListCreativesResponse - `creatives` DspCreative[] — The list of the Creatives. This field is valid if the inquiry_option of the request is UNKNOWN_INQUIRY_OPTION or INQUIRY_ENTITY or INQUIRY_ALL. - `id` string — Unique identifier of the Creative. Automatically set by server on creation. - `ad_account_id` string — ID of the AdAccount the Creative belongs to. - `product_id` string — ID of the Product the Creative belongs to. - `title` string, required — A descriptive name of the Creative. - `enabling_state` 'UNSPECIFIED' | 'ENABLED' | 'DISABLED' — Enumeration of the enabling states with a default UNSPECIFIED state. - `advertiser_info` DspAdvertiserInfo — AdvertiserInfo contains some basic information about an advertiser. It may be returned to Creative reviewers or other users with other non-advertiser roles to perform their duty without leaking any private advertiser information. - `id` string — Unique ID of the advertiser. - `title` string — A descriptive name of the advertiser. - `description` string — A description of the advertiser. - `type` 'UNKNOWN_TYPE' | 'IMAGE' | 'VIDEO' | 'VAST_VIDEO' | 'NATIVE' | 'NATIVE_IMAGE' | 'NATIVE_VIDEO' | 'CUSTOM_HTML' | 'TEMPLATE_HTML' | 'RICH_CUSTOM_HTML' | 'DYNAMIC_HTML' | 'AD_TAG' — Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified. - UNKNOWN_TYPE: This value is not part of the specification. - IMAGE: Image Creative. The image Creative source must be specified for this type. - VIDEO: Video Creative. The video Creative source must be specified for this type. - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type. - NATIVE: Deprecated. v1.5 is the last version supporting this version. Native Creative. The native Creative source must be specified for this type. - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type. - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type. - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type. - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type. - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type. - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type. - AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag. - `original_filename` string, required — Original Creative filename given by user. - `size_in_bytes` integer — Estimated size of the Creative in bytes. - `custom_key_values` object — Custom key/values managed by the Moloco Ads client platform. It's up to the client ads platform to define the schema for the values and their optionality. The keys are recommended, but not required, to be prefixed with the reversed internet domain of the AdCloud client platform company. For example, keys defined by the client ads platform company "example.com" should have "com.example." as the prefix. For complex values, JSON payload is recommended. Moloco doesn't interpret these data in any way for ads serving. Upon serving, the custom key/values in the AdAccount, Campaign, and Creative models will be combined into the serving Creative proto in the order of precedence, with Creative's value having the highest precedence on the same key. - `image` DspCreativeImageSrc — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `video` DspCreativeVideoSrc — 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–180 seconds. - `video_url` string, required — URL of the video media. Currently we support only mp4 format. - `filename` string — Original filename of the video. - `width` integer, required — Width of the Creative. - `height` integer, required — Height of the Creative. - `length_seconds` integer, required — Video length in seconds. - `fps` integer — Number of frames per second for the video. - `size_in_bytes` integer — Size of the video in bytes. Note it doesn't include the bytes for the companion images. - `companion_images` DspCreativeImageSrc[] — 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). - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `auto_endcard` boolean — Whether the endcard is generated automatically by MCP or manually uploaded by the user. - `playable_endcard` DspCreativeRichCustomHtmlSrc — 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 of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG). - `entry_html` string — The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes, required — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `max_video_duration_seconds` integer — Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative. - `playable_ad_source` CreativeRichCustomHtmlSrcPlayableADSourceData - `type` 'UNKNOWN_PLAYABLE_AD_SOURCE_TYPE' | 'PLAYABLE_AD_SOURCE_TYPE_URL' | 'PLAYABLE_AD_SOURCE_TYPE_TAG' — - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style). - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus). - `value` string — When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string. - `filename` string — The filename of HTML file. - `dynamic_html_endcard` DspCreativeDynamicHtmlSrc — (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 impression takes place, unlike bid-time rendering for static images. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `policy` DspCreativeDynamicHtmlSrcPolicy — Policy defines how to select CatalogItems. - `function` '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' — PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test. - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE} - GAME: GAME policy is used to select Creative elements of game. - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension. - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation. - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection. - `function_config` PolicyPolicyFunctionConfig — Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list. - `trend` PolicyFunctionConfigTrendConfig — TREND PolicyFunction's config. - … - `model` PolicyFunctionConfigModelConfig - … - `game` PolicyFunctionConfigGameConfig - … - `mcm_item_recommendation` PolicyFunctionConfigMcmItemRecommendationConfig - … - `next_item_selection` PolicyFunctionConfigNextItemSelectionConfig — NEXT_ITEM_SELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level. - `num_items` integer — Number of items to be selected. - `catalog` string — Catalog ID. To know the types of catalogs supported, contact customer support. - `item_capper` PolicyItemCapper — Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across CreativeGroups, and - across Creatives. - `frequency` PolicyItemCapperFrequency — Frequency represents frequency capping. One can specify "at most 3 exposures per 1 hour" by setting: { "period": "1h", "max_exposures": 3 } This means, when a user sees a CatalogItem 3 times, he/she won't see the same CatalogItem again for 1 hour. - … - `transcoding_info` CreativeVideoSrcTranscodingInfo - `status` 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' — - IN_PROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found from failed_reason. - `failed_reason` string — Error message for the FAILED status. - `vast_video` DspCreativeVastVideoSrc — Source of VAST (Video Ad Serving Template) video Creative. - `vast_tag` string, required — VAST tag to be used in VAST wrapper. E.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` integer — Width of the Creative. - `height` integer — Height of the Creative. - `length_seconds` integer — Vast video length in seconds. - `native` DspCreativeNativeSrc — Source of native Creative. - `icon_image` DspCreativeImageSrc, required — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `main_image` DspCreativeImageSrc, required — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `shrunk_main_image` DspCreativeImageSrc — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `title` string, required — Title of the native ad. - `text` string, required — Text message to show. - `cta_text` string, required — Call to action text (e.g. "Get a quote"). - `sponsored_by` string — Brand name of the sponsor/advertiser. - `star_rating` number, float — Star rating value of the app. Value should be in the range of [0, 5]. - `video` DspCreativeVideoSrc — 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–180 seconds. - `video_url` string, required — URL of the video media. Currently we support only mp4 format. - `filename` string — Original filename of the video. - `width` integer, required — Width of the Creative. - `height` integer, required — Height of the Creative. - `length_seconds` integer, required — Video length in seconds. - `fps` integer — Number of frames per second for the video. - `size_in_bytes` integer — Size of the video in bytes. Note it doesn't include the bytes for the companion images. - `companion_images` DspCreativeImageSrc[] — 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). - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `auto_endcard` boolean — Whether the endcard is generated automatically by MCP or manually uploaded by the user. - `playable_endcard` DspCreativeRichCustomHtmlSrc — 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 of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG). - `entry_html` string — The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes, required — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - … - `max_video_duration_seconds` integer — Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative. - `playable_ad_source` CreativeRichCustomHtmlSrcPlayableADSourceData - `type` 'UNKNOWN_PLAYABLE_AD_SOURCE_TYPE' | 'PLAYABLE_AD_SOURCE_TYPE_URL' | 'PLAYABLE_AD_SOURCE_TYPE_TAG' — - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style). - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus). - `value` string — When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string. - `filename` string — The filename of HTML file. - `dynamic_html_endcard` DspCreativeDynamicHtmlSrc — (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 impression takes place, unlike bid-time rendering for static images. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - … - `policy` DspCreativeDynamicHtmlSrcPolicy — Policy defines how to select CatalogItems. - `function` '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' — PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test. - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE} - GAME: GAME policy is used to select Creative elements of game. - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension. - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation. - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection. - `function_config` PolicyPolicyFunctionConfig — Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list. - … - `num_items` integer — Number of items to be selected. - `catalog` string — Catalog ID. To know the types of catalogs supported, contact customer support. - `item_capper` PolicyItemCapper — Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across CreativeGroups, and - across Creatives. - … - `transcoding_info` CreativeVideoSrcTranscodingInfo - `status` 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' — - IN_PROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found from failed_reason. - `failed_reason` string — Error message for the FAILED status. - `vast_video` DspCreativeVastVideoSrc — Source of VAST (Video Ad Serving Template) video Creative. - `vast_tag` string, required — VAST tag to be used in VAST wrapper. E.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` integer — Width of the Creative. - `height` integer — Height of the Creative. - `length_seconds` integer — Vast video length in seconds. - `custom_html` DspCreativeCustomHtmlSrc — (Will be supported soon) Creative source based on custom html. - `html` string, required — HTML for the custom HTML ad. - `width` integer, required — Width of the Creative. - `height` integer, required — Height of the Creative. - `image_url` string, required — URL of the image. - `template_html` DspCreativeTemplateHtmlSrc — (Will be supported soon) Creative source based on MRAID template. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `max_video_duration_seconds` integer — Max duration of video sources. Will be 0 if no video source is found in this Creative. - `rich_custom_html` DspCreativeRichCustomHtmlSrc — 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 of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG). - `entry_html` string — The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes, required — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `max_video_duration_seconds` integer — Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative. - `playable_ad_source` CreativeRichCustomHtmlSrcPlayableADSourceData - `type` 'UNKNOWN_PLAYABLE_AD_SOURCE_TYPE' | 'PLAYABLE_AD_SOURCE_TYPE_URL' | 'PLAYABLE_AD_SOURCE_TYPE_TAG' — - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style). - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus). - `value` string — When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string. - `filename` string — The filename of HTML file. - `dynamic_html` DspCreativeDynamicHtmlSrc — (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 impression takes place, unlike bid-time rendering for static images. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `policy` DspCreativeDynamicHtmlSrcPolicy — Policy defines how to select CatalogItems. - `function` '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' — PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test. - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE} - GAME: GAME policy is used to select Creative elements of game. - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension. - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation. - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection. - `function_config` PolicyPolicyFunctionConfig — Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list. - `trend` PolicyFunctionConfigTrendConfig — TREND PolicyFunction's config. - `name` string - `model` PolicyFunctionConfigModelConfig - `sourcer_type` 'UNKNOWN_SOURCER' | 'SOURCER_TEST_CATALOG_DEPENDENT' | 'SOURCER_TEST_CATALOG_INDEPENDENT' | 'SOURCER_DEFAULT' | 'SOURCER_USER_SIGNAL' | 'SOURCER_TRENDS' | 'SOURCER_RELATED_ITEMS' | 'SOURCER_AUCTION_ITEMS' — SourcerType defines the type of sourcer for the model. - `evaluator_type` 'UNKNOWN_EVALUATOR' | 'EVALUATOR_TEST_CATALOG_DEPENDENT' | 'EVALUATOR_TEST_CATALOG_INDEPENDENT' | 'EVALUATOR_RANDOM' | 'EVALUATOR_LR' — EvaluatorType defines the type of evaluator for the model. - `evaluator_suffix` string - `user_signal_window_hours` integer - `game` PolicyFunctionConfigGameConfig - `game_id` string — Game id. it should correspond to GameID of dcr/api.proto. - `mcm_item_recommendation` PolicyFunctionConfigMcmItemRecommendationConfig - `mcm_platform_id` string - `inventory_id` string - `next_item_selection` PolicyFunctionConfigNextItemSelectionConfig — NEXT_ITEM_SELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level. - `num_items` integer — Number of items to be selected. - `catalog` string — Catalog ID. To know the types of catalogs supported, contact customer support. - `item_capper` PolicyItemCapper — Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across CreativeGroups, and - across Creatives. - `frequency` PolicyItemCapperFrequency — Frequency represents frequency capping. One can specify "at most 3 exposures per 1 hour" by setting: { "period": "1h", "max_exposures": 3 } This means, when a user sees a CatalogItem 3 times, he/she won't see the same CatalogItem again for 1 hour. - `period` string — The period is represented in a format {INTEGER}[smhdw]. For example, "1m" indicates 1 minute. When this field is empty, the system default cooling time is used. - `max_exposures` integer — The max number of exposures of a CatalogItem within a period of time. - `feature_type` 'UNKNOWN_CREATIVE_FEATURE_TYPE' | 'GENERAL' | 'DYNAMIC_CREATIVE' — CreativeFeatureType. - `creator_tag` string — Creator tag to identify who is the resource creator. - `created_at` string, date-time — Created time. - `updated_at` string, date-time — Last updated time. Should not modify on the client side. - `creative_overviews` DspCreativeOverview[] — The list of the Creative overviews. This field is valid if the inquiry_option of the request is INQUIRY_OVERVIEW or INQUIRY_ALL. - `id` string — ID of the Creative. - `ad_account_id` string — ID of the AdAccount this Creative belongs to. - `product_id` string — ID of the Product this Creative belongs to. - `title` string — A descriptive name of the Creative. - `type` 'UNKNOWN_TYPE' | 'IMAGE' | 'VIDEO' | 'VAST_VIDEO' | 'NATIVE' | 'NATIVE_IMAGE' | 'NATIVE_VIDEO' | 'CUSTOM_HTML' | 'TEMPLATE_HTML' | 'RICH_CUSTOM_HTML' | 'DYNAMIC_HTML' | 'AD_TAG' — Type of the Creative. Only one of the Creative source fields matching the type is allowed to be specified. - UNKNOWN_TYPE: This value is not part of the specification. - IMAGE: Image Creative. The image Creative source must be specified for this type. - VIDEO: Video Creative. The video Creative source must be specified for this type. - VAST_VIDEO: Vast video Creative. The vast video Creative source must be specified for this type. - NATIVE: Deprecated. v1.5 is the last version supporting this version. Native Creative. The native Creative source must be specified for this type. - NATIVE_IMAGE: Native image Creative. The native image Creative source must be specified for this type. - NATIVE_VIDEO: Native video Creative. The native video Creative source must be specified for this type. - CUSTOM_HTML: (Will be supported soon) Custom HTML Creative. The custom HTML Creative source must be specified for this type. - TEMPLATE_HTML: (Will be supported soon) Template HTML Creative. The template HTML Creative source must be specified for this type. - RICH_CUSTOM_HTML: The rich custom HTML Creative. The rich custom HTML Creative source must be specified for this type. - DYNAMIC_HTML: (Will be supported soon) The dynamic HTML Creative. The dynamic HTML Creative source must be specified for this type. - AD_TAG: (Will be supported soon) Third-party ad tag Creative with script-based or vast tag-based ad tag. - `original_filename` string — Original Creative filename given by user. - `image` DspCreativeImageSrc — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `video` DspCreativeVideoSrc — 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–180 seconds. - `video_url` string, required — URL of the video media. Currently we support only mp4 format. - `filename` string — Original filename of the video. - `width` integer, required — Width of the Creative. - `height` integer, required — Height of the Creative. - `length_seconds` integer, required — Video length in seconds. - `fps` integer — Number of frames per second for the video. - `size_in_bytes` integer — Size of the video in bytes. Note it doesn't include the bytes for the companion images. - `companion_images` DspCreativeImageSrc[] — 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). - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `auto_endcard` boolean — Whether the endcard is generated automatically by MCP or manually uploaded by the user. - `playable_endcard` DspCreativeRichCustomHtmlSrc — 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 of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG). - `entry_html` string — The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes, required — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `max_video_duration_seconds` integer — Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative. - `playable_ad_source` CreativeRichCustomHtmlSrcPlayableADSourceData - `type` 'UNKNOWN_PLAYABLE_AD_SOURCE_TYPE' | 'PLAYABLE_AD_SOURCE_TYPE_URL' | 'PLAYABLE_AD_SOURCE_TYPE_TAG' — - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style). - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus). - `value` string — When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string. - `filename` string — The filename of HTML file. - `dynamic_html_endcard` DspCreativeDynamicHtmlSrc — (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 impression takes place, unlike bid-time rendering for static images. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - `width` integer - `height` integer - `policy` DspCreativeDynamicHtmlSrcPolicy — Policy defines how to select CatalogItems. - `function` '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' — PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test. - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE} - GAME: GAME policy is used to select Creative elements of game. - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension. - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation. - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection. - `function_config` PolicyPolicyFunctionConfig — Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list. - `trend` PolicyFunctionConfigTrendConfig — TREND PolicyFunction's config. - … - `model` PolicyFunctionConfigModelConfig - … - `game` PolicyFunctionConfigGameConfig - … - `mcm_item_recommendation` PolicyFunctionConfigMcmItemRecommendationConfig - … - `next_item_selection` PolicyFunctionConfigNextItemSelectionConfig — NEXT_ITEM_SELECTION PolicyFunction's config. NEXT tunes its item selection logic at the Config level rather than the PolicyFunction level. - `num_items` integer — Number of items to be selected. - `catalog` string — Catalog ID. To know the types of catalogs supported, contact customer support. - `item_capper` PolicyItemCapper — Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across CreativeGroups, and - across Creatives. - `frequency` PolicyItemCapperFrequency — Frequency represents frequency capping. One can specify "at most 3 exposures per 1 hour" by setting: { "period": "1h", "max_exposures": 3 } This means, when a user sees a CatalogItem 3 times, he/she won't see the same CatalogItem again for 1 hour. - … - `transcoding_info` CreativeVideoSrcTranscodingInfo - `status` 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' — - IN_PROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found from failed_reason. - `failed_reason` string — Error message for the FAILED status. - `vast_video` DspCreativeVastVideoSrc — Source of VAST (Video Ad Serving Template) video Creative. - `vast_tag` string, required — VAST tag to be used in VAST wrapper. E.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` integer — Width of the Creative. - `height` integer — Height of the Creative. - `length_seconds` integer — Vast video length in seconds. - `native` DspCreativeNativeSrc — Source of native Creative. - `icon_image` DspCreativeImageSrc, required — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `main_image` DspCreativeImageSrc, required — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `shrunk_main_image` DspCreativeImageSrc — Source of image Creative. Supported formats: JPEG, PNG, GIF. Maximum file size: 500KB (5MB for GIF). Banner dimensions: - 100x21, 300x50, 300x100, 320x48, 320x50, 320x100 - 360x56, 375x50, 375x59, 392x61, 411x64, 414x50, 414x65, 468x60 - 481x56, 640x100, 640x200, 667x56, 711x88, 800x50 - 970x250, 994x250, 1029x258 Full screen dimensions: - 300x600, 320x416, 320x480, 320x568, 360x592, 360x604, 360x640 - 360x718, 360x724, 360x728, 375x667, 384x787, 412x790, 414x736 - 428x846, 480x320, 640x360 Medium dimensions: - 160x600, 200x200, 250x250, 300x250, 320x240, 320x267, 336x280, 600x500 Tablet dimensions: - 728x90, 768x1024, 1024x90, 1024x768, 1280x90 - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `title` string, required — Title of the native ad. - `text` string, required — Text message to show. - `cta_text` string, required — Call to action text (e.g. "Get a quote"). - `sponsored_by` string — Brand name of the sponsor/advertiser. - `star_rating` number, float — Star rating value of the app. Value should be in the range of [0, 5]. - `video` DspCreativeVideoSrc — 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–180 seconds. - `video_url` string, required — URL of the video media. Currently we support only mp4 format. - `filename` string — Original filename of the video. - `width` integer, required — Width of the Creative. - `height` integer, required — Height of the Creative. - `length_seconds` integer, required — Video length in seconds. - `fps` integer — Number of frames per second for the video. - `size_in_bytes` integer — Size of the video in bytes. Note it doesn't include the bytes for the companion images. - `companion_images` DspCreativeImageSrc[] — 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). - `image_url` string — URL of the image. - `filename` string — Original filename of the image. - `width` integer — Width of the Creative. - `height` integer — Height of the Creative. - `size_in_bytes` integer — Size of the image in bytes. - `auto_endcard` boolean — Whether the endcard is generated automatically by MCP or manually uploaded by the user. - `playable_endcard` DspCreativeRichCustomHtmlSrc — 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 of two methods: 1. Upload FB style html file using CreateAssetUploadSession API(PLAYABLE_AD_SOURCE_TYPE_URL) 2. Use Creative template third parties: tresensa or spaceback(PLAYABLE_AD_SOURCE_TYPE_TAG). - `entry_html` string — The entry HTML code of the Creative. This field is read only. For write purposes, use playable_ad_source instead. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes, required — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - … - `max_video_duration_seconds` integer — Max duration of video sources, in seconds. It will be set to 0 if no video source is found in this Creative. - `playable_ad_source` CreativeRichCustomHtmlSrcPlayableADSourceData - `type` 'UNKNOWN_PLAYABLE_AD_SOURCE_TYPE' | 'PLAYABLE_AD_SOURCE_TYPE_URL' | 'PLAYABLE_AD_SOURCE_TYPE_TAG' — - PLAYABLE_AD_SOURCE_TYPE_URL: Source is a URL of the playable ad html. (facebook style). - PLAYABLE_AD_SOURCE_TYPE_TAG: Source is a playable ad html tag generated by the third party. (tresensa, spaceback, luna, playable factory, craftsmanplus). - `value` string — When type is PLAYABLE_AD_SOURCE_TYPE_URL, then URL of the uploaded HTML file. When type is PLAYABLE_AD_SOURCE_TYPE_TAG, then the full tag string. - `filename` string — The filename of HTML file. - `dynamic_html_endcard` DspCreativeDynamicHtmlSrc — (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 impression takes place, unlike bid-time rendering for static images. - `template_id` string, required — ID of the template used to render this Creative. - `template_env` object — Environment used to render this Creative. - `rendered_entry_html` string, required — The entry HTML of the rendered Creative. - `html_requirement_attributes` DspCreativeHtmlRequirementAttributes — Requirements for displaying the Creative. During bidding, Moloco ensures only Creatives with HTML requirements satisfied by the inventory are served. - `flags` DspCreativeHtmlRequirementAttributesFlag[] — Flags for describing features that the enclosing Creative requires. - `use_custom_close` 'UNKNOWN_CUSTOM_CLOSE_TYPE' | 'CUSTOM_CLOSE_TYPE_NONE' | 'CUSTOM_CLOSE_TYPE_ENABLED' | 'CUSTOM_CLOSE_TYPE_CONTROLLABLE' — The Creative uses useCustomClose() functionally in MRAID. It may not be specified. It is NOT SPECIFIED. - CUSTOM_CLOSE_TYPE_NONE: It does not use useCustomClose(). - CUSTOM_CLOSE_TYPE_ENABLED: It uses useCustomClose(). - CUSTOM_CLOSE_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `auto_play_audio` 'UNKNOWN_AUTO_PLAY_AUDIO_TYPE' | 'AUTO_PLAY_AUDIO_TYPE_MUTED' | 'AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY' | 'AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE' — The Creative plays audio automatically; i.e., it starts muted. It may not be specified. It is NOT SPECIFIED. - AUTO_PLAY_AUDIO_TYPE_MUTED: It does not play audio automatically. - AUTO_PLAY_AUDIO_TYPE_AUTO_PLAY: It plays audio automatically. - AUTO_PLAY_AUDIO_TYPE_CONTROLLABLE: It is allowed to be changed with respect to target ad exchange. - `html_size_attributes` DspCreativeHtmlSizeAttributes — 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 condition in this message, the enclosing Creative passes; i.e., the Creative is not filtered out. - `interstitial` boolean — Passes as long as the inventory is for an interstitial ad. - `fixed` CreativeHtmlSizeAttributesFixed[] — Passes as long as the inventory size matches with one of the elements in the list. If the Creative can be rotated, then one should specify both configurations. For non-interstitial ads, at least one dimension is required. - … - `policy` DspCreativeDynamicHtmlSrcPolicy — Policy defines how to select CatalogItems. - `function` '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' — PolicyFunction defines algorithms for selecting CatalogItems or CreativeElements for a game. - IN_CART: GLOBAL_TREND will be deprecated and replaced by TREND. During A/B testing, we will keep this not to break the test. - MODEL: For model policies, the policy enum is in the form of MODEL_{SOURCER_TYPE}_{EVALUATOR_TYPE}_{EVALUATOR_SUB_TYPE} - GAME: GAME policy is used to select Creative elements of game. - RMP_AUDIENCE_EXTENSION: Policy for RMP Audience Extension. - MCM_ITEM_RECOMMENDATION: Policy for MCM Item Recommendation. - NEXT_ITEM_SELECTION: Policy for NEXT Item Selection. - `function_config` PolicyPolicyFunctionConfig — Configuration for PolicyFunction. Some PolicyFunction requires an instance of this message to get a function: Policy -> CatalogItem/CreativeElement list. - … - `num_items` integer — Number of items to be selected. - `catalog` string — Catalog ID. To know the types of catalogs supported, contact customer support. - `item_capper` PolicyItemCapper — Item-specific capper configurations. The configuration in this message is enforced: - across AdAccounts, - across Campaigns, - across AdGroups, - across CreativeGroups, and - across Creatives. - … - `transcoding_info` CreativeVideoSrcTranscodingInfo - `status` 'UNKNOWN_STATUS' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' — - IN_PROGRESS: The transcoding is in progress. - SUCCEEDED: The transcoding has succeeded. - FAILED: The transcoding has failed. Detailed reason can be found from failed_reason. - `failed_reason` string — Error message for the FAILED status. - `vast_video` DspCreativeVastVideoSrc — Source of VAST (Video Ad Serving Template) video Creative. - `vast_tag` string, required — VAST tag to be used in VAST wrapper. E.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` integer — Width of the Creative. - `height` integer — Height of the Creative. - `length_seconds` integer — Vast video length in seconds. - `feature_type` 'UNKNOWN_CREATIVE_FEATURE_TYPE' | 'GENERAL' | 'DYNAMIC_CREATIVE' — CreativeFeatureType. - `creator_tag` string — Creator tag to identify who is the resource creator. - `created_at` string, date-time — Created time. - `updated_at` string, date-time — Last updated time. Should not modify on the client side. ## Other responses - `default` — Error. Detailed cause can be found in the `details` field. --- [API](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api.md) · [All operations](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moloco/moloco-ads-campaign-management-api/revisions/5c85d0910ac0/schema)