id

int

The internal ID associated with the creative.

Auto-generated number

PUT, in query string

code

string (100)

The custom code for the creative.

code2

string (100)

The additional custom code for the creative.

name

string (400)

The name for the creative.

Read-only. The type of creative. Possible values:

• "standard"
• "html"
• "video"

advertiser_id

int

The ID of the advertiser to which the creative is attached.

POST/PUT, in query string, if the creative is attached to an advertiser

publisher_id

int

The ID of the publisher/media buy to which the creative is attached.

POST/PUT, in query string, if the creative is attached to a publisher

brand_id

int

The ID of the brand of the company advertising the creative. If included, it will be verified by the Xandr auditing team. If not included, it will be assigned by the auditing team. To retrieve a full list of brands, see the Brand Service.

state

enum

Read-only. The state of the creative. Possible values: "active" or "inactive".

campaigns

array of objects

The list of campaigns to which the creative is associated. For more details, see Campaigns below.

format

enum

Deprecated.

template

object

The creative template (ex.: template_id 6) for the creative's format and media type (i.e., flash and expandable). The template includes code to control how the creative renders on web pages. For more details, see Creative Template below.

POST

thirdparty_page

object

custom_macros

array of objects

The values for custom macros used in the creative template. For more details, see Custom Macros below.

POST, if template includes required custom macros

width

Int

The width of the creative; the string should contain an int.

POST, if template is for the "Banner" or "Expandable" media type

height

Int

The height of the creative; the string should contain an int. If the creative's template has a Pop media type, then either the creative's height must be set OR pop_window_maximize (in the pop_values field) must be true (but not both).

Notes:

• You can only submit pop creatives of accepted sizes for Xandr audit. If media_subtype_id within the template array is 4 (popunder) and audit_status is "pending", height must be set to 300 and width to 720. If media_subtype_id within the template array is 2 (popup) and audit_status is "pending", width and height must be one of the following: 250x250, 300x250, 550x480.

POST, if template is for the "Banner" or "Expandable" media type

media_url

string (1000)

The URL of the creative - can be image, flash, HTML, javascript (see format). URL must exist and should be on a CDN or equivalent.

POST, if not using content

media_url_secure

string (1000)

The URL of the secure (HTTPS) creative - can be image, flash, HTML, javascript (see format) to be served on a secure ad call. URL must exist and should be on a CDN or equivalent.

click_url

string (2000)

click_url is being deprecated in favor of click_target.

POST, if template is for the "image" format

file_name

string (1000)

The file name and extension for a hosted creative. Allowed file types: jpg, gif, png, swf, flv, mp4, wmv, f4v, avi, m4v, mov, and mpg.

POST, if adding a hosted creative

flash_click_variable

string (255)

The ClickTag variable in a Flash creative. Xandr can execute and track user clicks on a Flash creative only if you provide the exact variable in the file (clickTAG, ClickTag, Clicktag, etc). You can use the ClickTags Service to identify this variable. If you need to specify more than one ClickTag variable for a single creative, please contact support.

content

string

Javascript or HTML content when "format" is "raw-js" or "iframe-html". For a hosted creative, the content of the file must be base64-encoded and submitted as a string within the content field.

3rd party tag holder

POST, if not using media_url

content_secure

string

Javascript or HTML content when "format" is "raw-js" or "iframe-html" served on a secure ad call.

original_content

string

The value you pass into the "content" field through the UI will be returned in this field unchanged. The "content" field will contain the content modified by Xandr to properly serve. This field can also be uploaded directly through the API. In this case, the value uploaded to this field will be referenced in the content section of the UI (Creative Content > Tag field).

original_content_secure

string

See original_content. This is the secure version of this content.

macros

string

Read-only. The API pulls out macros and puts them in this field so that the bidder knows which macros to expect.

audit_status

enum

The audit status of the creative. Possible values: "no_audit", "pending", "rejected", or "audited".

Notes:

• If allow_audit is false, this field must be "no_audit".
• If a creative is expired, you can reanimate it by changing this field. Setting it to "pending" will resubmit it for auditing. For changes that automatically resubmit the creative for auditing, see Changes That Cause Re-Audit.
• You can only submit pop creatives of accepted sizes for Xandr audit. If media_subtype_id within the template array is 4 (popunder), audit_status can not be set to "pending" unless width is 720 and height is 300. If media_subtype_id within the template array is 2 (popup), audit_status can not be set to pending unless width and height are one of the following: 250x250, 300x250, 550x480.

