Challenge

You are planning to use the ADvendio Creative Upload features to manage your creatives in ADvendio and upload them directly to your Xandr network. Now you are wondering:


Solution

In order to setup the Creative Upload in ADvendio, there are so called Ad Creative Templates required. Those templates control, which fields and settings will be available in the Creative Upload UI and thus which information your Sales Reps will be able to see. Additionally you can determine for which Campaign Items, which Creative Template are available. This helps you for example to make sure to only use video creatives for your video Campaign Items and similar.

Also the templates will help to define which information is sent to which fields in Xandr. Each template in ADvendio will refer to a Creative Template in Xandr.

Underneath the each Ad Creative Template in ADvendio there are Template Variables, those can configure which fields are visible in the Creative Upload Screen, but also which settings or custom macros to use in Xandr.

Here is an overview about the data model and what it means:

ADvendio Object

Xandr

Ad Creative

The actual creative that will be uploaded to an advertiser in Xandr and will later be assigned to a line item

Campaign Item

represents the Line Item in Xandr

Creative Assignments

ADvendio assigns Creatives to Line Items in Xandr based on the Creative Assignment object in ADvendio.

Ad Creative Template

The Xandr Creative Template to use

Ad Creative Template Variable

The fixed settings and fields required for Xandr Creatives, more information can be seen below

Ad Creative Template Variable

Xandr Custom Macros from your template

To start configuring your ADvendio Org for the creative upload to Xandr, you need to follow these steps:

Which Features and Creative formats are currently supported for Xandr?

The following Creative formats are currently supported by ADvendio:

For the first version ADvendio only supports uploading actual image files to Xandr, the support of URLs to externally stored images as well as other formats will be supported soon.

The following features are currently supported:

Create an Ad Creative Templates in ADvendio

You start of by creating your Ad Creative Template in ADvendio, this will help you to configure the types of creatives you want to manage from ADvendio.

To use this for Xandr, you need to know the Xandr template IDs, so you can enter this information in ADvendio. To view the templates in Xandr, go to network → tools → Creative Templates

You see a list of all default templates from Xandr and your own custom templates. Relevant for ADvendio is the first column ID.

Let’s say we want to use the Standard Banner image template, which is default from Xandr. So we take the ID 4. Now we proceed to create an Ad Creative Template record in ADvendio, which could look like this:

  1. Creative Template Name: You can pick any name that you like. This name will be shown to the user when uploading a new creative to ADvendio, so we recommend using something which is relatable for your users

  2. Connection: Please link to the connection record, which represents your Xandr network

  3. Creative Type: You can use this field to further classify

  4. Template ID: please enter the Creative Template ID from Xandr, which you are planning to use. In our example it is '4'

  5. External Status: Currently not used

  6. Active: Please set your template to active, otherwise it will not be available during the creative upload process

Configure your Ad Creative Template Variables

Once the template is there, you will need to define which fields you want or need to use. In our example there are a few fixed variables we always need for the Xandr banner. Additionally you can add Custom Macros as Variables to ADvendio, so that they will be used during the Creative Upload.

To manage the variables of a template, you need to switch to the related tab in your Ad Creative Template record and view the related list ‘Ad Creative Template Variables’

Click the button new to create a new Variable. Depending on your creative format there are certain Variables which are always required. See also the section on the mapping below. Also you will need a Variable record for each Custom Macro of your template. Each Variable record you create will then be an own field in the Creative Upload window your user sees, so they can fill in the required information.

The fields mean the following:

Mapping ADvendio Variables to Xandr

ADvendio Variable ID

Field to target

Relevant Variable Type

Possible Values

Required

Relevant for Creative Formats

File

The actual image file to upload

attachment

 

(tick) You either need to provide a file or a MediaURLSecure, in order for the upload to work

Images

MediaURLSecure

The URL to an externally stored file

attachmentURL

(tick) You either need to provide a file or a MediaURLSecure, in order for the upload to work

All formats

MediaURL

If required, you can set a different, ‘non-secure’ URL to the externally stored file.

attachmentURL

(error)

All formats

DestinationURL

Click URL where the ad leads

string

 

(tick)

All formats

Width

the creative width

integer

(tick)

All formats

Height

the creative height

integer

(tick)

All formats

API Name of a Custom Macro

The Custom Macro

depending on the macro

Depends on the macro

All formats

Example for a Xandr Creative Template in ADvendio

So to use the Xandr Creative Upload a simple example for a template can look like this:

AdCreative Template Field

Value

Name

Standard Banner Image (File Upload)

Creative Type

Banner

Template ID

4

Connection

The connection record of your Xandr network

Active

True

Underneath this AdCreative template, the following AdCreative Template Variables are created:

Ad Creative Template Variable Name

Variable Type

Variable ID

Possible Values

Required

Help Text

Default Value

Image File

attachment

File

True

Upload the image file you want to use for your ad

Goal URL

string

DestinationURL

True

Enter which URL a user should reach, once the ad is clicked. Please use ‘http://example.com’

http://www.example.com

Image Width

integer

Width

True

Please enter the height of your ad.

Image Height

integer

Height

True

Please enter the width of your ad.

Connect your Template to Ad Types

Once the template is created with all its Ad Creative variables, you will need to define for which Ad Types you would like to assign this template. Without assigning the Templates to Ad Types you won’t be able to create new Creatives in the UI as described in: 4.12.2 How to upload Ad Materials (Creatives) to ADvendio? (BETA)

To connect the template to one or multiple Ad Types please go to the related lists of the Ad Creative Template record. For the related list “Assigned Ad Types“ you just need to hit the new button in order to select the relevant Ad Type for which this template and its variables should be usable. After you selected the Ad Type you can either hit the save button if you just want to assign one Ad Type. If you would like to assign multiple Ad Types you can also hit the Save & New button.

Setting up Native Formats

Natives in Xandr can contain a huge variety of different fields and settings to provide. In order to prepare those from ADvendio, you will first need to create specific Ad Creative Templates.

The template ID for this one always needs to be ‘39461’ since this is the ID Xandr uses for Natives. In ADvendio you are of course free to create multiple

To set up the Variables in ADvendio, there is a big list of options you could use which represent the different settings of the natives.

Roughly you could separate those into three different types:

  1. The Basic settings like the name and the URL of the landing page

  2. The actual elements of the native, like a title, body text, buttons and similar. They are also referred to as data assets

  3. The image assets which will be used within the native, for example as main image or icon. In the current release ADvendio does not support video files, only images.

Most of these settings are optional, so you are free to only create those Ad Creative Template Variables in ADvendio, which you are planning to actually use.

The Basic Setup

For the basic settings, you will only need a variable, which represents the landing page URL, as the Creative Name is a default field in ADvendio.

ADvendio Variable ID

Field to target

Relevant Variable Type

Possible Values

Required

URLLinkAttribute

The landing page URL for the native

string

 

(tick)

FallbackURLLinkAttribute

string

(error)

Composition / Data Assets

To actually define the native, Xandr offers a variety of elements, like the Title, a body text, Call to actions and similar. We summarized those as Data Assets. For each of this Xandr fields that is relevant for you, you can create a ad creative template variable in ADvendio. None of these is required for the submit to Xandr to work.

ADvendio Variable ID

Field to target

Relevant Variable Type

DataAssetTitle

The title of the native

string / integer / text field

DataAssetDescription

The main body text of the native

string / integer / text field

DataAssetSponsoredBy

Sponsored By field in Xandr

string / integer / text field

DataAssetCallToAction

Call to Action field in Xandr

string / integer / text field

DataAssetDisplayURL

Display URL field in Xandr

string / integer / text field

DataAssetPrice

Price Field in Xandr

string / integer / text field

DataAssetSalePrice

Sales Price field in Xandr

string / integer / text field

DataAssetRating

Rating field in Xandr

string / integer / text field

DataAssetLikes

Likes field in Xandr

string / integer / text field

DataAssetDownloads

Downloads field n Xandr

string / integer / text field

DataAssetPhone

Phone field in Xandr

string / integer / text field

DataAssetAddress

Address field in Xandr

string / integer / text field

DataAssetAdditionalDescription

Additional Description field in Xandr

string / integer / text field

DataAssetCustomTitle1 … DataAssetCustomTitle5

string / integer / text field

DataAssetCustomBody1 ... DataAssetCustomBody5

string / integer / text field

DataAssetCustomCallToAction1 … DataAssetCustomCallToAction5

string / integer / text field

DataAssetCustomSocialURL1 … DataAssetCustomSocialURL5

string / integer / text field

DataAssetCustomDisplayURL1 … DataAssetCustomDisplayURL5

string / integer / text field

Image Assets & Attachments

You are able to provide multiple images and icons for your native creatives in Xandr.

Image Type

ADvendio Variable ID

Field to target

Possible values

Relevant Variable Type

Required

Main Image

ImageFileMain

The image file to attach as main image for a native

string

(tick)

If you want to use an image, either attaching a file or a secure URL to an externally stored image is required

ThirdPartyImageURLMain

An optional URL to an externally stored image file without secure protocol, setting this is optional and the asset is not necessarily visible in the Xandr UI

string

(error)

ThirdPartyImageURLSecureMain

A URL to an externally stored image file to use as main image

string

(tick)

If you want to use an image, either attaching a file or a secure URL to an externally stored image is required

ThirdPartyImageWidthMain

The width of the image, is using an externally stored image

integer

(tick)

If using a URL to an externally stored image, providing size information is required

ThirdPartyImageHeightMain

The height of the image, is using an externally stored image

integer

(tick)

If using a URL to an externally stored image, providing size information is required

ResizeEnabledMain

Optional setting to automatically

true, false

picklist

(error)

CropEnabledMain

true, false

picklist

(error)

AspectRatioUpperBoundMain

number between 0 and 50

integer

(error)

AspectRatioLowerBoundMain

number between 0 and 50

integer

(error)

MaxScaleFactorMain

number between 1.00 and 9.99

integer

(error)

Icon Image

ImageFileIcon

The image file to attach as main icon for a native

string

(tick)

If you want to use an image, either attaching a file or a secure URL to an externally stored image is required

ThirdPartyImageURLIcon

An optional URL to an externally stored image file without secure protocol, setting this is optional and the asset is not necessarily visible in the Xandr UI

string

(error)

ThirdPartyImageURLSecureIcon

A URL to an externally stored image file to use as main icon

string

(tick)

If you want to use an image, either attaching a file or a secure URL to an externally stored image is required

ThirdPartyImageWidthIcon

The width of the image, is using an externally stored image

integer

(tick)

If using a URL to an externally stored image, providing size information is required

ThirdPartyImageHeightIcon

The height of the image, is using an externally stored image

integer

(tick)

If using a URL to an externally stored image, providing size information is required

ResizeEnabledIcon

Optional setting to automatically

true, false

picklist

(error)

CropEnabledIcon

true, false

picklist

(error)

AspectRatioUpperBoundIcon

number between 0 and 50

integer

(error)

AspectRatioLowerBoundIcon

number between 0 and 50

integer

(error)

MaxScaleFactorIcon

number between 1.00 and 9.99

integer

(error)

Custom Image 1 - 5

ImageFileCustom1 …

ImageFileCustom5

Similar to the above examples, you can provide the files for the custom images 1-5

Custom Icon 1 - 5

IconFileCustom1 …

IconFileCustom5

Similar to the above examples, you can provide the files for the custom icons 1-5

Known Issue Information:

Currently we’re experiencing problems when using URLs to externally stored images in Xandr natives.

The Xandr API requires to also set additional image size information with the URL. This is later not visible in the Xandr UI. We’re trying to clarify the background at the moment and provide a solution for our customers, so that you don’t have to manually type in the information every time in ADvendio.

A patch is expected to arrive in December


Setup