BannerOptimization Types

BannerOptimization WSDL

Optimizes Banners of a Campaign in relation to the Banners Views/Clicks
This service is stateful.

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 BannerOptimization

int add()

Return Values

int The ID of the BannerOptimization (unique)

addDayToRundaystop

Description

Adds a day to the rundays
(on which days will the cronjob be executed (1=monday, .., 7=sunday))

boolean addDayToRundays(int $week_day)

Parameters

int $week_day

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

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 BannerOptimization

boolean edit()

Return Values

boolean TRUE on succes, FALSE on fail

excludeBannertop

Description

Exclude a banner

boolean excludeBanner(int $banner_id)

Parameters

int $banner_id

Return Values

boolean always true

getActivetop

Description

Gets active

int getActive()

Return Values

int active (0 or 1)

getCampaigntop

Description

Returns Campaign Object

int getCampaign()

Return Values

int

getCampaignIdtop

Description

Returns campaignId

int getCampaignId()

Return Values

int campaignId

getExcludedbannerstop

Description

Gets the excludedBanner Array

string getExcludedbanners()

Return Values

string excludedcontentunits

getHistorytop

Description

Gets the HistoryObjects for the Optimization

string getHistory()

Return Values

string

getIdtop

Description

Returns the type of the current optimization

int getId()

Return Values

int id

getImpressionThresholdtop

Description

Returns the impressionThreshold

int getImpressionThreshold()

Return Values

int $impressionThreshold

getLastRuntop

Description

Gets the lastRun Date

string getLastRun()

Return Values

string lastRun

getMaxchangetop

Description

Returns maxChange

float getMaxchange()

Return Values

float $maxChange

getMinClickratetop

Description

Gets the min clickrate

float getMinClickrate()

Return Values

float minClickrate

getNetworktop

Description

Returns the current network id

int getNetwork()

Return Values

int Network ID

getNetworkIdtop

Description

Returns networkId

int getNetworkId()

Return Values

int networkId

getPerioddaystop

Description

Returns the periodDays

int getPerioddays()

Return Values

int periodDays

getRundaystop

Description

The rundays for the current optimization

string getRundays()

Return Values

string rundays

getStartaftertop

Description

Gets the start after

int getStartafter()

Return Values

int startAfter

getStartdatetop

Description

Gets the startDate

string getStartdate()

Return Values

string startDate

getTokentop

Description

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

string getToken()

Return Values

string

getTypetop

Description

Gets the optimization type

string getType()

Return Values

string

loadtop

Description

Loads object 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

Login method

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

removetop

Description

Removes current object

boolean remove()

Return Values

boolean

removeByIdtop

Description

Removes a BannerOptimizationModel with the given id

boolean removeById(int $id)

Parameters

int $id ID of object to remove.

Return Values

boolean

removeDayFromRundaystop

Description

Remove day from the rundays

boolean removeDayFromRundays(int $week_day)

Parameters

int $week_day

Return Values

boolean

savetop

Description

Persists current object state

boolean save()

Return Values

boolean True on success, otherwise false

setActivetop

Description

Sets active flag -> (0 or 1)

boolean setActive(int $active)

Parameters

int $active

Return Values

boolean true

setCampaigntop

Description

Sets the campaign

boolean setCampaign(int $campaign)

Parameters

int $campaign

Return Values

boolean true

setCampaignByIdtop

Description

Sets the campaign

boolean setCampaignById(int $campaign_id)

Parameters

int $campaign_id

Return Values

boolean true

setCampaignIdtop

Description

Sets the campaign

boolean setCampaignId(int $campaign_id)

Parameters

int $campaign_id

Return Values

boolean true

setImpressionThresholdtop

Description

Sets the impressionThreshold

boolean setImpressionThreshold(int $threshold)

Parameters

int $threshold

Return Values

boolean

setLastRuntop

Description

Sets the $lastRun Date for the optimation cronjob

boolean setLastRun(string $last_run)

Parameters

string $last_run

Return Values

boolean

setMaxchangetop

Description

Sets maxChange

boolean setMaxchange(float $max_change)

Parameters

float $max_change

Return Values

boolean

setMinClickratetop

Description

Sets the min clickrate

boolean setMinClickrate(float $min_clickrate)

Parameters

float $min_clickrate

Return Values

boolean

setPerioddaystop

Description

Sets the turnus for x days after first date of optimization

boolean setPerioddays(int $period_days)

Parameters

int $period_days

Return Values

boolean

setStartaftertop

Description

Sets the start after

boolean setStartafter(int $start_after)

Parameters

int $start_after

Return Values

boolean

setStartdatetop

Description

Sets the startDate for the optimation cronjob

boolean setStartdate(string $start_date)

Parameters

string $start_date

Return Values

boolean

unexcludeBannertop

Description

Unexclude a banner

boolean unexcludeBanner(int $banner_id)

Parameters

int $banner_id

Return Values

boolean always true

validatetop

Description

Validates the object and returns an error stack.

string validate()

Return Values

string

Console