Ad Assets

You can create and manage additional ad assets, like carousel cards, using these fields.

Fields

The following fields are available for creating and managing ad assets:

Name

Description

Type

Add

Update

Ad ID

The ID of the ad associated with the asset.

long

required

optional

Object ID

The ID of the ad asset.

long

N/A

required

Title

Title text used for the ad asset. Maximum limit is 50 characters. Use {city}, {state}, {state_abbr}, {country} and {country_abbr} macros to add geo locations for user personalized ads. Use the {time} macro for flash sale ads.

string

Required for carousel card assets. Ignored for tile assets and DCO title variation assets. Ignored for other asset types.

optional

Description

Description text displayed when your ad asset appears in content streams or in the other eligible native ad positions. Maximum 150 characters. Use {city}, {state}, {state_abbr}, {country} and {country_abbr} macros to add geo locations for user personalized ads. Use the {time} macro for flash sale ads.

string

Required for carousel card assets and DCO description variation assets. Ignored for other asset types.

optional

Ad Image URL

For carousel card asset, a valid URL for a square image. The ideal image size is 627x627; smaller images will not be accepted. Larger images with either the same aspect ratio or with a height and width that are off the ideal dimensions by up to a combined 10% will be accepted and automatically cropped at the center.The maximum size is 7MB. For a touchpoint asset, a valid URL for a modal image that will be displayed when a touchpoint asset is clicked for this popup image to appear. The ideal image size is must have aspect ratio between 3:4 and 1:1. Minimum width is 612px (which means height must be between 612px and 816px for an image with 612px width). Maximum width is 1500px (which means height must be between 1500px and 2000px). The effective minimum dimensions are therefore 612x612 and maximum dimensions are 1500x2000. The maximum size is 7MB.

string

Required for carousel card assets. DCO image variation assets, and model touchpoint assets. Ignored for other asset types.

optional

Ad HQ Image URL

For a carousel asset, a valid URL to a high resolution image that will be used. The ideal image size is 1200x627; smaller images will not be accepted. Larger images with either the same aspect ratio or with a height and width that are off the ideal dimensions by up to a combined 10% will be accepted and automatically cropped at the center. The maximum file size is 7MB.

string

Required for carousel card assets and DCO image variation assets. Ignored for other asset types.

optional

Ad Thumbnail Image URL

A URL to a high-resolution image for an ad. The original image will be scaled to 180 x 180 pixels and can only be a JPEG or PNG image.

string

Optional for DCO image variation assets. Ignored for other asset types.

optional

Fixed position
The position of the tile asset. Supported for button tile asset only. Values are:

  • NONE

  • BOTTOM (snap globally to bottom. Only one button asset can have this setting for entire tiles ad)

enum

Optional. Default: NONE. Applicable for button tiles only.

optional

Fit to Height

Whether to fit the image tile asset to height (true) or width (false).

boolean

Optional. Default: FALSE (i.e., fit to width). Applicable for image tile only.

optional

Status
The status of the ad asset. Valid values are:
  • Active

    • Deleted

Ad assets are defaulted to Active if no status is provided upon creation. Deleted is used to remove assets during an Update action. You can also use the Delete action for this operation.

enum

optional

optional

Ad Primary Video URL

For carousel card asset, a valid video URL.

  • Format: .mp4, .mp4v or .mov

  • Max File Size: 1GB

  • Min video length: 5sec

  • Max video length: 30sec (for App Install), 5min otherwise.

  • Min video quality: 480p 500kbps.

  • Min audio quality: If the video has audio, then it must have 2 channel stereo 64kbps.

string

Optional for carousel card assets. Ignored for tile assets.

optional

Ad Asset URL
For image tile asset, a valid image URL. Minimum size is 200x200. Maximum size is 2MB. For video tile asset, a valid video URL.

  • Format: .mp4, .mp4v or .mov

  • Max File Size: 1GB

  • Min video length: 5sec

  • Max video length: 5min

  • Min video quality: 480p 500kbps.

  • Min audio quality: If the video has audio, then it must have 2 channel stereo 64kbps.

For text tile asset, a valid HTML URL. Maximum number of embedded links (hrefs) in the HTML is 3. Whitelisted HTML tags:

  • <a>

  • <br>

  • <div>

  • <p>

  • <section>

  • <span>

  • <strong>

  • <b>

  • <i>

  • <button>

Whitelisted CSS attributes

  • color

  • background-color

  • padding

  • padding-bottom

  • padding-left

  • padding-right

  • padding-top

  • text-align

  • font-family

  • font-size

  • font-style

  • font-weight

  • text-decoration

  • outline

  • outline-color

  • line-height

For button tile asset, a valid HTML URL. No embedded links (hrefs) allowed. Whitelisted HTML tags:

  • <a>

  • <br>

  • <div>

  • <em>

  • <p>

  • <section>

  • <span>

  • <strong>

  • <b>

  • <i>

Whitelisted CSS attributes

  • color

  • background-color

  • padding

  • padding-bottom

  • padding-left

  • padding-right

  • padding-top

  • text-align

  • font-family

  • font-size

  • font-style

  • font-weight

  • text-decoration

  • outline

  • outline-color

  • line-height

string

Required for tile assets. Ignored for other asset types.

Video Caption URL

Optional video caption file url to accompany the video url provided for carousel or video tile assets. Maximum url length is 1024 characters. The technical requirements for captions are:

  • Format: .vtt or .srt

    • Maximum File Size: 1MB

    • Maximum 3 lines of text per caption time entry/stamp in the file.

