CampaignOptimization WSDL
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 CampaignOptimization
int add()
Return Values
| int | The ID of the CampaignOptimization (unique) |
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 CampaignOptimization
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getCampaignIdtop
Description
Gets campaignId
int getCampaignId()
Return Values
| int | campaignId |
getCostSelecttop
Description
Returns the costSelect
string getCostSelect()
Return Values
| string | $costSelect |
getEcpmtop
Description
Returns ecpm true/false
boolean getEcpm()
Return Values
| boolean | $ecpm |
getIdtop
Description
Gets campaign optimization id
int getId()
Return Values
| int | campaignId |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Gets networkId
int getNetworkId()
Return Values
| int | networkId |
getPrioritytop
Description
Returns the priority
int getPriority()
Return Values
| int | $priority |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
loadtop
Description
Load the optimization for the given 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
Remove a campaignoptimization
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a CampaignOptimizationModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setCampaignIdtop
Description
Sets campaign_id
boolean setCampaignId(int $campaign_id)
Parameters
| int | $campaign_id |
Return Values
| boolean |
setCostSelecttop
Description
Sets the costSelect (e.g. campaign, contentunit)
boolean setCostSelect(string $cost_select)
Parameters
| string | $cost_select |
Return Values
| boolean |
setEcpmtop
Description
Sets ecpm as boolean
boolean setEcpm(int $ecpm)
Parameters
| int | $ecpm |
Return Values
| boolean |
setPrioritytop
Description
Sets the priority
boolean setPriority(int $priority)
Parameters
| int | $priority |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |