v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
creatives

Inserts a new creative.

post/userprofiles/{+profileId}/creatives

Path parameters

profileIdstring required

User profile ID associated with this request.

Request body

htmlCodestring

HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.

backupImageReportingLabelstring

Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".

type'IMAGE' | 'DISPLAY_REDIRECT' | 'CUSTOM_DISPLAY' | 'INTERNAL_REDIRECT' | 'CUSTOM_DISPLAY_INTERSTITIAL' | 'INTERSTITIAL_INTERNAL_REDIRECT' | 'TRACKING_TEXT' | 'RICH_MEDIA_DISPLAY_BANNER' | 'RICH_MEDIA_INPAGE_FLOATING' | 'RICH_MEDIA_IM_EXPAND' | 'RICH_MEDIA_DISPLAY_EXPANDING' | 'RICH_MEDIA_DISPLAY_INTERSTITIAL' | 'RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL' | 'RICH_MEDIA_MOBILE_IN_APP' | 'FLASH_INPAGE' | 'INSTREAM_VIDEO' | 'VPAID_LINEAR_VIDEO' | 'VPAID_NON_LINEAR_VIDEO' | 'INSTREAM_VIDEO_REDIRECT' | 'RICH_MEDIA_PEEL_DOWN' | 'HTML5_BANNER' | 'DISPLAY' | 'DISPLAY_IMAGE_GALLERY' | 'BRAND_SAFE_DEFAULT_INSTREAM_VIDEO' | 'INSTREAM_AUDIO'

Required. Type of this creative. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.

totalFileSizestring int64

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

compatibilitystring[]

Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"

htmlCodeLockedboolean

Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.

overrideCssstring

Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.

studioTraffickedCreativeIdstring int64

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

convertFlashToHtml5boolean

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

latestTraffickedCreativeIdstring int64

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

advertiserIdstring int64

Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types.

customKeyValuesstring[]

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

thirdPartyRichMediaImpressionsUrlstring

Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.

artworkType'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE'

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

redirectUrlstring

URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT

backupImageFeaturesstring[]

List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

thirdPartyBackupImageImpressionsUrlstring

Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.

authoringTool'NINJA' | 'SWIFFY'

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.

subaccountIdstring int64

Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

authoringSource'CREATIVE_AUTHORING_SOURCE_DCM' | 'CREATIVE_AUTHORING_SOURCE_DBM' | 'CREATIVE_AUTHORING_SOURCE_STUDIO' | 'CREATIVE_AUTHORING_SOURCE_GWD' | 'CREATIVE_AUTHORING_SOURCE_ACS' | 'CREATIVE_AUTHORING_SOURCE_ADOBE' | 'CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI' | 'CREATIVE_AUTHORING_SOURCE_REMBRAND' | 'CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO' | 'CREATIVE_AUTHORING_SOURCE_BORNLOGIC' | 'CREATIVE_AUTHORING_SOURCE_BEGEN_AI'

Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.

idstring int64

ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.

backgroundColorstring

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.

renderingIdstring int64

ID of current rendering version. This is a read-only field. Applicable to all creative types.

activeboolean

Whether the creative is active. Applicable to all creative types.

versioninteger

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.

autoAdvanceImagesboolean

Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.

requiredFlashVersioninteger

The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.

mediaDurationnumber float

Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.

sslCompliantboolean

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.

accountIdstring int64

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.

namestring

Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types.

sslOverrideboolean

Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.

adParametersstring

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.

allowScriptAccessboolean

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.

mediaDescriptionstring

Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.

requiredFlashPluginVersionstring

The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

commercialIdstring

Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.

adTagKeysstring[]

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

skippableboolean

Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.

studioAdvertiserIdstring int64

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

studioCreativeIdstring int64

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.

archivedboolean

Whether the creative is archived. Applicable to all creative types.

companionCreativesstring[]

List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.

Response

Successful response