New Creative
POST {{campaign_url}}/advertisers/:advertiserId/creatives?validateClickUrl=true&requirePreviewApproval=true
Create a new creative
You can create a new creative by sending this POST request. To define settings for your creative, open the body tab and edit the JSON object.
For all DTO fields and their nested DTOs, see the corresponding DTO tables below for field descriptions and allowed values.
Request Body (Definitions)
*Optional element
| JSON Object Key | Description | Type |
|---|---|---|
| name | Name of this creative. | string |
| mediaFormat | Media format of this creative. Allowed values: display, video, audio | string |
| adFormat | Ad format for this creative. Allowed values: standard (for display), standardVideo (for video), standardAudio (for audio) | string |
| advancedCreative (Only available if adFormat is standardVideo) | Identifies if this is an advanced creative produced by Nexxen Studio. | boolean |
| manifestUrl (Required if advancedCreative is true) | JSON URL for the creative (provided by Nexxen Studio for advanced creatives). | string |
amobeeAdServer (DTO) aka amobeeCreative DTO | Define this object if adding a creative using raw creative assets uploaded to the Nexxen DSP. Cannot be defined when thirdPartyCreative DTO is defined. | DTO |
thirdPartyAdServer (DTO) aka thirdPartyCreative DTO | Define this object if adding a creative using third-party tags or URLs. Cannot be defined when amobeeCreative DTO is defined. | DTO |
| *companion (DTO) (Only available if mediaFormat is videoor audio) | Companion ad for this creative, i.e., a display ad that appears alongside your Nexxen-hosted video/audio creative. | DTO |
| transcodingCompletionEmails (Only for Nexxen-hosted video/audio creatives, i.e., if mediaFormat is videoor audioAND amobeeCreative DTO is defined) | Email addresses to which notifications should be sent upon transcoding completion. | comma-separated array of strings |
| isSslCompliant | Identifies if creative is SSL-compliant, i.e., all of the following elements associated with the creative are secure: 1. All tags (including URLs and beacons) 2. Online Behavioral Advertising (OBA) tag used within AdChoices icon 3. Companion ad (if defined) 4. Third-party trackers (if defined) If true,this creative will be served on secure sites. | boolean |
| *expandableType | Defines how the creative asset/ad can be expanded past its original size. Allowed values: click, hover, auto | string |
| *expandableDirections (Required if expandableType is defined) | The direction(s) your ad can be expanded. Allowed values: up, down, left, right, auto | comma-separated array of strings |
| *thirdPartyTrackings | Tracking details for this creative. Up to five third-party platforms can be defined. | comma-separated array containing one or more thirdPartyTracking DTOs |
| *externalThirdPartyAdServerId | Unique ID for the creative, provided by the third-party ad server for reporting purposes. | string |
| *startDate | Start date of the creative's active period. Must be in the format yyyy-mm-ddThh:mm:ss+offset. | string |
| *endDate | End date of the creative's active period. Must be in the format yyyy-mm-ddThh:mm:ss+offset. | string |
| language | Defaults to the advertiser language. Allowed values | string |
| iabCategory | IAB-defined web content category associated with this creative (for targeting purposes). Allowed values | string |
| *disclosureAttributes (DTO) | Disclosure attributes that declare information about the functionality and/or contents of this creative. | DTO |
| status | Play status of this creative. Allowed values: play, pause, stop, archived, approved | string |
amobeeCreative DTO
Define this DTO if using Nexxen's ad server for this creative (i.e., creative assets are directly uploaded to the Nexxen DSP).
If adding a new creative using this method, you may need to send a POST Upload Asset request first.
| Key | Description | Type |
|---|---|---|
| creativeAssetKey | S3 UUID generated for a creative asset upon upload. Can be retrieved from any POST Upload Asset request. | string |
| adSizeId | ID of an ad size object (to fit the creative asset). Allowed values | integer |
| clickAction (DTO) | Behavior to trigger when a user clicks on this creative (URL redirect, call, or app download). | DTO |
clickAction DTO
| Key | Description | Type |
|---|---|---|
| url | Define a landing page URL (or application download link) to send the user to. | string |
| operatingSystem | Specify whether the download link—url—is for an iOS or Android app. OS ID can be retrieved from GET List of OS's. | string |
| phoneNumber | Define the phone number for a user to call. Must be entered without punctuation marks, as it would be dialed from the targeted region. Area code should match the location targeting criteria specified in line items associated with this creative. Note: A country code is only necessary if this creative targets multiple countries (not recommended). | string |
thirdPartyCreative DTO
Define this DTO if using third-party tags or ad server URLs for this creative.
| Key | Description | Type |
|---|---|---|
| provider | Third-party ad serving platform for this creative. Allowed values | string |
| tag (Use if mediaFormat is display) | Code snippet to generate a display creative (provided by the third-party platform). | string |
| adServerUrl (Use if mediaFormat is videoor audio) | Third-party ad server URL to generate a video or audio creative. | string |
| clickUrl | Application download URL provided by the third-party tracking vendor. | string |
| bypassTagValidation (Only available if tag is defined) | Identifies if validation for the provided tag should be bypassed to expedite creative upload. | boolean |
| adSizeId | ID of an ad size object (to fit the creative asset). Allowed values | integer |
| *fourthPartyProviders | Allowed values | comma-separated array of strings |
| mediaStandard | Media standard that this creative adheres to. Allowed values: html, mraid, mraid2, mraid3, vpaid1, vpaid2, vpaid3 | string |
| isVpaid (Only for third-party video creatives, i.e., if mediaChannel is videoand adServerUrl is defined) | Identifies if the creative is VPAID-compliant and can run on any compliant video player. Set to trueif mediaStandard is vpaid1_,_ vpaid2,or vpaid3_._ | boolean |
companion DTO
| Key | Description | Type |
|---|---|---|
amobeeAdServer (DTO) aka amobeeCompanion DTO | Define this object if adding a Nexxen-hosted companion creative. Cannot be defined when thirdPartyCompanion DTO is defined. | DTO |
thirdPartyAdServer (DTO) aka thirdPartyCompanion DTO | Define this object if adding a companion creative using third-party tags. Cannot be defined when amobeeCompanion DTO is defined. | DTO |
| *thirdPartyTrackings | Tracking details for the companion creative. Up to five third-party platforms can be defined. | comma-separated array containing one or more thirdPartyTracking DTOs |
amobeeCompanion DTO
Define this DTO if using Nexxen's ad server for the companion creative (i.e., creative assets are directly uploaded to the Nexxen DSP).
| Key | Description | Type |
|---|---|---|
| creativeAssetKey | S3 UUID generated for a creative asset upon upload. Can be retrieved from any POST Upload Asset request. | string |
| adSizeId | ID of an ad size object (to fit the creative asset). Allowed values | integer |
| clickUrl | Application download URL provided by the third-party tracking vendor (displays to user upon clicking). | string |
thirdPartyCompanion DTO
Define this DTO if using third-party tags for the companion creative.
| Key | Description | Type |
|---|---|---|
| tag | Code snippet to generate the companion creative (provided by the third-party platform). | string |
| provider | Third-party ad serving platform for this companion creative. Allowed values | string |
| adSizeId | ID of an ad size object (to fit the creative asset). Allowed values | integer |
| clickOrLandingPageUrl | Click URL or landing page URL for this companion creative. | string |
| *fourthPartyProviders | Allowed values | comma-separated array of strings |
| isCompanionOptional | Identifies whether the companion ad is optional or (alternatively) must be displayed alongside the creative. | boolean |
thirdPartyTracking DTO
| Key | Description | Type |
|---|---|---|
| provider | Third-party tracking platform for this creative. Allowed values | string |
| playerEvent (Only available if mediaFormat is audioor video) | Type of event (i.e., user action) to track and record data for. Allowed values | string |
| tracker | Third-party tracking URL or secure tag. | string |
disclosureAttributes DTO
| Key | Description | Type |
|---|---|---|
| adBehaviors | Attributes related to ad behavior and format/file details for this creative. Allowed values: animationAutoStart, animationHoverStart, animationClickStart, userInteractive, extremeAnimation, embeddedPop, audioContent, videoContent, outOfLayout, initialFileSizeOver30K | comma-separated array of strings |
| adContents | Content labels for this creative. Allowed values: noVisibleAdvertiseOrProductName, impliedWinnerOrSelectedUser, simulatedFormInteraction, systemAlert, political, crudeHumor, imageOfMan, imageOfWoman, partialBodyImage, lingerieOrUnderwear, bathingSuitNonSuggestive, bathingSuitSexuallySuggestive | comma-separated array of strings |
| bannedLanguageWords | Words (in the language specified) banned from use in this creative. | comma-separated array of strings |
| disclaimerTerms | Allowed values: none, footnoteNoTerms, footnoteGenericTerms, footnoteSpecificTerms | string |
| explicitLanguageWords | Explicit words (in the language specified) contained in this creative. | comma-separated array of strings |
| landingPages | Allowed values: noPrivacyPolicyLink, landingPageEntryPop, landingPageExitPop | comma-separated array of strings |
| offers | Offers made in the ad. Allowed values: tobacco, alcoholSpirits, alcoholBeerOrWine, OTCMedicine, prescriptionMedicine, supplementeOrHerbalRemedy, freeAccount, freeInformation, freeShareware, freeAdware | comma-separated array of strings |
| targetAudiences | Target audiences for this creative that fall within special categories. Allowed values: lgbt, alternativeLifestyles, childrenUnderAge13 | comma-separated array of strings |
| visibleDisclaimers | Written disclaimers visible in the ad. Allowed values: freeProductOrServiceIndirectAdvertiser, freeProductOrServiceSmallDirectAdvertiser, freeProductOrServiceFortune1000Advertiser, freeTrial, freeShipping, freeFinancing, lotteryGovernmentRun, sweepstakesOrContest | comma-separated array of strings |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
validateClickUrl | boolean | Indicates if the click URL (defined either in thirdPartyAdServer > clickUrl OR amobeeAdServer > clickAction > url) for this creative should be validated. Optional. |
If set as true and validation fails, the creative will not be created. |
| requirePreviewApproval | boolean | | Indicates if the transcoded versions of this creative require preview approval before use.
Optional for video and audio creatives; meaningless for display creatives. |
Request Body
{"name"=>"7/5 raw vid asset", "mediaFormat"=>"video", "adFormat"=>"standardVideo", "advancedCreative"=>false, "amobeeAdServer"=>{"creativeAssetKey"=>"{{videoAssetKey}}", "adSizeId"=>13, "clickAction"=>{"url"=>"http://www.amobee.com"}}, "companion"=>{"thirdPartyAdServer"=>{"provider"=>"doubleVerify", "tag"=>"<script src='https://www.googletagservices.com/dcm/dcmads.js'></script>", "adSizeId"=>179, "clickOrLandingPageUrl"=>"https://amobee.com", "isCompanionOptional"=>false}, "thirdPartyTrackings"=>[{"provider"=>"doubleVerify", "tracker"=>"https://doubleverify.com"}]}, "transcodingCompletionEmails"=>["myEmail@amobee.com", "myEmail2@amobee.com"], "isSslCompliant"=>true, "thirdPartyTrackings"=>[{"provider"=>"adCentric", "playerEvent"=>"collapse", "tracker"=>"https://adcentric.com"}], "language"=>"en", "iabCategory"=>"iab2-1", "disclosureAttributes"=>{"adContents"=>["noVisibleAdvertiseOrProductName", "political"], "adBehaviors"=>["userInteractive", "animationAutoStart"], "explicitLanguageWords"=>["put", "your", "words"], "bannedLanguageWords"=>["put", "your", "words"], "targetAudiences"=>["lgbt", "alternativeLifestyles"], "offers"=>["tobacco", "freeAccount"], "landingPages"=>["landingPageEntryPop", "landingPageExitPop"], "visibleDisclaimers"=>["freeShipping", "freeFinancing"], "disclaimerTerms"=>"footnoteNoTerms"}, "status"=>"play"}