ADITION technologies - API Documentation

Banner WSDL

This service is used to create and modify advertisement creatives.
This service is stateful.

Examples +

banner
banner

addtop

Deprecated 2011-01-01

This method will be removed in upcoming releases.

Use save() to persist a new entity

Description

Saves changes made to the Banner

int add()

Return Values

int	The ID of the Banner (unique)

addClickWordtop

Description

Adds a ClickWord to the Banner

boolean addClickWord(string $click_tag, string $click_word, string $click_url, int $encoding)

Parameters

string	$click_tag	$clickTag Unique Index for the ClickWord
string	$click_word	$clickWord The ClickWord
string	$click_url	$clickUrl The ClickUrl
int	$encoding	The Encoding flag, 0 for no URL encoding, 1 for URL encoding

Return Values

boolean

appendFiletop

Description

Adds an image to the filestorage.
Data has to be filled with base64 encoded image data.

This function delivers a basic functionality. It will not allow you to add
an additional or alternative flash file for the tandem banner, please
use appendTaggedFile($name,$data,$tag) instead.

image/jpeg]

boolean appendFile(string $name, string $data, string $type)

Parameters

string	$name
string	$data	Base64 encoded image data
string	$type	Mimetype of file. Allowed types: [application/x-shockwave-flash, image/png, image/gif,

Return Values

boolean

appendTaggedFiletop

Description

Adds a tagged file to the files.
The filetype will be automacically detected.

boolean appendTaggedFile(string $name, string $data, string $tag)

Parameters

string	$name
string	$data
string	$tag

Return Values

boolean

clearObjectDatatop

Description

Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.

boolean clearObjectData()

Return Values

boolean

copytop

Description

Copy a banner to a new location

int copy(int $parent_id, string $parent_type, boolean $dateadjust)

Parameters

int	$parent_id
string	$parent_type
boolean	$dateadjust	True (default) to adjust the banner runtime to the campaign runtime, false otherwise

Return Values

int

doComplexCalltop

Description

Execute a complex call.
For further information read the API-User documentation.

string doComplexCall(string $xmlstr)

Parameters

string

$xmlstr

XML of Complex Statements

Return Values

string

The output produced by the statements

edittop

Deprecated 2011-01-01

This method will be removed in upcoming releases.

Use save() to persist changes made to an entity

Description

Saves changes made to the Banner

boolean edit()

Return Values

boolean

TRUE on succes, FALSE on fail

getActivetop

Description

Returns true if the current banner is active, false otherwise.

boolean getActive()

Return Values

boolean

getAltTagtop

Description

Gets the alt tag of the banner.

string getAltTag()

Return Values

string

getAltUrltop

Description

Gets the alt URL of the banner.

string getAltUrl()

Return Values

string

getBannerTypetop

Description

Gets the type of current banner.

string getBannerType()

Return Values

string

getClickUrltop

Description

Gets the click URL of the banner.

string getClickUrl()

Return Values

string

getClickWordByClickTagtop

Description

Returns a ClickWord array by its ClickTag

string getClickWordByClickTag(string $click_tag)

Parameters

string

$click_tag

Return Values

string

getClickWordstop

Description

Returns a list of Banner ClickWords

string getClickWords()

Return Values

string

getCreatedatetop

Description

Gets the date of creation.

string getCreatedate()

Return Values

string

getDbtSettingstop

Description

Gets DBT/shop relevant settings.

DbtSettings getDbtSettings()

Return Values

DbtSettings

getEnddatetop

Description

Gets the expiration date.

string getEnddate()

Return Values

string

getExternalIdtop

Description

Gets the external id

string getExternalId()

Return Values

string

getFileDatatop

Description

Gets the image data by the given name.

string getFileData(string $name)

Parameters

string

$name

Return Values

string

base64 encoded string!

getFileNamestop

Description

Gets all files assigned to this banner.

string getFileNames()

Return Values

string

getFlashParametersComplexTypetop

Description

Gets flash parameters

FlashParameters getFlashParametersComplexType()

Return Values

FlashParameters

getHeighttop

Description

Gets the banner height.

int getHeight()

Return Values

int

getHtml5Settingstop

Description

Gets HTML5 banner specific settings.

Html5Settings getHtml5Settings()

Return Values

Html5Settings

getIdtop

Description

Gets the ID.

int getId()

Return Values

int

getMappingSettingstop

Description

Returns mapping settings for the banner

MappingSettings getMappingSettings()

Return Values

MappingSettings

getNametop

Description

Gets the banner name.

string getName()

Return Values

string

getNetworktop

Description

Returns the current network id

int getNetwork()

Return Values

int	Network ID

getNetworkIdtop

Description

Gets the network ID.

int getNetworkId()

Return Values

int

getOptiontop

Description

Gets the value of the given option.

string getOption(string $option_name)

Parameters

string

$option_name

Return Values

string

getOptionstop

Description

Gets the banner options.

string getOptions()

Return Values

string

getParentIdtop

Description

Gets ID of the parent object.

int getParentId()

Return Values

int

getParentTypetop

Description

Gets the type of parent object.

string getParentType()

Return Values

string

getPostCodetop

Description

Returns the postCode for this object.
Please refer to our customer wiki for more information about the inheritance logic.

string getPostCode()

Return Values

string

getPotentialContentunitstop

Description

Returns a list of contentunit ids where the banner may run

string getPotentialContentunits()

Return Values

string

getPreCodetop

Description

Returns the preCode for this object.
Please refer to our customer wiki for more information about the inheritance logic.

string getPreCode()

Return Values

string

getPrioritytop

Description

int getPriority()

Return Values

int

getRawdatatop

Description

Gets the raw data of the banner.

string getRawdata()

Return Values

string

getRealTimeBiddingSettingstop

Description

RealTimeBiddingSettings getRealTimeBiddingSettings()

Return Values

RealTimeBiddingSettings

Container with settings for the real time bidding system.

getStartdatetop

Description

Gets the start date.

string getStartdate()

Return Values

string

getTestUrltop

Description

Get the test URL for current banner.

string getTestUrl()

Return Values

string

getTokentop

Description

Gets the session token. Can be used for single-sign-on.

string getToken()

Return Values

string

getTotalFileSizetop

Description

Returns the total size (bytes) of all files in the banner
regardless of their actual usage in the banner code.

int getTotalFileSize()

Return Values

int	The total size (bytes) of all files in the banner.

getTrueCounttop

Description

Gets the status of the truecount feature.

boolean getTrueCount()

Return Values

boolean

Returns TRUE if the feature is enabled, otherwise FALSE.

getTypetop

Description

Gets the type of the banner.

string getType()

Return Values

string

getUnlimitedtop

Description

Returns true if the unlimited flag was set, false otherwise.

boolean getUnlimited()

Return Values

boolean

getUpdatedAttop

Description

Gets the date of when the banner was last updated.

string getUpdatedAt()

Return Values

string

getValidBannerTypestop

Description

Gets all valid banner types for the BannerType setter.

string getValidBannerTypes()

Return Values

string

getValidHtml5FileExtensionstop

Description

Gets the list of supported file extensions for HTML5 banner

StringList getValidHtml5FileExtensions()

Return Values

StringList

getValidOptionstop

Description

Gets the valid options enriched by the type.
Note: Values `preadditionalcode` and `additionalcode` are deprecated since 2019-07-03. Please use the dedicated pre- and postcode methods.

string getValidOptions()

Return Values

string

getValidParentTypestop

Description

Gets a list of all valid parent types.

string getValidParentTypes()

Return Values

string

getValidTagstop

Description

Gets all valid tags for the tagged append file function.

string getValidTags()

Return Values

string

getValidTypestop

Description

Gets all valid CreativeTypes.

string getValidTypes()

Return Values

string

getVendorListForBannertop

Description

Gets the vendor list associated with a banner.

BannerVendorList getVendorListForBanner()

Return Values

BannerVendorList

getWeighttop

Description

Gets the campaign banner weight.

int getWeight()

Return Values

int

getWidthtop

Description

Gets the width of the banner.

int getWidth()

Return Values

int

hasClickWordtop

Description

Determines whether a ClickWord exists

boolean hasClickWord(string $click_tag)

Parameters

string

$click_tag

Return Values

boolean

hasMappingSettingstop

Description

boolean hasMappingSettings()

Return Values

boolean

hasPostCodetop

Description

Checks, whether postCode for this object is set or not.
Please refer to our customer wiki for more information about the inheritance logic.

boolean hasPostCode()

Return Values

boolean

hasPreCodetop

Description

Checks, whether preCode for this object is set or not.
Please refer to our customer wiki for more information about the inheritance logic.

boolean hasPreCode()

Return Values

boolean

hasRealTimeBiddingSettingstop

Description

boolean hasRealTimeBiddingSettings()

Return Values

boolean

hasTcfFlagSettop

Deprecated 2023-03-01

This method will be removed in upcoming releases.

This method is only in use during the TCF grace period and will be removed within 3 months of release.

Description

Returns false if tcf compliant flag is not set (set to null)

boolean hasTcfFlagSet()

Return Values

boolean

isBehaviourTargetingRelevanttop

Description

Determines whether the banner is behaviour-targeting relevant (gets the OBA-flag)

boolean isBehaviourTargetingRelevant()

Return Values

boolean

isForcePostCodeInheritanceEnabledtop

Description

If flag is set, its not necessary to include %campaign% placeholder.
Campaign code will be prepended to the banner post code.

boolean isForcePostCodeInheritanceEnabled()

Return Values

boolean

isForcePreCodeInheritanceEnabledtop

Description

If flag is set, its not necessary to include %campaign% placeholder.
Campaign code will be prepended to the banner pre code.

boolean isForcePreCodeInheritanceEnabled()

Return Values

boolean

isTcfComplianttop

Description

Gets the TCF Compliance Flag for the banner.

boolean isTcfCompliant()

Return Values

boolean

loadtop

Description

Load a single banner by ID

boolean load(int $id)

Parameters

int

$id

Return Values

boolean

True on success, otherwise false

logintop

Description

Initializes a new session with given information

boolean login(string $user, string $pass, int $network)

Parameters

string	$user	Username
string	$pass	Password
int	$network	$network Network ID

Return Values

boolean

true on success, false on fail

loginSmartPhonetop

Deprecated 2014-12-22

This method will be removed in upcoming releases.

Was only useful for the mobile app, which is not supported anymore.

Description

boolean loginSmartPhone(string $user, string $pass, int $network, string $client)

Parameters

string	$user	Username
string	$pass	Password
int	$network	$network Network ID
string	$client	Client token e.g. "apn" token of iPhone

Return Values

boolean

TRUE on success, FALSE on fail

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean

true on success, false on fail

parseClickTagFromFlashtop

Description

Parses the flashfile for a Clicktag, works only on Flash Banners

string parseClickTagFromFlash()

Return Values

string

Array containing the clickTag found by the parser

removetop

Description

Remove banner with $banner_id

boolean remove()

Return Values

boolean

removeByIdtop

Description

Removes a BannerModel with the given id

boolean removeById(int $id)

Parameters

int

$id

ID of object to remove.

Return Values

boolean

removeClickWordtop

Description

Removes a ClickWord from the Banner

boolean removeClickWord(string $click_tag)

Parameters

string

$click_tag

Return Values

boolean

removeFiletop

Description

Removes an uploaded file by the given name.

boolean removeFile(string $name)

Parameters

string

$name

Return Values

boolean

removeOptiontop

Description

Removes an specific entry from the set options.

boolean removeOption(string $name)

Parameters

string

$name

Return Values

boolean

removePostCodetop

Description

Removes the postCode on this object. Has a direct impact on the banner preCode.
Please refer to our customer wiki for more information about the inheritance logic.

boolean removePostCode()

Return Values

boolean

True on success, otherwise false

removePreCodetop

Description

Removes the preCode on this object. Has a direct impact on the banner preCode.
Please refer to our customer wiki for more information about the inheritance logic.

boolean removePreCode()

Return Values

boolean

True on success, otherwise false

savetop

Description

Persists current object state

boolean save()

Return Values

boolean

setActivetop

Description

Activates the banner, if true is passed. Otherwise it will be disabled.

boolean setActive(boolean $active)

Parameters

boolean

$active

Return Values

boolean

setAltTagtop

Description

Sets the alt tag for the banner.

boolean setAltTag(string $alt_tag)

Parameters

string

$alt_tag

Return Values

boolean

setAltUrltop

Description

Sets the alt URL for the banner.

boolean setAltUrl(string $alt_url)

Parameters

string

$alt_url

Return Values

boolean

setBannerTypetop

Description

Sets the banner type for the banner.

boolean setBannerType(string $banner_type)

Parameters

string

$banner_type

Return Values

boolean

setBehaviourTargetingRelevanttop

Description

Marks/unmarks the banner as behaviour-targeting relevant (sets the OBA-flag)

boolean setBehaviourTargetingRelevant(boolean $value)

Parameters

boolean

$value

Return Values

boolean

setClickUrltop

Description

Sets the click URL for the banner.

boolean setClickUrl(string $click_url)

Parameters

string

$click_url

Return Values

boolean

setDbtSettingstop

Description

Sets DBT/shop relevant settings.
Applies only to "dbt" type banners.

boolean setDbtSettings(DbtSettings $settings)

Parameters

DbtSettings

$settings

Return Values

boolean

True if no error occurred

setEnddatetop

Description

Sets the date of expiration.

boolean setEnddate(string $enddate)

Parameters

string

$enddate

Return Values

boolean

setExternalIdtop

Description

Sets the external id

boolean setExternalId(string $external_id)

Parameters

string

$external_id

Return Values

boolean

setFlashParametersComplexTypetop

Description

Sets flash parameters

boolean setFlashParametersComplexType(FlashParameters $flash_parameters)

Parameters

FlashParameters

$flash_parameters

Return Values

boolean

setForcePostCodeInheritancetop

Description

Force post code to inherit the code from the parent campaign.
If this flag is set, its not necessary to include %campaign% placeholder.
Campaign code will be prepended to the banner post code.

boolean setForcePostCodeInheritance(boolean $force)

Parameters

boolean

$force

Return Values

boolean

setForcePreCodeInheritancetop

Description

Force pre code to inherit the code from the parent campaign.
If this flag is set, its not necessary to include %campaign% placeholder.
Campaign code will be prepended to the banner pre code.

boolean setForcePreCodeInheritance(boolean $force)

Parameters

boolean

$force

Return Values

boolean

setHeighttop

Description

Sets the height for current banner in pixels.

boolean setHeight(int $height)

Parameters

int

$height

Return Values

boolean

setHtml5Settingstop

Description

Sets HTML5 banner specific settings.

boolean setHtml5Settings(Html5Settings $html5_settings_complex_type)

Parameters

Html5Settings

$html5_settings_complex_type

HTML5 banner specific settings.

Return Values

boolean

True on success, otherwise false

setMappingSettingstop

Description

Sets mapping settings for the banner.

boolean setMappingSettings(MappingSettings $settings)

Parameters

MappingSettings

$settings

Return Values

boolean

True if no error occurred

setNametop

Description

Sets the name for the current banner.

boolean setName(string $name)

Parameters

string

$name

Return Values

boolean

setOptiontop

Description

Sets a value for a specific banner option.

boolean setOption(string $name, string $value)

Parameters

string	$name
string	$value

Return Values

boolean

setParentIdtop

Description

Sets the ID of the parent object.

The parent ID can only be set once!

boolean setParentId(int $parent_id)

Parameters

int

$parent_id

Return Values

boolean

setParentTypetop

Description

Sets type of the parent object.

The parent Type can only be set once!

boolean setParentType(string $parent_type)

Parameters

string

$parent_type

Return Values

boolean

setPostCodetop

Description

Sets the postCode for this object. Has a direct impact on the banner preCode.
Please refer to our customer wiki for more information about the inheritance logic.

boolean setPostCode(string $code)

Parameters

string

$code

PostCode, Maximum length is: 64000 characters

Return Values

boolean

setPreCodetop

Description

Sets the preCode for this object. Has a direct impact on the banner preCode.
Please refer to our customer wiki for more information about the inheritance logic.

boolean setPreCode(string $code)

Parameters

string

$code

PreCode, Maximum length is: 64000 characters

Return Values

boolean

setPrioritytop

Description

Sets the priority that determines the evaluation order of campaign banners.
If two banners have the same priority, they will deliver according to weight.
Default: 1

Required network feature activation: campaign banner priority

boolean setPriority(int $priority)

Parameters

int

$priority

Return Values

boolean

True on success, otherwise false

setRawdatatop

Description

Sets the raw data for the banner.

boolean setRawdata(string $rawdata)

Parameters

string

$rawdata

Return Values

boolean

setRealTimeBiddingSettingstop

Description

boolean setRealTimeBiddingSettings(RealTimeBiddingSettings $rtb_settings)

Parameters

RealTimeBiddingSettings

$rtb_settings

Return Values

boolean

True if no error occurred.

setStartdatetop

Description

Sets a start date for the current banner.

boolean setStartdate(string $startdate)

Parameters

string

$startdate

Return Values

boolean

setTcfComplianttop

Description

Sets the tcf compliance state for the banner. Mandatory.

boolean setTcfCompliant(boolean $tcf_compliant)

Parameters

boolean

$tcf_compliant

A boolean value

Return Values

boolean

setTrueCounttop

Description

Enables the truecount feature.
If truecount is enabled, you need to use the "%truecount%" placeholder.
You may add the placeholder within the "additonal code".

boolean setTrueCount(boolean $toggle)

Parameters

boolean

$toggle

TRUE to enable, FALSE to disable

Return Values

boolean

setTypetop

Description

Sets a type for the current banner.

boolean setType(string $type)

Parameters

string

$type

Return Values

boolean

setUnlimitedtop

Description

Sets the runtime of the current banner to unlimited.

boolean setUnlimited(boolean $unlimited)

Parameters

boolean

$unlimited

Return Values

boolean

setWeighttop

Description

Sets the banner weight. This will only affect campaign banners.

boolean setWeight(int $weight)

Parameters

int

$weight

Return Values

boolean

setWidthtop

Description

Sets the width for the current banner in pixels.

boolean setWidth(int $width)

Parameters

int

$width

In pixels

Return Values

boolean

uploadHtml5ZipArchivetop

Description

Uploads a zip archive containing HTML5 assets.
Replaces all existing files of the current banner.
Only applicable to HTML5 banners.
The following changes are automatically applied to the zip archive:
- Empty directories are removed.
- Special files/directories commonly archived by accident are removed (for example: __MACOSX, Thumbs.db).
- Top level directory is removed and subdirectories are moved up one level (covers the common case
of archives containing a directory named after the archive itself).
See Banner::getValidHtml5FileExtensions() for a list of valid file extensions.

int uploadHtml5ZipArchive(string $file_content)

Parameters

string

$file_content

The base64 encoded zip file.

Return Values

int	The total file size after zip extraction in bytes or 0 in case of errors.

validatetop

Description

Validates the object and returns an error stack.

string validate()

Return Values

string

validateRuntimetop

Description

Validates the banner runtime. This depends on the campaign runtime.

string validateRuntime()

Return Values

string

ErrorMessages

BannerVendortop

Definition

object BannerVendor {

- string $foundIn

required

- int $id

required

- string $name

required

}

BannerVendorListtop

Definition

object BannerVendorList {

- Array <BannerVendor> $vendors

optional

}

DbtSettingstop

Definition

Dynamic Ads (DBT) specific banner settings.

object DbtSettings {

- int $shopId

required

- string $combinedRuleId

required

- string $redirectUrl

optional

Optional redirect URL which tracks clicks and redirects to the appended target URL.

Set to NULL if no redirect URL is used.

- boolean $deeplinkEncoded

optional

Whether to URL encode deeplink URL (and the optional deeplink URL parameters)
before appending it to the URL defined by parameter "redirectUrl"

Only used in conjunction with parameter "redirectUrl". Must be set to NULL otherwise.

- string $deeplinkUrlParams

optional

Optional parameters that are appended to the deeplink.

Set to NULL if no deeplink URL parameters are used

}

FlashParametertop

Definition

object FlashParameter {

- string $name

required

- string $value

required

}

FlashParameterstop

Definition

object FlashParameters {

- Array <FlashParameter> $flash_parameters

optional

}

Html5Parametertop

Definition

object Html5Parameter {

- string $name

required

- string $value

required

}

Html5Settingstop

Definition

HTML5 banner specific settings.

object Html5Settings {

- string $indexPath

required

The index file relative to the root directory of the provided HTML5 zip archive after considering
the automatically applied changes to the archive mentioned in Banner::uploadHtml5ZipArchive().

- Array <Html5Parameter> $parameters

optional

}

MappingSettingstop

Definition

Maps the Banner with 3rd party service providers using identifiers. Currently, only adGap is supported.

object MappingSettings {

- string $adGapId

optional

}

RealTimeBiddingSettingstop

Definition

object RealTimeBiddingSettings {

- string $landingPage

required

}

StringListtop

Definition

object StringList {

- Array <string> $strings

optional

The strings

}