Order Types

Order WSDL

An order model
This service is stateful.

Examples +

  • order
  • order
  • 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 Order

    int add()

    Return Values

    int The ID of the Order (unique)

    addFoldertop

    Description

    Adds the order to a folder

    boolean addFolder(int $folder)

    Parameters

    int $folder

    Return Values

    boolean True if the folder was not already assigned, false otherwise

    assignTaggingPeculiaritytop

    Description

    Assign a tagging peculiarity to the order

    boolean assignTaggingPeculiarity(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    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 Order

    boolean edit()

    Return Values

    boolean TRUE on succes, FALSE on fail

    getAgencyIdtop

    Description

    Gets the ID of the assigned agency

    int getAgencyId()

    Return Values

    int

    getAssignedTaggingPeculiaritiestop

    Description

    Gets the assigned tagging peculiarities

    string getAssignedTaggingPeculiarities()

    Return Values

    string

    getCampaignstop

    Description

    Gets a list of campaigns assigned to this order

    string getCampaigns()

    Return Values

    string

    getClientIdtop

    Description

    Gets the ID of the assigned client

    int getClientId()

    Return Values

    int

    getCreatedatetop

    Description

    Specifies the date of creation

    string getCreatedate()

    Return Values

    string

    getDsaBehalftop

    Description



    string getDsaBehalf()

    Return Values

    string

    getDsaPaidtop

    Description



    string getDsaPaid()

    Return Values

    string

    getEditortop

    Description

    Gets the user who is the editor of that order

    int getEditor()

    Return Values

    int

    getEffectiveTaggingPeculiaritiestop

    Description

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

    string getEffectiveTaggingPeculiarities()

    Return Values

    string

    getExternalIdtop

    Description

    Returns the external ID.

    string getExternalId()

    Return Values

    string

    getIdtop

    Description

    Gets the order id

    int getId()

    Return Values

    int

    getNametop

    Description

    Gets the orders name

    string getName()

    Return Values

    string

    getNetworktop

    Description

    Returns the current network id

    int getNetwork()

    Return Values

    int Network ID

    getNetworkIdtop

    Description

    Gets the associated network id

    int getNetworkId()

    Return Values

    int

    getOfferIdtop

    Description

    Gets the offer id

    int getOfferId()

    Return Values

    int

    getPostCodetop

    Description

    Returns the postCode for this object.
    Please refer to our customer wiki for more information about the inheritance logic.

    string getPostCode()

    Return Values

    string

    getPreCodetop

    Description

    Returns the preCode for this object.
    Please refer to our customer wiki for more information about the inheritance logic.

    string getPreCode()

    Return Values

    string

    getPrimaryPersonIdtop

    Description

    Gets the id of the primary person

    int getPrimaryPersonId()

    Return Values

    int

    getRealTimeBiddingSettingstop

    Description

    Gets the RealTimeBidding settings

    RealTimeBiddingSettings getRealTimeBiddingSettings()

    Return Values

    RealTimeBiddingSettings

    getTokentop

    Description

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

    string getToken()

    Return Values

    string

    getUpdatedAttop

    Description

    Specifies the date when the campaign was last modified.

    string getUpdatedAt()

    Return Values

    string

    hasPostCodetop

    Description

    Checks, whether postCode for this object is set or not.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean hasPostCode()

    Return Values

    boolean

    hasPreCodetop

    Description

    Checks, whether preCode for this object is set or not.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean hasPreCode()

    Return Values

    boolean

    hasRealTimeBiddingSettingstop

    Description

    Tells if the order has RealTimeBidding settings

    boolean hasRealTimeBiddingSettings()

    Return Values

    boolean

    hasTaggingBlockertop

    Description

    Determines whether the order has a tagging blocker

    boolean hasTaggingBlocker()

    Return Values

    boolean

    isTaggingPecuiliarityAssignedtop

    Description

    Determines whether the given tagging peculiarity is assigned to the order

    boolean isTaggingPecuiliarityAssigned(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    loadtop

    Description

    Load an order by its id

    boolean load(int $identifier)

    Parameters

    int $identifier

    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 the order and all it's all subnodes

    boolean remove()

    Return Values

    boolean

    removeByIdtop

    Description

    Removes a OrderModel with the given id

    boolean removeById(int $id)

    Parameters

    int $id ID of object to remove.

    Return Values

    boolean

    removeFoldertop

    Description

    Removes the order from a folder

    boolean removeFolder(int $folder)

    Parameters

    int $folder

    Return Values

    boolean True if the folder was assigned, false otherwise

    removePostCodetop

    Description

    Removes the postCode on this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean removePostCode()

    Return Values

    boolean True on success, otherwise false

    removePreCodetop

    Description

    Removes the preCode on this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean removePreCode()

    Return Values

    boolean True on success, otherwise false

    savetop

    Description

    Saves changes made to the order

    boolean save()

    Return Values

    boolean True on success, otherwise false

    setAgencyIdtop

    Description

    Sets the agency id for the current order

    boolean setAgencyId(int $agency_id)

    Parameters

    int $agency_id The ID of the agency assigned to this order

    Return Values

    boolean

    Examples

    • order
    • order
    .

      setClientIdtop

      Description

      Sets the id of the client

      boolean setClientId(int $client_id)

      Parameters

      int $client_id The ID of the client assigned to this order

      Return Values

      boolean

      setDsaBehalftop

      Description



      boolean setDsaBehalf(string $value)

      Parameters

      string $value

      Return Values

      boolean

      setDsaPaidtop

      Description



      boolean setDsaPaid(string $value)

      Parameters

      string $value

      Return Values

      boolean

      setEditortop

      Description

      Sets the user who is the editor of that order

      boolean setEditor(int $editor)

      Parameters

      int $editor

      Return Values

      boolean

      setExternalIdtop

      Description

      Sets the external ID.

      The external ID can be used to set a custom identifier to the order.

      boolean setExternalId(string $external_id)

      Parameters

      string $external_id

      Return Values

      boolean

      setNametop

      Description

      Sets the name of the order

      boolean setName(string $name)

      Parameters

      string $name A name for the order. It must be between 1 and 255 chars.

      Return Values

      boolean

      setOfferIdtop

      Description

      Sets the offer id

      boolean setOfferId(int $offer_id)

      Parameters

      int $offer_id

      Return Values

      boolean

      setPostCodetop

      Description

      Sets the postCode for this object. Has a direct impact on the banner preCode.
      Please refer to our customer wiki for more information about the inheritance logic.

      boolean setPostCode(string $code)

      Parameters

      string $code PostCode, Maximum length is: 64000 characters

      Return Values

      boolean

      setPreCodetop

      Description

      Sets the preCode for this object. Has a direct impact on the banner preCode.
      Please refer to our customer wiki for more information about the inheritance logic.

      boolean setPreCode(string $code)

      Parameters

      string $code PreCode, Maximum length is: 64000 characters

      Return Values

      boolean

      setRealTimeBiddingSettingstop

      Description

      Sets the RealTimeBidding settings

      boolean setRealTimeBiddingSettings(RealTimeBiddingSettings $rtb_settings)

      Parameters

      RealTimeBiddingSettings $rtb_settings

      Return Values

      boolean True on success, otherwise false

      setTaggingBlockertop

      Description

      Sets tagging blocker on the order

      boolean setTaggingBlocker()

      Return Values

      boolean

      setUsertop

      Description

      Sets the user who created that campaign

      boolean setUser(int $user)

      Parameters

      int $user

      Return Values

      boolean True on success, otherwise false

      unassignTaggingPeculiaritytop

      Description

      Unassign a tagging peculiarity from a the order

      boolean unassignTaggingPeculiarity(int $peculiarity)

      Parameters

      int $peculiarity The peculiarity

      Return Values

      boolean

      unsetClientIdtop

      Description

      Unsets the id of the client.

      Warning: This is only valid if the agency assigned to this order has the "client" flag.

      boolean unsetClientId()

      Return Values

      boolean

      unsetEditortop

      Description

      Unset the Order editor

      boolean unsetEditor()

      Return Values

      boolean

      unsetTaggingBlockertop

      Description

      Unset tagging blocker from the order

      boolean unsetTaggingBlocker()

      Return Values

      boolean

      validatetop

      Description

      Validates the object and returns an error stack.

      string validate()

      Return Values

      string

      RealTimeBiddingSettingstop

      Definition

      object RealTimeBiddingSettings {
      - int $budget

      optional

      The total order budget in euro-cents.

      - int $dailyBudget

      optional

      The "maximum order budget per day" in euro-cents.

      }

      Console