ContentunitFilter WSDL
A ContentunitFilter modelThis service is stateful.
Examples +
- create
- create
- edit single
- edit single
- edit multiple
- edit multiple
- delete
- delete
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 ContentunitFilter
int add()
Return Values
| int | The ID of the ContentunitFilter (unique) |
addContentunittop
Description
Add a Contentunit to this filter.
boolean addContentunit(int $contentunit_id)
Parameters
| int | $contentunit_id |
Return Values
| boolean |
addContentunitWithWeighttop
Description
Add a Contentunit with the corresponding weight - entry.
If the Network permits contentunit weight - entries the weight and contentunit will be add to the filter
boolean addContentunitWithWeight(int $contentunit_id, int $weight)
Parameters
| int | $contentunit_id | |
| int | $weight |
Return Values
| boolean |
addContentunitstop
Description
Adds multiple contentunits to the ContentunitFilter
boolean addContentunits(string $contentunits)
Parameters
| string | $contentunits | Array of Contentunits |
Return Values
| boolean |
addExclusiveContentunittop
Description
Add a single Contentunit for exclusive placement
if false the Contentunit couldn´t be placed exclusive
or the parent element is not a valid campaign.
boolean addExclusiveContentunit(int $contentunit)
Parameters
| int | $contentunit |
Return Values
| boolean |
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 |
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 ContentunitFilter
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getAllContentunitstop
Description
Get all Contentunits for this Filter.
string getAllContentunits()
Return Values
| string |
getDescriptiontop
Description
Get filter description
Applies to inventoried and sub-filters
string getDescription()
Return Values
| string |
getExclusivetop
Description
Get exclusive flag.
boolean getExclusive()
Return Values
| boolean |
getExclusiveContentunitstop
Description
All contentunits which area
string getExclusiveContentunits()
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 |
getInvalidContentunitIdstop
Description
Gets a list of invalid contentunit assigned to the filter
string getInvalidContentunitIds()
Return Values
| string |
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 |
getSummarytop
Description
Get a textual summary for a loaded Filter
string getSummary()
Return Values
| string |
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 |
getWeightForContentunittop
Description
Get a single weight for a contentunitId. If there is no weight - entry the function will return -1
int getWeightForContentunit(int $contentunit_id)
Parameters
| int | $contentunit_id |
Return Values
| int |
getWeightsIndexedByContentunitIdstop
Description
Returns an array of weight-entries indexed by contentunitId in the array[contentunitid] = weight format
string getWeightsIndexedByContentunitIds()
Return Values
| string |
guessPlacementForBannertop
Description
Guesses placemets passed banner
string guessPlacementForBanner()
Return Values
| string |
guessPlacementForCampaigntop
Description
Guesses placemets passed campaign
string guessPlacementForCampaign()
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 |
isInvertedtop
Description
Alias for getInverted
boolean isInverted()
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 contentunit filter by its ID
boolean load(int $id)
Parameters
| int | $id |
Return Values
| boolean | True on success, otherwise false |
loadFilterByParenttop
Description
Load all filters for a specific parent
placementfilter ar unique for every given parent so the function will return an exception if more than one filter exists
int loadFilterByParent(int $parent_id, string $parent_type)
Parameters
| int | $parent_id | |
| string | $parent_type | $parentType Type of parent. |
Return Values
| int |
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 |
removeByIdtop
Description
Removes a ContentunitFilterFilterModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
removeContentunittop
Description
Remove a certain Contentunit from Filter
boolean removeContentunit(int $contentunit_id)
Parameters
| int | $contentunit_id |
Return Values
| boolean |
removeContentunitstop
Description
Adds multiple contentunits from the ContentunitFilter
boolean removeContentunits(string $contentunits)
Parameters
| string | $contentunits | Array of Contentunits |
Return Values
| boolean |
removeExclusiveContentunittop
Description
Remove a exclusively placed Contentunit from the ContentunitFilter.
boolean removeExclusiveContentunit(int $contentunit_id)
Parameters
| int | $contentunit_id |
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 |
removeWeightForContentunittop
Description
Remove the weight-entry for a given contentunit.
Returns true even if the given contentunit did not have a weight-entry.
boolean removeWeightForContentunit(int $contentunit_id)
Parameters
| int | $contentunit_id |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setContentunitstop
Description
Sets the given Contentunit Array (the Array overrides the original state).
if you want to add units to an existing set, use the addContentunits() function.
boolean setContentunits(string $contentunits)
Parameters
| string | $contentunits | Array of Contentunits |
Return Values
| boolean |
setDescriptiontop
Description
Set filter description
Applies to inventoried and sub-filters
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean |
setExclusivetop
Description
Add the exclusive flag to the filter (only this campaign runs on this advertising space).
boolean setExclusive(boolean $exclusive)
Parameters
| boolean | $exclusive |
Return Values
| boolean |
setExclusiveContentunitstop
Description
Add multiple Contentunits as exclusive item.
boolean setExclusiveContentunits(string $contentunits)
Parameters
| string | $contentunits |
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 |
setInvertedtop
Description
Inverts the current Filter.
boolean setInverted(boolean $inverted)
Parameters
| boolean | $inverted |
Return Values
| boolean |
setNametop
Description
Set filter name
Applies to inventoried and sub-filters
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setVisibletop
Description
Set visibility
Applies to inventoried and sub-filters
boolean setVisible(boolean $visible)
Parameters
| boolean | $visible |
Return Values
| boolean |
setWeightForContentunittop
Description
Sets a weight-entry for a given contentunit.
Returns false when the contentunit is not in the placement.
boolean setWeightForContentunit(int $contentunit_id, int $weight)
Parameters
| int | $contentunit_id | |
| int | $weight |
Return Values
| boolean |
setWeightsIndexedByContentunitIdstop
Description
Sets weight-entries from the given array in the array[contentunitid] = weight format.
Replaces ALL previous weight-entries.
Returns false if one or more contentunits are not currently present in the filter.
boolean setWeightsIndexedByContentunitIds(string $weight_array)
Parameters
| string | $weight_array |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |