Contentunit Types

Contentunit WSDL

A contentunit model
This service is stateful.

Examples +

  • tagging
  • tagging
.

    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 Contentunit

    int add()

    Return Values

    int The ID of the Contentunit (unique)

    addChanneltop

    Description

    Add a channel to this contentunit

    boolean addChannel(int $channel)

    Parameters

    int $channel The channel to add

    Return Values

    boolean

    addDefaultContentunitCoststop

    Description

    Add a default Cost for the Contentunit

    boolean addDefaultContentunitCosts(string $costtype, string $incomes_or_costs, double $value)

    Parameters

    string $costtype
    string $incomes_or_costs
    double $value

    Return Values

    boolean

    addLearningTagAttributetop

    Description

    Only internal attributes are allowed to be added to existing contentunits.

    boolean addLearningTagAttribute(string $name, string $value)

    Parameters

    string $name
    string $value

    Return Values

    boolean True on success, otherwise false

    assignTaggingPeculiaritytop

    Description

    Assign a tagging peculiarity to the contentunit

    boolean assignTaggingPeculiarity(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    buildLearningTagContentunittop

    Description

    Replaces the service state with a new, unsaved contentunit with default values applied from the configuration.
    Further changes can be still made before saving the contentunit.

    Requires admin rights.

    boolean buildLearningTagContentunit(LearningTagContentunitBuilderConfiguration $configuration)

    Parameters

    LearningTagContentunitBuilderConfiguration $configuration

    Return Values

    boolean True on success, otherwise false

    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 Contentunit

    boolean edit()

    Return Values

    boolean TRUE on succes, FALSE on fail

    editDefaultContentunitCoststop

    Description

    Edit default the contentunitcosts

    boolean editDefaultContentunitCosts(string $costtype, string $incomes_or_costs, double $value)

    Parameters

    string $costtype
    string $incomes_or_costs
    double $value

    Return Values

    boolean

    enableTcfParameterstop

    Description

    Enables TCF(GDPR) parameters for subsequent requests.

    boolean enableTcfParameters()

    Return Values

    boolean True on success, otherwise false

    findIdsByChannelIdtop

    Description

    Returns an IntegerList of ids of contentunits that belongs to the given channel.

    IntegerList findIdsByChannelId(int $channel_id)

    Parameters

    int $channel_id

    Return Values

    IntegerList containing the ids of contentunits

    getAllowedCodeTypestop

    Description

    Get a list of valid code types

    string getAllowedCodeTypes()

    Return Values

    string

    getAllowedTagTypestop

    Description

    Get a list of valid tag types

    string getAllowedTagTypes()

    Return Values

    string

    getAllowedTypestop

    Description

    Get a list of valid types

    string getAllowedTypes()

    Return Values

    string

    getAssignedTaggingPeculiaritiestop

    Description

    Gets the assigned tagging peculiarities

    string getAssignedTaggingPeculiarities()

    Return Values

    string

    getCapacityByTimetop

    Description

    Get the capacity of a contentunit in the given time range if the ContentUnit is not available 0 is returned

    int getCapacityByTime(string $startdate, string $enddate)

    Parameters

    string $startdate
    string $enddate

    Return Values

    int

    getChannelstop

    Description

    Get the channels of this contentunit

    string getChannels()

    Return Values

    string

    getClickstop

    Description

    Get the number of clicks in the given time range

    int getClicks(string $start, string $end)

    Parameters

    string $start For an unlimited clickval set $start and $end to null
    string $end For an unlimited clickval set $start and $end to null

    Return Values

    int

    getCodeTypetop

    Description

    Get the codetype of the contentunit

    string getCodeType()

    Return Values

    string

    getContentunitcoststop

    Description

    Contentunit cost entry

    string getContentunitcosts()

    Return Values

    string

    getContentunitgroupIdtop

    Description

    Get the contentunitgroupId of the contentunit

    int getContentunitgroupId()

    Return Values

    int

    getDefaultContentUnitCoststop

    Description

    Contentunit cost entry

    string getDefaultContentUnitCosts(string $costtype, string $incomes_or_costs)

    Parameters

    string $costtype
    string $incomes_or_costs

    Return Values

    string

    getEffectiveTaggingPeculiaritiestop

    Description

    Gets the effective assigned tagging peculiarities (active, also inherited)

    string getEffectiveTaggingPeculiarities()

    Return Values

    string

    getExclusiveCampaignstop

    Description

    Returns all exclusive campaigns of contentunit






    Returns the first websitefilter id associated with this contentunit's website if the contentunit has no filter assigned to itself.
    Returns NULL otherwise.

    string getExclusiveCampaigns()

    Return Values

    string

    getExternalIdtop

    Description

    Get the externalId of the contentunit

    string getExternalId()

    Return Values

    string

    getHeighttop

    Description

    Get the height of the contentunit

    int getHeight()

    Return Values

    int

    getIdtop

    Description

    Get the id of the contentunit

    int getId()

    Return Values

    int

    getLearningTagAttributestop

    Description



    LearningTagAttributeList getLearningTagAttributes()

    Return Values

    LearningTagAttributeList

    getNametop

    Description

    Get the name of the contentunit

    string getName()

    Return Values

    string

    getNetworktop

    Description

    Returns the current network id

    int getNetwork()

    Return Values

    int Network ID

    getNetworkIdtop

    Description

    Returns the network id of the contentunit

    int getNetworkId()

    Return Values

    int

    getTagTypetop

    Description

    Get the tagtype of the contentunit

    string getTagType()

    Return Values

    string

    getTimerangeReporttop

    Description

    Get the quickreport for a specifed time range

    string getTimerangeReport(string $start, string $end)

    Parameters

    string $start
    string $end

    Return Values

    string

    getToHeighttop

    Description

    Get the maximum height of the contentunit

    int getToHeight()

    Return Values

    int

    getToWidthtop

    Description

    Get the maximum width of the contentunit

    int getToWidth()

    Return Values

    int

    getTokentop

    Description

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

    string getToken()

    Return Values

    string

    getTypetop

    Description

    Get the type of the contentunit

    string getType()

    Return Values

    string

    getUpdatedAttop

    Description

    Get the updated at datetime

    string getUpdatedAt()

    Return Values

    string

    getViewstop

    Description

    Get the number of views in the given time range

    int getViews(string $start, string $end)

    Parameters

    string $start For an unlimited viewval set $start and $end to null
    string $end For an unlimited viewval set $start and $end to null

    Return Values

    int

    getWebsiteIdtop

    Description

    Get the websiteId of the contentunit

    int getWebsiteId()

    Return Values

    int

    getWebsiteTagtop

    Description

    Return the websitetag code for a contentunit

    string getWebsiteTag()

    Return Values

    string

    getWidthtop

    Description

    Get the width of the contentunit

    int getWidth()

    Return Values

    int

    hasChanneltop

    Description

    Check if a channel is assigned to this contentunit

    boolean hasChannel(int $channel)

    Parameters

    int $channel The channel to check

    Return Values

    boolean

    hasTaggingBlockertop

    Description

    Determines whether the contentunit has a tagging blocker

    boolean hasTaggingBlocker()

    Return Values

    boolean

    isActivetop

    Description

    Return the active flag of the contentunit

    boolean isActive()

    Return Values

    boolean

    isRontop

    Description

    Return the ron flag of the contentunit

    boolean isRon()

    Return Values

    boolean

    isSsltop

    Description

    Return the ssl flag of the contentunit

    boolean isSsl()

    Return Values

    boolean

    isTaggingPecuiliarityAssignedtop

    Description

    Determines whether the given tagging peculiarity is assigned to the contentunit

    boolean isTaggingPecuiliarityAssigned(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    loadtop

    Description

    Load a contentunit

    boolean load(int $id)

    Parameters

    int $id The contentunit id 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

    Delete the contentunit and remove contentunitfilter

    boolean remove()

    Return Values

    boolean true on success

    removeByIdtop

    Description

    Removes a ContentunitModel with the given id

    boolean removeById(int $id)

    Parameters

    int $id ID of object to remove.

    Return Values

    boolean

    removeChanneltop

    Description

    Remove a channel from this contentunit

    boolean removeChannel(int $channel)

    Parameters

    int $channel The channel to remove

    Return Values

    boolean

    removeDefaultContentUnitCoststop

    Description

    Remove a contentunit cost entry

    boolean removeDefaultContentUnitCosts(string $costtype, string $incomes_or_costs)

    Parameters

    string $costtype
    string $incomes_or_costs

    Return Values

    boolean

    removeLearningTagAttributetop

    Description

    Only internal attributes are allowed to be removed from existing contentunits.

    boolean removeLearningTagAttribute(string $name, string $value)

    Parameters

    string $name
    string $value

    Return Values

    boolean True on success, otherwise false

    savetop

    Description

    Persists current object state

    boolean save()

    Return Values

    boolean

    setActivetop

    Description

    Activate or deactivate the contentunit

    boolean setActive(boolean $active)

    Parameters

    boolean $active The new active flag

    Return Values

    boolean true on success, false on error

    setCodeTypetop

    Description

    Set the codetype of the contentunit


    The value can be on of ['javascript', 'iframe'].

    boolean setCodeType(string $code_type)

    Parameters

    string $code_type The codetype for this contentunit

    Return Values

    boolean true on success, false on error

    setContentunitgroupIdtop

    Description

    Set the contentunitgroupId of the contentunit

    boolean setContentunitgroupId(int $contentunitgroup_id)

    Parameters

    int $contentunitgroup_id The contentunitgroupId for this contentunit.

    Return Values

    boolean true on success, false on error

    setExternalIdtop

    Description

    Set the externalId of the contentunit

    boolean setExternalId(string $external_id)

    Parameters

    string $external_id The externalId for this contentunit

    Return Values

    boolean true on success, false on error

    setHeighttop

    Description

    Set the height of the contentunit

    boolean setHeight(int $height)

    Parameters

    int $height The height for this contentunit.

    Return Values

    boolean true on success, false on error

    setNametop

    Description

    Set the name of the contentunit

    boolean setName(string $name)

    Parameters

    string $name The name for this contentunit

    Return Values

    boolean true on success, false on error

    setRontop

    Description

    Set the contentunit to run of network (ron)

    boolean setRon(boolean $ron)

    Parameters

    boolean $ron The new ron flag

    Return Values

    boolean true on success, false on error

    setSsltop

    Description

    Set the contentunit to use or use not ssl for its delivery

    boolean setSsl(boolean $ssl)

    Parameters

    boolean $ssl The new ssl flag

    Return Values

    boolean true on success, false on error

    setTagTypetop

    Description

    Set the tagtype of the contentunit


    The value can be on of ['websitetag', 'websiteredirect', 'campaignredirect', 'click'].

    boolean setTagType(string $tag_type)

    Parameters

    string $tag_type The tagtype for this contentunit.

    Return Values

    boolean true on success, false on error

    setTaggingBlockertop

    Description

    Sets tagging blocker on the contentunit

    boolean setTaggingBlocker()

    Return Values

    boolean

    setToHeighttop

    Description

    Set the maximum height of the contentunit

    boolean setToHeight(int $height)

    Parameters

    int $height The maximum height for this contentunit.

    Return Values

    boolean true on success, false on error

    setToWidthtop

    Description

    Set the width of the contentunit

    boolean setToWidth(int $width)

    Parameters

    int $width The maximum width for this contentunit.

    Return Values

    boolean true on success, false on error

    setTypetop

    Description

    Set the type of the contentunit


    The value can be on of ['fix', 'poplayer', 'dynamic', 'mobile'].

    boolean setType(string $type)

    Parameters

    string $type The type for this contentunit

    Return Values

    boolean true on success, false on error

    setWebsiteIdtop

    Description

    Set the websiteId of the contentunit

    boolean setWebsiteId(int $website_id)

    Parameters

    int $website_id The websiteId for this contentunit.

    Return Values

    boolean true on success, false on error

    setWidthtop

    Description

    Set the width of the contentunit

    boolean setWidth(int $width)

    Parameters

    int $width The width for this contentunit.

    Return Values

    boolean true on success, false on error

    unassignTaggingPeculiaritytop

    Description

    Unassign a tagging peculiarity from a the contentunit

    boolean unassignTaggingPeculiarity(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    unsetTaggingBlockertop

    Description

    Unset tagging blocker from the contentunit

    boolean unsetTaggingBlocker()

    Return Values

    boolean

    validatetop

    Description

    Validates the object and returns an error stack.

    string validate()

    Return Values

    string

    IntegerListtop

    Definition

    IntegerList for SoapServices.
    You may want to use this to pass a list of integers (e.g. ids) as
    parameter in you soap service.

    object IntegerList {
    - Array <int> $integers

    optional

    The integers

    }

    LearningTagAttributetop

    Definition

    object LearningTagAttribute {
    - string $name

    required

    - string $value

    required

    }

    LearningTagAttributeListtop

    Definition

    object LearningTagAttributeList {
    - Array <LearningTagAttribute> $attributes

    optional

    }

    LearningTagContentunitBuilderConfigurationtop

    Definition

    object LearningTagContentunitBuilderConfiguration {
    - int $candidateId

    required

    See LearningTagCandidateService::getCandidates() for a list of valid candidates.

    - boolean $autoCreateExternalAttributes

    optional

    - boolean $buildContentunitGroups

    optional

    }

    Console