CampaignService Types

CampaignService WSDL


This service is stateless.

getCampaignIdsForLandingpageIdtop

Description

Requires administrator permissions.

IntegerList getCampaignIdsForLandingpageId(int $landingpage_id)

Parameters

int $landingpage_id

Return Values

IntegerList

getCounttop

Description

Requires administrator permissions.

int getCount()

Return Values

int

getSoaCollectionPagetop

Description

Gets a single SoaCollection page.
Requires administrator permissions.

For valid filters and qualifiers see getValidSoaCollectionFilters().

CampaignList getSoaCollectionPage(KeySetPagedSoaCollectionConfiguration $configuration)

Parameters

KeySetPagedSoaCollectionConfiguration $configuration

Return Values

CampaignList

getValidSoaCollectionFilterstop

Description

Gets valid soa collection search filters and their qualifier name / values

SoaCollectionValidFilterList getValidSoaCollectionFilters()

Return Values

SoaCollectionValidFilterList

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

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean true on success, false on fail

Campaigntop

Definition

object Campaign {
- int $id

optional

- string $name

required

- string $externalId

optional

- string $type

required

- int $orderId

required

- boolean $active

required

- boolean $mobile

optional

Default: false

- int $priority

optional

- int $weight

optional

- CampaignGoalSettings $goalSettings

optional

- boolean $unlimited

optional

- Array <CampaignRuntime> $runtimes

optional

- CampaignPriceSettings $priceSettings

optional

- int $creatorId

optional

- string $createdAt

optional

- string $updatedAt

optional

- boolean $priceRelevant

optional

- int $frontloadingFactor

optional

- boolean $forecastExclude

optional

- string $adGapId

optional

- string $dsaPaid

optional

- string $dsaBehalf

optional

}

CampaignGoalSettingstop

Definition

Configures the campaign's goals

object CampaignGoalSettings {
- unsignedInt $adRequestCount

optional

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

- unsignedInt $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.

- unsignedInt $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.

- unsignedInt $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.

- unsignedInt $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.

}

CampaignListtop

Definition

object CampaignList {
- Array <Campaign> $campaigns

optional

- Array <NamedStringValue> $lastKeySet

optional

}

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.

- string $bannerEventKey

optional

Defines the key of the banner event that is used for the CPE calculation.

- 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.

}

CampaignRuntimetop

Definition

object CampaignRuntime {
- string $from

required

Y-m-d H:i:s

- string $to

optional

Y-m-d H:i:s

Not available in case of last runtime segment of an unlimited campaign.

}

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

}

KeySetPagedSoaCollectionConfigurationtop

Definition

object KeySetPagedSoaCollectionConfiguration {
- Array <SoaCollectionFilter> $filters

optional

See SoaCollection::addQualifiedFilter()

- int $pageSize

required

- Array <NamedStringValue> $lastKeySet

optional

Read-only specification of the last collection element for key-set based paging.
The value is an implementation detail and must only be used for passing it directly
to getSoaCollectionPage() in order to navigate to the next collection page.
The value must be retrieved from the "lastKeySet" property of the previous getSoaCollectionPage() call.
To be left empty for the very first getSoaCollectionPage() call (default).

- boolean $useReplication

optional

Enables usage of replicated data increasing the performance and stability of search operations.

Regardless of this setting live data will be used instead in case of replication having
a lag of more than a couple of seconds.

}

NamedStringValuetop

Definition

object NamedStringValue {
- string $name

required

- string $value

required

}

SoaCollectionFiltertop

Definition

See SoaCollection::addQualifiedFilter().

object SoaCollectionFilter {
- string $target

required

- string $value

required

- int $qualifier

required

}

SoaCollectionFilterQualifiertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionFilterQualifier {
- string $name

required

- int $value

required

}

SoaCollectionValidFiltertop

Definition

Describes the possible qualifiers for a filter target

object SoaCollectionValidFilter {
- string $target

required

- Array <SoaCollectionFilterQualifier> $qualifiers

optional

}

SoaCollectionValidFilterListtop

Definition

A list of valid filters and their qualifiers

object SoaCollectionValidFilterList {
- Array <SoaCollectionValidFilter> $validFilters

optional

}

Console