"pending"

audit_feedback

string

Read-only. The creative auditing team can pass messages about a creative in this field.

allow_audit

Boolean

If true, the creative will be submitted for auditing. If false, the creative will not be submitted. Unaudited creatives can only run on a network's managed inventory.

Notes:

• If audit_status is "no_audit", this field must be "false".
• If your member is not yet active, you can add creatives, but they will not be submitted for audit (allow_audit will be false). Once your member has been activated, if you want these creatives to be audited, you must update the creatives and set allow_audit to true.
• You can only submit pop creatives of accepted sizes for Xandr audit. If media_subtype_id within the template array is 4 (popunder), allow_audit can not be set to 1 unless width is 720 and height is 300. If media_subtype_id within the template array is 2 (popup), allow_audit can not be set to 1 unless width and height are one of the following: 250x250, 300x250, 550x480.

true

ssl_status

enum

The ssl (HTTPS) status of the creative. Only creatives with ssl_status = approved will be eligible to serve on secure inventory. Note: If a creative fails the ssl Sherlock audit, you can submit it for a retest (once you've fixed the downstream non-secure content) by changing this field to "pending". Allowed values:

• "disabled"
• "pending"
• "approved"
• "failed"

"disabled"

allow_ssl_audit

Boolean

If true, the creative will be submitted for secure (HTTPS) auditing. If false, the creative will not be submitted. If true, either media_url_secure or content_secure is required as well.

false

msft_audit_status

enum

Deprecated.

msft_audit_feedback

string

Deprecated.

facebook_audit_status

enum

facebook_audit_feedback

string

is_self_audited

Boolean

If true, the creative is self-audited and thus will not go through Xandr platform audit. The creative can only serve on inventory that accepts your self-classified creative or on inventory that accepts unaudited creatives.

false

is_expired

Boolean

Read-only. If your creative (1) has not run and (2) has not been modified in 45 days, then it will be automatically marked expired and will not serve on any inventory.

• Expired creatives must be reaudited to run on third-party inventory. To unexpire a creative for third-party inventory, set audit_status to "pending".
• Expired creatives do not need to be reaudited to run on direct inventory. To unexpire a creative for direct inventory, set audit_status to "no_audit".

false

is_prohibited

Boolean

Read-only. If Sherlock flags the creative for having malware or loading blacklisted domains, this is set to true to prevent the creative from serving.

false

is_hosted

Boolean

Read-only. If true, the creative is hosted by Xandr.

lifetime_budget

double

The lifetime budget in dollars. Note: To include this field in a GET response, pass attributes=1 in the query string.

unlimited

lifetime_budget_imps

int

The lifetime limit for number of impressions. Note: To include this field in a GET response, pass attributes=1 in the query string.

unlimited

daily_budget

double

The daily budget in dollars. Note: To include this field in a GET response, pass attributes=1 in the query string.

unlimited

daily_budget_imps

int

The daily limit for number of impressions. Note: To include this field in a GET response, pass attributes=1 in the query string.

unlimited

enable_pacing

Boolean

If true, daily budgeted spend is spread evenly throughout a day. Note: To include this field in a GET response, pass attributes=1 in the query string.

true

allow_safety_pacing

Boolean

Admin-only. If true, spend per minute is limited to a maximum of 1% of the lifetime budget and 5% of the daily budget.

profile_id

int

You can attach targeting such as gender and geography to a creative by creating a profile and associating it here.

folder

object

To arrange your creatives in folders for convenience (usually in the UI) you will create a folder using the Creative Folder Service and then associate it here via folder ID or in the Creative Folder service via creative ID. Output is {"id": "41", "name": "MyFolder"}

pixels

array of objects

The pixels to serve with the creative. They can be for external impression tracking, external click tracking, or other purposes, such as adding the AdChoices icon to a creative. See Pixels below for more details.

pixel_url

string (100)

Deprecated. Please use the pixels array instead. The URL of an impression pixel to serve with the media URL or content.

pixel_url_secure

string (100)

Deprecated. Please use the pixels array instead. The URL of a secure (HTTPS) impression pixel to serve with the media URL content on a secure ad call.

pixel_type

enum

Deprecated. Please use the pixels array instead. The type of impression pixel. This field must be set if pixel_url is used. Possible values: "javascript" or "image".

no_iframes

Boolean

Deprecated. If true, the bidder will not serve this creative when an iframe is detected in the ad call.

false

track_clicks

Boolean

Deprecated.

true

flash_backup_content

string

POST/PUT, if using flash_backup_file_name

flash_backup_file_name

string

Write-only. This field must be used in combination with flash_backup_content. This is the file name and extension of the backup creative.

POST/PUT, if using flash_backup_content

flash_backup_url

string (100)

For a flash creative, this is the URL of a 3rd-party creative that will be served if the user's browser does not support flash. For an in-banner video creative, this is the URL of the poster image that will display before users click play and after the video has finished playing.

is_control

Boolean

This is a flag used to mark this creative as part of a control/test group in A/B testing. For more information, see Test and Control Targeting (Standard Line Item).

false

segments

array

A list of segments that a user will be added to upon viewing or clicking on this creative. For more information, see Segments below.

Example:

created_on

timestamp

Read-only. The date and time when this creative was created. If it was created before January 2010, this will be zero.

last_modified

timestamp

Read-only. The date and time when the creative was last modified.

media_subtypes

array of strings

Deprecated.

creative_upload_status

enum

Deprecated.

backup_upload_status

enum

Deprecated.

use_dynamic_click_url

Boolean

If true, the (optional) landing page URL for non-3rd party image and flash creatives is set at the campaign or line item level. See Dynamic Landing Pages for more information.

false

size_in_bytes

int

Read-only. The size of an uploaded creative (in bytes).

text_title

string (25)

The top line of text displayed in a text creative

POST, if template is for the "text" format

text_description

string (70)

The lower line of text displayed in a text creative

POST, if template is for the "text" format

text_display_url

string (35)

The readable URL displayed in a text creative

POST, if template is for the "text" format

click_action

enum

The action that the device should take when the creative is clicked. Currently, this field will be set to the only supported click action, "click-to-web"

"click-to-web"

click_target

string (2000)

The target of the click_action. For click-to-web, this is the click_url of the creative.

click_url will eventually be deprecated in favor of this field. In the meantime, setting click_url or click_target will have the same effect.

categories

array of objects

The categories that describe the creative and offer type. Note: To include categories in a GET response, pass attributes=1 in the query string. To retrieve a full list of categories, see the Category Service.
Example:

adservers

array of objects

Read-only. The ad servers that deliver the creative or are called for data collection purposes during the delivery of the creative. Note: To include adservers in a GET response, pass attributes=1 in the query string. To retrieve a full list of ad servers, see the  Ad Server Service.
Example:

technical_attributes

array of objects

The attributes that describe technical characteristics of the creative, such as "Expandable" or "Video". Note: To include technical attributes in a GET response, pass attributes=1 in the query string. To retrieve a full list of technical attributes, see the Technical Attribute Service.
Example:

language

object

The language of the creative. To retrieve a full list of languages, see the Language Service.
Example:

pop_values

array

Deprecated.

sla

int

Creatives set to "0" will be submitted for audit with a standard SLA.

If you have a supplemental services agreement with Xandr for priority audits, you can submit a creative for priority audit (auditing within 2 hours during business hours) by setting this field to 2. For more details about priority auditing, see Creative Standards and Auditing.

sla_eta

timestamp

Read-only. The estimate time of completion for a priority audit.

first_run

timestamp

Read-only. The date and time when the creative first served, refreshed on an hourly basis. This value reflects the UTC time zone. To include this information in a GET response, pass flight_info=true in the query string. For details about how to filter creatives based on when they first served, see First Run / Last Run below.

last_run

timestamp

Read-only. The date and time when the creative last served, refreshed on an hourly basis. This value reflects the UTC time zone. To include this information in a GET response, pass flight_info=true in the query string. For details about how to creatives based on when they last served, see First Run / Last Run below.

mobile

object

Information needed for mobile creatives to pass the creative audit. See Mobile below.

Attributes for third-party in-stream (VAST) and hosted video creatives.

stats

object

The stats object has been deprecated (as of October 17, 2016). Use the Report Service to obtain statistical information instead.

content_source

string

The source of this creative's content. Allowed values:

• "standard": This creative consists of content hosted on an ad server, that will generally be retrieved with a single HTTP request.

• "mediation": This creative is a container that is used to fetch content from another ad server for the purposes of mediation. Due to the way mediation is performed, this can involve making multiple HTTP requests in sequence. For more information, see the Creative Custom Request Template Service.

  If this field is set to "mediation", the following actions will occur:

  • A "mediation" technical attribute will be added to the creative's technical_attributes array.

  In addition, the following validations will be performed:

  • audit_status" cannot be set to "pending"; instead it will always be set to "no_audit".
  • allow_audit cannot be set to true; instead it will always be set to false.
  • The custom_request_template multi-object must be defined for the creative.
  • The custom_macros array must be populated with macros defined by the template parameters associated with the Custom Request Template.
  • The following fields will no longer be required:
    • content
    • media_url
    • template

"standard"

custom_request_template

multi-object

If the value of this creative's content_source field is set to "mediation", this object describes the association between this creative and a custom request template which is used to populate the creative with content. For more information, see Custom Request Template.

null

PUT, if content_source is set to "mediation"

competitive_brands

array of objects

Creatives associated with the brands in this array will not serve together in /mtj auctions. The classic example of competing brands is Coke vs. Pepsi. See Competitive Brands below. For more information about the brands in our system, see the Brand Service. For an overview of /mtj auctions, see MultiTags.

n/a

competitive_categories

array of objects

Creatives associated with the categories in this array will not serve together in /mtj auctions, e.g., "Dating" and "Education". See Competitive Categories below. For more information about the categories we apply to creatives (and brands), see the Category Service. For an overview of /mtj auctions, see MultiTags.

n/a

The asset id of the original file and a field describing what the asset must be used for. It is used to associate Xandr hosted files to your creative. This array will auto-populate when uploading files via the API. For more information, see Media Assets below.

The type of creative used.  Possible values: 

• "banner"
• "video" (includes audio types)
• "native"

This value determines how auction items are tracked for the line item's buying strategy, paying strategy, optimization options, creative association, and targeting options.

id

int

Read-only. The ID of the brand of the company advertising the creative.

name

string

Read-only. The name of the brand of the company advertising the creative.

Read-only. The name of the category associated with the brand.

id

int

The ID of the campaign. Either "id" or "code" is required when updating campaign association.

name

string

Read-only. The name of the campaign.

state

enum

Read-only. The state of the campaign. Possible values: "active", "inactive", or "parent_inactive".

code

string

The custom code for the campaign. Either "id" or "code" is required when updating line item association.

id

int

The ID of the brand.

n/a

n/a

name

string

The name of the brand.

n/a

n/a

id

int

The ID of the category.

n/a

n/a

name

string

The name of the category.

n/a

n/a

id

int

The ID of creative template.

name

string

Read-only. The name of the creative template.

media_subtype_id

int

Read-only. The ID of the media subtype assigned to the template. You can use the Media Subtype Service to view all supported media subtypes.

format_id

string

Read-only. The name of the format assigned to the template. You can use the Creative Format Service to view all supported formats.

code

string

The exact name of the macro, as it is used in the code of the creative template, for example, "BORDER_COLOR".

value

string

The value for the macro. Note that this value must match the type of the macro, as defined in the template. For example, if a macro is of the type "integer", the value must be an integer. The possible macro types are "true/false", "string", "url", "integer", "decimal", and "select_from_list"

id

int

The creative custom request template associated with this creative, if its content_source is set to "mediation". For more information, see the Creative Custom Request Template Service.

timeout_ms

int

If this is a "mediation" creative, it will make at least one HTTP request to an external ad server, which may in turn make one or more additional requests. This is the time beyond which we will not wait any longer for this creative to be populated with content. For more information, see the Creative Custom Request Template Service.

last_modified

timestamp

The date and time at which the custom request template was last modified.

name

string

Read-only. The name of the line item.

state

enum

Read-only. The state of the creative. Possible values: "active" or "inactive".

id

int

The ID of the line item. Either "id" or "code" is required when updating line item association.

PUT

code

string

The custom code for the line item. Either "id" or "code" is required when updating line item association.

PUT

media_asset_id

int

The unique ID of the creative asset.

creative_field

string

This field denotes what that particular creative asset must be used for. Possible valid values are:

• null (if asset is VAST or HTML5)
• media_url
• flash_backup_url
• native_icon_img_url
• native_main_media
• macro_CODE_FOR_MACRO - this is dynamically generated based on the macros for the selected template.

alternative_landing_page_url

string

An alternative landing page URL that can be viewed in a desktop browser for creatives that have a landing page targeted to a specific device, operating system, or carrier. You must provide an auditable URL in order for your creative to pass auditing.

The social context where the native ad will appear in the application. This varies depending on the media subtype of the native ad. For example, it may be a string such as "newsfeed".

url

string

The landing page of the native creative.

POST,PUT

fallback_url

string

A backup url if the main deeplink url is not supported.

url

string

A third-party tracking URL.

url_secure

string

(optional) A secure third-party tracking URL.

The asset type for the native creative. Possible values:

• sponsored_by
• title
• description
• rating
• call_to_action
• display_url

• likes

• downloads

• price

• sale_price

• phone

• address

• additional_description

The description of the data_type asset that you have specified.

• "sponsored_by" - brand name of the sponsor
• "title" - title of the creative
• "description" - description of the product or service being advertised
• "rating" - rating of the product being offered
• "call_to_action" - suggested action for next step
  
• "display_url" - the URL you would like displayed

• "likes" - social media likes

• "downloads" - number downloads/installs of this product

• "price" - Price for product / app / in-app purchase

• "sale_price" - sale price that can be used together with price to indicate a discounted price

• "phone" - phone number

• "address" - address

• "additional_description" - the longer version of your ad's description

The format of the image. Possible values include:

• icon_image
• main_image

The id of the media asset. Required for hosted native creatives.

The object containing details of the creative asset. Required for third-party native creatives. See details in Creative Asset Image below.

id

int

Read-only. The Xandr-assigned ID of the pixel array. You will associate pixels via the pixel_template_id, content, or URL fields listed below.

pixel_template_id

int

The ID of the Xandr-approved pixel. You can use the Pixel Template Service to get this ID.

param_1

string

For Xandr-approved pixel: The value for the first parameter in the pixel content or URL. To find out how many parameters are required for a Xandr-approved pixel, use the Pixel Template Service.

param_2

string

For Xandr-approved pixel: The value for the second parameter in the pixel content or URL.

param_3

string

For Xandr-approved pixel: The value for the third parameter in the pixel content or URL.

param_4

string

For Xandr-approved pixel: The value for the fourth parameter in the pixel content or URL.

param_5

string

For Xandr-approved pixel: The value for the fifth parameter in the pixel content or URL.

format

enum

The format of the pixel. Possible values: "raw-js", "url-html", "url-js", or "url-image".

content

string (255)

If the pixel format is "raw-js", the HTML or JavaScript content to serve with the creative.

secure_content

string (255)

If the pixel format is "raw-js", the HTML or JavaScript content to serve with the creative on a secure (HTTPS) ad call.

url

string (255)

If the pixel format is "url-html", "url-js", "url-image", or "raw-url", the URL of the HTML, JavaScript, or Image pixel to serve with the creative.

secure_url

string (255)

If the pixel format is "url-html", "url-js", "url-image", or "raw-url", the URL of the HTML, JavaScript, or Image pixel to serve with the creative on a secure (HTTPS) call.

pop_window_maximize

Boolean

If true, the publisher's tag should maximize the window. Only relevant for creatives with format "url-html" and "url-js". If pop_window_maximize is set to true, then neither "height" nor "width" should be set on the creative.

false

pop_is_tag_initiated

Boolean

If true, the creative's tag will initiate the pop. If false, then the impression bus will initiate the pop.

false

pop_window_title

string (255)

The title of the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers

Network name

pop_statusbar

Boolean

If true, a status bar is shown in the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers.

true

pop_menubar

Boolean

If true, a menu bar is shown in the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers.

true

pop_resizable

Boolean

If true, the popped window is resizable. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers.

true

pop_scrollbars

Boolean

If true, scroll bars are shown in the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers.

true

pop_toolbar

Boolean

If true, a toolbar is shown in the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers

true

pop_addressbar

Boolean

If true, an address bar is shown in the popped window. Only applies to pops with pop_is_tag_initiated set to false. Not guaranteed to be supported in all browsers

true

id

int

segment_id

int

The ID of the segment. This field contains the same information as the id field.

action

enum

The action taken by users that will add them to the segment. Possible values: "add on view" or "add on click".

user_ready

boolean

The status of the creative set by the user describing if the creative is ready to serve or not. Possible values: "true" or "false"

true

hosted_assets_association_complete

boolean / null

Read-only. Status of the creative uploaded by Xandr's internal systems. Possible values: "true" or "false" for hosted creatives and "null" for third-party creatives.