FrequencyCappingFilter WSDL
A FrequencyCappingFilter modelThis 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 FrequencyCappingFilter
int add()
Return Values
| int | The ID of the FrequencyCappingFilter (unique) |
addFilterClusterGrouptop
Description
Add to filter cluster group
boolean addFilterClusterGroup(int $filter_cluster_group)
Parameters
| int | $filter_cluster_group |
Return Values
| boolean |
addParenttop
Description
Add a parent
boolean addParent(string $parent_type, int $parent_id)
Parameters
| string | $parent_type | $parentType |
| int | $parent_id |
Return Values
| boolean |
addProviderIdtop
Description
boolean addProviderId(int $provider_id)
Parameters
| int | $provider_id |
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 FrequencyCappingFilter
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getDescriptiontop
Description
Get filter description
Applies to inventoried and sub-filters
string getDescription()
Return Values
| string |
getFilterClusterGroupIdstop
Description
Get filter cluster group ids
string getFilterClusterGroupIds()
Return Values
| string |
getIdtop
Description
Get id
int getId()
Return Values
| int | $id |
getNametop
Description
Get filter name
Applies to inventoried and sub-filters
string getName()
Return Values
| string |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getParentstop
Description
Gets the filter parents
For multiple parents:
{
"campaign" : [1, 2, .., N],
"banner" : [1, 2, .., N]
}
For no parents:
{
"<orphan>" : [0]
}
For single filter parent (current filter must be a sub-filter):
{
"<filter>" : [N]
}
string getParents()
Return Values
| string |
getPeriodtop
Description
Get period for the limit (e.g. hourly, daily, weeky, monthly)
string getPeriod()
Return Values
| string |
getProviderIdstop
Description
string getProviderIds()
Return Values
| string |
getRequeststop
Description
Gets the request limit
int getRequests()
Return Values
| int |
getSummarytop
Description
Get a textual summary for a loaded Filter
string getSummary()
Return Values
| string |
getTimetop
Description
Returns the time in seconds
int getTime()
Return Values
| int |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTypetop
Description
Get type
string getType()
Return Values
| string | $type |
getValidParentTypestop
Description
Get list of valid parent types
string getValidParentTypes()
Return Values
| string |
hasMultipleParentstop
Description
Determines, whether the filter has multiple parents
boolean hasMultipleParents()
Return Values
| boolean |
hasParentstop
Description
Determines, whether the filter has parents
boolean hasParents()
Return Values
| boolean |
isInventoriedtop
Description
Determines, whether the filter is inventoried.
boolean isInventoried()
Return Values
| boolean |
isSubFiltertop
Description
Determines, whether the filter is a sub-filter, a non-inventoried filter
which may be referenced in another filter specified by his parent
boolean isSubFilter()
Return Values
| boolean |
isVisibletop
Description
Determines, whether the filter is visible
and can be therefore assigned to other objects,
i.e. referenced in the code of a TagFilter.
boolean isVisible()
Return Values
| boolean |
loadtop
Description
Load a filter by its ID
boolean load(int $id)
Parameters
| int | $id | The id of the filter to load |
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 filter
boolean remove()
Return Values
| boolean | True on success, otherwise false |
removeByIdtop
Description
Removes a FrequencyCappingFilterFilterModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
removeFilterClusterGrouptop
Description
Remove from filter cluster group
boolean removeFilterClusterGroup(int $filter_cluster_group)
Parameters
| int | $filter_cluster_group |
Return Values
| boolean |
removeParenttop
Description
Remove a parent
boolean removeParent(string $parent_type, int $parent_id)
Parameters
| string | $parent_type | $parentType |
| int | $parent_id |
Return Values
| boolean |
removeProviderIdtop
Description
boolean removeProviderId(int $provider_id)
Parameters
| int | $provider_id |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setDescriptiontop
Description
Set filter description
Applies to inventoried and sub-filters
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean |
setInventoriedtop
Description
Set the inventoried flag.
If true, the filter will be available in the network-wide inventory under an unique name.
Once a filter has been inventoried and saved, the inventoried flag cannot be changed.
boolean setInventoried(boolean $inventoried)
Parameters
| boolean | $inventoried |
Return Values
| boolean |
setNametop
Description
Set filter name
Applies to inventoried and sub-filters
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setRequestCappingtop
Description
Set a request / frequency capping for a campaign
boolean setRequestCapping(int $request, int $time)
Parameters
| int | $request | Amount of requests per user in $time |
| int | $time | In seconds |
Return Values
| boolean |
setVisibletop
Description
Set visibility
Applies to inventoried and sub-filters
boolean setVisible(boolean $visible)
Parameters
| boolean | $visible |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |