Follow

Create Creative

Table of Contents
  1. 1. Overview
  2. 2. Arguments
      1. 2.1.1. Example
    1. 2.2. Results
      1. 2.2.1. SUCCESS
      2. 2.2.2. FAILURE
  3. 3. Related

Overview

The Create Creative command allows you to define and create a new Creative that can be used to generate new templates.  The command allows you to specify several components of a Creative.  Use POST to send large blocks of body data.  More advanced control of the Creative properties must be set through the web interface.    

Arguments

Create Creative requires the following arguments: Command, Realm, Password, and Creative (Template) Name.

api_web?r=myrealm&p=mypass&c=createcreativelibrary&template_name=My+Creative

The command is ‘createcreativelibrary’, the realm is ‘myrealm’ and the password is ‘mypass’.  The new, empty creative will be named ‘My Creative’.

The Create Creative command supports the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd= createcreativelibrary

c= createcreativelibrary

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Creative (Template) Name

Yes

Name of the creative to create. To include spaces, use + or %20 to avoid possible issues with spaces in a URL.

template_name= [creative_name]

Plain Body

 

Plain-Text content to send. 

template_body_plain=[text]

HTML Body

 

HTML content to send. 

template_body_html=[text]

Folder   Identifier of the Folder to associate the Creative for organization.  Default folder is 0, or Unfiled. folder_id=[folder_id]

 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=createcreativelibrary&template_name=mycreative&template_body_plain=this%20is%20a%20Plain%20test&template_body_html=this%20is%20an%20HTML%20test&folder_id=3

Successful results return, where ‘42’ is the ID of the new creative:

SUCCESS: 42

This is a very simple example.  You can also POST the values, which allows you to send much larger template body data.

Results

The Create Creative command outputs either a SUCCESS or FAILURE message. 

SUCCESS

The Create Creative command success message returns the id of the new creative.  The result format is:

SUCCESS: [creative_id]

FAILURE

A Create Creative command will fail if a creative with the same name already exists or invalid data is defined.  The result format is:

FAILURE: [Reason]  

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk