Campaign Types

Campaign WSDL

Class managing a campaign
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 Campaign

int add()

Return Values

int The ID of the Campaign (unique)

addLandingpagetop

Description

Assign a landingpage

boolean addLandingpage(int $landingpageid)

Parameters

int $landingpageid

Return Values

boolean

assignTaggingPeculiaritytop

Description

Assign a tagging peculiarity to the campaign

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

copyToOrdertop

Description

Copy Campaign to an existing Order

int copyToOrder(int $order, boolean $copy_banners, boolean $dateadjust, boolean $copy_costs, boolean $copy_landingpages)

Parameters

int $order The Order in which the Campaign is copied into
boolean $copy_banners With or Without Banners, default: TRUE
boolean $dateadjust True in case if the banner runtimes should match the campaign runtime, default: TRUE
boolean $copy_costs Copy campaingcosts, default: FALSE
boolean $copy_landingpages If set to TRUE landingpages and trackingspots also get copied, default FALSE

Return Values

int New Campaign ID

disableAutomaticAsynchronousBannerRuntimeAdjustmenttop

Description

Disable automatic asynchronous adjustment of banner runtime.

boolean disableAutomaticAsynchronousBannerRuntimeAdjustment()

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 Campaign

boolean edit()

Return Values

boolean TRUE on succes, FALSE on fail

editCampaignCoststop

Deprecated 2020-05-05

This method will be removed in upcoming releases.

Deprecated in favor of Campaign::setPrice

Description

Edit the costs for an existing campaign (the campaign must already have costs, affects the campaign immediately, does not work for new campaigns).

boolean editCampaignCosts(float $costs, string $costtype, string $type, int $budget)

Parameters

float $costs
string $costtype
string $type
int $budget

Return Values

boolean

enableAutomaticAsynchronousBannerRuntimeAdjustmenttop

Description

Enable automatic asynchronous adjustment of banner runtime.

boolean enableAutomaticAsynchronousBannerRuntimeAdjustment()

Return Values

boolean

getActivetop

Description



boolean getActive()

Return Values

boolean

getAdGapIdtop

Description

Gets the AdGap-ID

string getAdGapId()

Return Values

string AdGap-ID

getAllowedTypestop

Description

Gets a list of allowed types.

string getAllowedTypes()

Return Values

string

getAssignedTaggingPeculiaritiestop

Description

Gets the assigned tagging peculiarities

string getAssignedTaggingPeculiarities()

Return Values

string

getCampaignCoststop

Deprecated 2020-05-05

This method will be removed in upcoming releases.

Deprecated in favor of Campaign::getPrice

Description

Get the costs for an existing campaign (affects the campaign immediately, does not work for new campaigns).

string getCampaignCosts()

Return Values

string

getClickstop

Description

Gets the clicks of this campaign.

int getClicks(string $start, string $end)

Parameters

string $start Start date with the format YYYY-MM-DD, set to null to disable
string $end End date date with the format YYYY-MM-DD, set to null to disable

Return Values

int

getEffectiveTaggingPeculiaritiestop

Description

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

string getEffectiveTaggingPeculiarities()

Return Values

string

getEnddatetop

Description

Gets the last end date of all runtimes.

string getEnddate()

Return Values

string The date as DATETIME string

getExternalIdtop

Description

Gets the external id of the campaign.

string getExternalId()

Return Values

string

getFilterstop

Description

Return example array(0 => array('type' => 'werbeplatz', 'id' => 123), 1 => array(...))

string getFilters()

Return Values

string

getFromRuntimetop

Description

Gets the first start date of the campaign.

string getFromRuntime()

Return Values

string

getGoalSettingstop

Description

Gets the campaign's goal settings

CampaignGoalSettings getGoalSettings()

Return Values

CampaignGoalSettings

getIdtop

Description



int getId()

Return Values

int

getLandingpagestop

Description

Get all landingpages assigned to this campaign

string getLandingpages()

Return Values

string

getMobiletop

Description



boolean getMobile()

Return Values

boolean

getNametop

Description



string getName()

Return Values

string