string

Applicable for carousel card or video tile assets. Ignored for other asset types.

optional

Video Autoloop

Optional video autoloop flag to accompany the video url provided for carousel or video tile assets.

boolean

optional. Default:false. Applicable for carousel card or video tile assets. Ignored for other asset types.

optional

Call To Action Text

Call to action buttons used to help drive users to take specific actions. The supported call-to-action text values are same as ones defined for Ads

enum

Optional for carousel card assets. Not applicable for other asset types.

optional

Match Type

A key-value list of styles to represent additional touchpoint styles.

Possible values are:

  • x (x-coordinate)

  • y (y-coordinate)

  • w (width)

  • h (height)

Validations:

  • x, y are required

  • x, y, w, h must all fit within the background image

  • w and h are optional, but if w is provided, then h must be as well (and vice versa). Default w and h are 48px

  • Touchpoints cannot overlap. So a 10x10 touchpoint at (15, 15) cannot co-exist with a 10x10 touchpoint at (24, 13).

  • Touchpoints also need to be a minimum distance from the edges

    • 130px from left/right

    • 0px from bottom

    • 107px from top

Example:

x=40, y=100, w=75, h=75

Key-Value pairs

Applicable and required for touchpoint assets only.

optional

Asset Name

The name for the asset used for reporting purposes only, not for ad rendering.

string

Optional for touchpoint assets. Ignored for other asset types.

optional

Template Type

The template type of ad asset. Valid values are:

  • DEFAULT (transparent)

  • TAG_LIGHT

  • TAG_DARK

  • PLUS_LIGHT

  • PLUS_DARK

  • DOT_LIGHT

  • DOT_DARK

enum

Optional for touchpoint assets. Selected option results in the icon used for the touchpoint. Ignored for other asset types

optional

Index

Horizontal index ordering of assets. For carousel assets (type=MULTI_IMAGE) the values must be unique for every active asset and must be between 0 and 4. Minimum 3 assets are required for carousel ad.

For tile assets the pair of horizontal index and vertical index values must be unique for every active asset. Horizontal index must be between 0 and 4. Minimum 3 assets are required for horizontal tiles. 3-5 image or video tiles grouped with the same horizontal index are considered one carousel grouped tile.

No more than 3 carousel grouped tiles per tiles ad. Only image and video tiles are allowed for carousel group.

For DCO (Dynamic Creative Optimization), you can choose 3 specific attributes - Title, Description, and Image - and three variants for each of those 3 attributes (a maximum of 27 combinations in all [3x3x3]). Note that you don’t have to use all 3 attributes included in DCO. For example, you can choose to set 3 options for the Title, 2 options for the Description, and 1 option for the Image. This will make DCO work with 6 ad combinations only (3x2x1).

integer

Required for carousel card assets and tile assets. Ignored for touchpoint and DCO assets

optional

Vertical Index

Vertical index ordering of assets. Not applicable for carousel assets. For tile assets the pair of horizontal index and vertical index values must be unique for every active asset. Vertical index must be between 0 and 19. Minimum 1 asset are required for for vertical tiles. Maximum 20 total tiles.

integer

Required for tile assets. Ignored for other asset types.

optional

Landing URL

The landing URL associated with the asset. The landing URL is the web address that a user is sent to after clicking on the ad. Maximum limit is 2048 characters. The landing URL should include the tracking params provided by the tracking partner that was specified at the campaign level for app installs. Use {city}, {state}, {state_abbr}, {country} and {country_abbr} macros to add geo locations for user personalized carousel ads.

string

Required for carousel card assets, button tile assets, and label touchpoint assets. Optional for image and video tile assets. Ignored for other asset types.

optional

Create a Tile Ad Asset

The following example contains the fields required for creating a tile ad asset. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Ad ID

Ad Asset URL

Match Type

Index

Vertical Index

Add

Ad Asset

75614

www.imageurl.com

TILES_IMAGE

0

0

Create a Modal Touchpoint Asset for an Image Portrait Ad

The following example contains the fields required for creating a touchpoint ad asset for an image portrait ad. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Ad ID

Ad Asset URL

Landing URL

Match Type

Template Type

Ad Asset Styles

Add

Ad Asset

75614

http://www.modal-touchpoint-imageurl.jpeg

http://www.touchpointlandingpage.com

TOUCHPOINT_PORTRAIT

TAG_LIGHT

x=1, y=2, w=3, h=4

Create a Label Touchpoint Asset for an Image Panorama Ad

The following example contains the fields required for creating a touchpoint ad asset for an image panorama ad. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Ad ID

Landing URL

Match Type

Template Type

Ad Asset Styles

Add

Ad Asset

75614

http://www.touchpointlandingpage.com

TOUCHPOINT_PANORAMA

TAG_LIGHT

x=1, y=2, w=3, h=4

Create DCO Assets

The following example contains the fields required for creating a DCO variant ad assets. All other fields in this spreadsheet are blank and are not shown:

Action

Object Type

Ad ID

Match Type

Title

Description

Ad Image URL

Ad HQ Image URL

Add

Ad Asset

75614

DCO

Tile variation 1

Add

Ad Asset

75614

DCO

Description variation 1

Add

Ad Asset

75614

DCO

http://image.variation1.jpeg

http://image.hq.variation1.jpeg