getNetworktop

Description

Returns the current network id

int getNetwork()

Return Values

int Network ID

getNetworkIdtop

Description

Gets the network ID.

int getNetworkId()

Return Values

int

getOrderIdtop

Description

Gets the order ID to the campaign.

int getOrderId()

Return Values

int

getPItop

Description

Gets the page impressions of this campaign (optional in a specific time range).

int getPI(string $start, string $end)

Parameters

string $start Start date with the format YYYY-MM-DD, set to null to disable
string $end End date date with the format YYYY-MM-DD, set to null to disable

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

getPotentialContentunitstop

Description

Returns a list of contentunit ids where the campaign may run

string getPotentialContentunits()

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

getPremiumCampaignFlagtop

Description

Get the premium - campaign value

boolean getPremiumCampaignFlag()

Return Values

boolean

getPricetop

Description

Returns the price information for the campaign, if it exist. (Does not work for new campaigns)

CampaignPriceSettings getPrice()

Return Values

CampaignPriceSettings

getPrioritytop

Description

Gets the campaign priority.

int getPriority()

Return Values

int

getProgrammaticGuaranteeSettingstop

Description

Sets the programmatic guarantee settings for the campaign.

ProgrammaticGuaranteeSettings getProgrammaticGuaranteeSettings()

getPublishertop

Description

Returns the publisher of the campaign, if exist.

Company getPublisher()

Return Values

Company

getRealTimeBiddingSettingstop

Description



RealTimeBiddingSettings getRealTimeBiddingSettings()

Return Values

RealTimeBiddingSettings

getRedirectTagtop

Deprecated 2018-07-20

This method will be removed in upcoming releases.

Use stateless CampaignRedirectTagService::getRedirectTagsByType($campaignId, 'javascript')

Description

Gets the redirect tag for this campaign

string getRedirectTag()

Return Values

string

getReservedtop

Description

Returns true if the campaign is set to reserved, false otherwise.

boolean getReserved()

Return Values

boolean

getRuntimestop

Description

Gets all runtimes of the campaign as a list.

string getRuntimes()

Return Values

string

getStartdatetop

Description

Gets the first startdate of all runtimes.

string getStartdate()

Return Values

string The date as DATETIME string

getToRuntimetop

Description

Gets the last end date of the campaign.

string getToRuntime()

Return Values

string

getTokentop

Description

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

string getToken()

Return Values

string

getTypetop

Description



string getType()

Return Values

string

getUnlimitedtop

Description

Returns true if the campaign runtime is set to unlimited (respectively automatic extension), false otherwise.

boolean getUnlimited()

Return Values

boolean

getUpdatedAttop

Description

Gets the date from the last update of the campaign.

string getUpdatedAt()

Return Values

string

getValidGoalsForCampaignTypetop

Description

Returns a list of valid campaign goals for a given campaign type

StringList getValidGoalsForCampaignType(string $campaign_type)

Parameters

string $campaign_type

Return Values

StringList

getWeighttop

Description

Gets the campaign weight of the campaign.

int getWeight()

Return Values

int

getYieldlabSettingstop

Description

Gets the yieldlab settings

YieldlabSettings getYieldlabSettings()

Return Values

YieldlabSettings

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

hasPricetop

Description

Returns a boolean true if campaign has price or price relevancy information

boolean hasPrice()

Return Values

boolean

hasTaggingBlockertop

Description

Determines whether the campaign has a tagging blocker

boolean hasTaggingBlocker()

Return Values

boolean

hasYieldlabSettingstop

Description

Tells if the campaign has yieldlab settings

boolean hasYieldlabSettings()

Return Values

boolean

isAutomaticAsynchronousBannerRuntimeAdjustmentEnabledtop

Description

Is automatic asynchronous adjustment of banner runtime enabled.

boolean isAutomaticAsynchronousBannerRuntimeAdjustmentEnabled()

Return Values

boolean

isBehaviourTargetingRelevanttop

Description

Determines whether the campaign is behaviour-targeting relevant (gets the OBA-flag)

boolean isBehaviourTargetingRelevant()

Return Values

boolean

isPriceRelevanttop

Description



boolean isPriceRelevant()

Return Values

boolean

isProgrammaticGuaranteedtop

Description

Returns a boolean true for programmatic guaranteed campaigns, false otherwise.

boolean isProgrammaticGuaranteed()

Return Values

boolean

isTaggingPecuiliarityAssignedtop

Description

Determines whether the given tagging peculiarity is assigned to the campaign

boolean isTaggingPecuiliarityAssigned(int $peculiarity)

Parameters

int $peculiarity The peculiarity

Return Values

boolean

loadtop

Description

Load the specified Campaign into the object

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

Delete the campaign

boolean remove()

Return Values

boolean

removeAutoextensiontop

Description

Remove auto extension for a campaign

boolean removeAutoextension()

Return Values

boolean

removeByIdtop

Description

Removes a CampaignModel with the given id

boolean removeById(int $id)

Parameters

int $id ID of object to remove.

Return Values

boolean

removeCampaignCoststop

Description

Remove costs from an existing campaign (affects the campaign immediately, does not work for new campaigns).

boolean removeCampaignCosts()

Return Values

boolean

removeLandingpagetop

Description

Remove an assigned landingpage

boolean removeLandingpage(int $landingpageid)

Parameters

int $landingpageid

Return Values

boolean

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

Persists current object state

boolean save()

Return Values

boolean True on success, otherwise false

setActivetop

Description

Sets the campaign to active [true] or inactive [false].

boolean setActive(boolean $active)

Parameters

boolean $active

Return Values

boolean

setAdGapIdtop

Description

Sets the AdGap-ID

boolean setAdGapId(string $ad_gap_id)

Parameters

string $ad_gap_id

Return Values

boolean Always true

setAutoextensiontop

Description

Sets an automatic runtime extension for the campaign.
Has an immediate effect on the currently loaded campaign even without a save() call.
Works only with campaigns having already an ID.

boolean setAutoextension(int $days, string $state)

Parameters

int $days
string $state

Return Values

boolean

setBehaviourTargetingRelevanttop

Description

Marks/unmarks the campaign as behaviour-targeting relevant (sets the OBA-flag)

boolean setBehaviourTargetingRelevant(boolean $value)

Parameters

boolean $value

Return Values

boolean

setCampaignCoststop

Deprecated 2020-05-05

This method will be removed in upcoming releases.

Deprecated in favor of Campaign::setPrice

Description

Set the costs for an existing campaign (the campaign must not already have any costs, affects the campaign immediately, does not work for new campaigns).

boolean setCampaignCosts(float $costs, string $costtype, string $type, int $budget)

Parameters

float $costs
string $costtype
string $type
int $budget

Return Values

boolean

setExternalIdtop

Description

Sets the external id of the campaign.

boolean setExternalId(string $external_id)

Parameters

string $external_id

Return Values

boolean

setFromRuntimetop

Description

Sets the starting (from) runtime of the campaign.

boolean setFromRuntime(string $runtime)

Parameters

string $runtime

Return Values

boolean

setGoalSettingstop

Description

Sets the campaign's goal settings

boolean setGoalSettings(CampaignGoalSettings $goal_settings)

Parameters

CampaignGoalSettings $goal_settings

Return Values

boolean True on success, otherwise false

setMobiletop

Description

Marks the campaign as mobile [true] or as normal [false].

boolean setMobile(boolean $mobile)

Parameters

boolean $mobile

Return Values

boolean

setNametop

Description

Sets the name of the campaign.

boolean setName(string $name)

Parameters

string $name

Return Values

boolean

setOrderIdtop

Description

Sets the order ID of the campaign.

boolean setOrderId(int $order_id)

Parameters

int $order_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

setPremiumCampaignFlagtop

Description

Sets the premium value for the authentificated user
The method saves the state instantly into repository (db)

boolean setPremiumCampaignFlag(boolean $is_premium)

Parameters

boolean $is_premium

Return Values

boolean

setPricetop

Description

Sets the campaign price.

boolean setPrice(CampaignPriceSettings $settings)

Parameters

CampaignPriceSettings $settings

Return Values

boolean

setPriceRelevanttop

Description

The price relevancy flag decides which price is used on reporting. When the flag is set to true,
the costs on reports will be calculated using the price information on the campaign.
Otherwise (default behavior), contentunit or placement cost is used.

boolean setPriceRelevant(boolean $flag)

Parameters

boolean $flag

Return Values

boolean True on success, otherwise false

setPrioritytop

Description

Sets the priority of the campaign (in range of 0-100).

boolean setPriority(int $priority)

Parameters

int $priority

Return Values

boolean

setProgrammaticGuaranteeSettingstop

Description

Sets the programmatic guarantee settings for the campaign.

boolean setProgrammaticGuaranteeSettings(ProgrammaticGuaranteeSettings $settings)

Parameters

ProgrammaticGuaranteeSettings $settings

Return Values

boolean

setPublishertop

Description

Sets a publisher for the campaign. Using this interface requires a network level authorization.

boolean setPublisher(int $publisher_id)

Parameters

int $publisher_id

Return Values

boolean

setRealTimeBiddingSettingstop

Description



boolean setRealTimeBiddingSettings(RealTimeBiddingSettings $settings)

Parameters

RealTimeBiddingSettings $settings

Return Values

boolean True on success, otherwise false

setReservedtop

Description

Sets the reserved flag of the campaign.
If set to true, the campaign is not delivered.

boolean setReserved(boolean $reserved)

Parameters

boolean $reserved

Return Values

boolean

setRuntimestop

Description

Sets multiple runtimes at once. The runtimes have to be in format:

array(
0 => array('from' => $startdate, 'to' => $enddate),
[...],
n => array('from' => $startdate_n, 'to' => $enddate_n),
)

boolean setRuntimes(string $runtimes)

Parameters

string $runtimes

Return Values

boolean

setTaggingBlockertop

Description

Sets tagging blocker on the campaign

boolean setTaggingBlocker()

Return Values

boolean

setToRuntimetop

Description

Sets the to runtime of the campaign.
If the unlimited flag is set to true, this single runtime will be set to the last second of the year.

boolean setToRuntime(string $runtime)

Parameters

string $runtime

Return Values

boolean

setTypetop

Description

Sets the type of the campaign.
Campaign types: [closed, open, redirect]

boolean setType(string $type)

Parameters

string $type

Return Values

boolean

setUnlimitedtop

Description

Sets the campaign runtime to unlimited [true] or remove the unlimited flag [false].

boolean setUnlimited(boolean $unlimited)

Parameters

boolean $unlimited

Return Values

boolean

setWeighttop

Description

Sets the weight of the campaign.

boolean setWeight(int $weight)

Parameters

int $weight

Return Values

boolean

setYieldlabSettingstop

Description

Sets the yieldlab settings

Note: Calling this function sets the yieldlab option to true

boolean setYieldlabSettings(YieldlabSettings $yieldlab_settings)

Parameters

YieldlabSettings $yieldlab_settings

Return Values

boolean True on success, otherwise false

unassignTaggingPeculiaritytop

Description

Unassign a tagging peculiarity from a the campaign

boolean unassignTaggingPeculiarity(int $peculiarity)

Parameters

int $peculiarity The peculiarity

Return Values

boolean

unsetTaggingBlockertop

Description

Unset tagging blocker from the campaign

boolean unsetTaggingBlocker()

Return Values

boolean

validatetop

Description

Validates the object and returns an error stack.

string validate()

Return Values

string

CampaignGoalSettingstop

Definition

Configures the campaign's goals

object CampaignGoalSettings {
- int $adRequestCount

optional

Defines the number of adRequests that are to be generated by this campaign.

- int $clickCount

optional

Defines the number of clicks that are to be counted for this campaign.

A goal count of 0 means the goal is ignored or will be deleted if it was set previously.

- int $successSpotCount

optional

Defines the number of success spot visits that are to be counted for this campaign.

A goal count of 0 means the goal is ignored or will be deleted if it was set previously.

- int $bannerEventCount

optional

Defines the number of banner events that are to be counted for this campaign.

If banner event count is set to a non zero value then banner event key must be set, too.

A goal count of 0 means the goal is ignored or will be deleted if it was set previously.

- string $bannerEventKey

optional

Defines the key of the banner event that is to be counted for this campaign.

The banner event key is ignored if the banner event count equals to 0.

- int $visibilityCount

optional

Defines the number of visibility measurements counted for this campaign.

A goal count of 0 means the goal is ignored or will be deleted if it was set previously.

- string $mainGoal

optional

Defines the main goal for closed campaigns. Does not need to be set for open campaigns.

- string $systemBannerEventNamespace

optional

Defines the namespace for system banner events in order to distinguish for example
an "impression" event for VAST from an event with the same key/name from another context.
If set, then the referenced banner event is assumed to be a system banner event.

System banner events are network independent, thus not defined by the network user.
Currently only the "vast" namespace is available.

See SystemBannerEventService::getAllSystemBannerEvents() for a list of available system banner events.

}

CampaignPriceSettingstop

Definition

object CampaignPriceSettings {
- string $type

required

- string $priceType

required

- string $priceValue

required

No thousands separator.
"." as decimal separator.
Max. 4 fractional digits.

- string $maxBidPrice

optional

No thousands separator.
"." as decimal separator.
Max. 4 fractional digits.

}

Companytop

Definition

object Company {
- int $id

optional

- string $name

required

- string $externalId

optional

- boolean $isAgency

optional

- boolean $isClient

optional

- boolean $isPublisher

optional

- Array <int> $agencyIds

optional

- int $creatorId

optional

- string $updatedAt

optional

}

GenericProgrammaticGuaranteeSettingstop

Definition

object GenericProgrammaticGuaranteeSettings extends ProgrammaticGuaranteeSettings {
}

ProgrammaticGuaranteeSettingstop

Definition

Inheriting types:
- GenericProgrammaticGuaranteeSettings
- VideoProgrammaticGuaranteeSettings

object abstractProgrammaticGuaranteeSettings {
- int $demandPartnerId

required

Demand partner identifier on SSP side to work with. List of valid values can be retrieved from the stateless
DemandPartnerService.

- int $partnershipId

optional

Identifier of the partnership created at supply-side platform for the campaign. (Read-only)

- string $platform

optional

Identifier of the supply-side platform integrated with. (Read-only)

- int $dealId

optional

The deal identifier provided by the supply-side platform for the campaign. (Read-only)

}

RealTimeBiddingSettingstop

Definition

object RealTimeBiddingSettings {
- int $maxCpm

required

The maximum allowed cost per mille in euro-cents.

- int $budget

required

The "total campaign budget" in euro-cents.

- int $dailyBudget

required

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

- int $biddingStrategy

required

The bidding strategy used:
1 for maximum price
2 for floor price
3 for classic delivery
4 for best price

- int $maxCpc

optional

The target-value for click-optimization in euro-cents, not guaranteed

- int $maxCpoCpl

optional

The target-value for order or lead optimization in percent, not guaranteed

}

StringListtop

Definition

object StringList {
- Array <string> $strings

optional

The strings

}

VideoProgrammaticGuaranteeSettingstop

Definition

object VideoProgrammaticGuaranteeSettings extends ProgrammaticGuaranteeSettings {
- string $vastVersion

required

VAST version to use for VAST wrapper banner(s) will be created for the campaign.

Value can be one of following:
- vast2
- vast4
- vast4.1

}

YieldlabSettingstop

Definition

Configures the behaviour of yieldlab campaign

object YieldlabSettings {
- int $partnershipId

optional

The numerical yieldlab partnership identifier. Refer to the yieldlab integration documentation for more detailed information.

- string $priority

optional

The alphanumerical custom priority for filtering purposes. Refer to the yieldlab integration documentation for more detailed information.

- boolean $yieldprobe

optional

Set the yieldprobe option for this campaign. Refer to the yieldlab integration documentation for more detailed information.

}

Console