ForecastService Types

ForecastService WSDL


This service is stateless.

enqueueCampaignForecasttop

Description



int enqueueCampaignForecast(CampaignForecastSettings $campaign_forecast_settings)

Parameters

CampaignForecastSettings $campaign_forecast_settings

Return Values

int Forecast ID

Faults

ValidationErrorMessageList

enqueueCampaignPrototypeForecasttop

Description



int enqueueCampaignPrototypeForecast(CampaignPrototypeForecastSettings $campaign_prototype_forecast_settings)

Parameters

CampaignPrototypeForecastSettings $campaign_prototype_forecast_settings

Return Values

int Forecast ID

Faults

ValidationErrorMessageList

getForecastResulttop

Description



ForecastResult getForecastResult(int $forecast_id)

Parameters

int $forecast_id

Return Values

ForecastResult

getMillisecondsToWaitBeforeNextForecastStatusChecktop

Description

Returns:
- 0 - forecast is finished; the result can be fetched via getForecastResult().
- > 0 - forecast is not finished; please wait the given number of milliseconds before checking again.
Throws for forecast generation error or checking the status of a non-queued forecast.

int getMillisecondsToWaitBeforeNextForecastStatusCheck(int $forecast_id)

Parameters

int $forecast_id

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

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean true on success, false on fail

BrowserFiltertop

Definition

object BrowserFilter extends ForecastFilter {
- Array <int> $browserIds

required

}

CampaignAsynchronousForecastSettingstop

Definition

object CampaignAsynchronousForecastSettings extends CampaignPrototypeForecastSettings {
- int $campaignId

required

}

CampaignForecastSettingstop

Definition

object CampaignForecastSettings {
- int $campaignId

required

}

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.

}

CampaignPrototypeForecastSettingstop

Definition

Inheriting types:
- CampaignAsynchronousForecastSettings

object CampaignPrototypeForecastSettings {
- string $startDate

required

Y-m-d format

- string $endDate

required

Y-m-d format

- int $campaignPriority

required

- int $campaignWeight

optional

- string $campaignType

required

- CampaignGoalSettings $campaignGoalSettings

optional

- boolean $trueCountEnabled

optional

- Array <ForecastFilter> $filters

optional

- Array <int> $inventoriedFilterIds

optional

}

CappingFiltertop

Definition

object CappingFilter extends ForecastFilter {
- int $requests

required

- int $time

required

Seconds

}

ChannelFiltertop

Definition

object ChannelFilter extends ForecastFilter {
- Array <int> $channelIds

required

}

CityFiltertop

Definition

object CityFilter extends ForecastFilter {
- Array <int> $cityIds

required

}

CompetitiveExclusionFiltertop

Definition

object CompetitiveExclusionFilter extends ForecastFilter {
- Array <int> $competitiveSegmentIds

required

}

ContentunitFiltertop

Definition

object ContentunitFilter extends ForecastFilter {
- Array <int> $contentunitIds

required

}

CountryFiltertop

Definition

object CountryFilter extends ForecastFilter {
- Array <int> $countryIds

required

}

ForecastDailyResultEntrytop

Definition

object ForecastDailyResultEntry {
- string $date

required

- ForecastResultEntry $resultEntry

required

}

ForecastResulttop

Definition

object ForecastResult {
- ForecastResultEntry $summaryResultEntry

required

- Array <ForecastDailyResultEntry> $dailyResultEntries

optional

}

ForecastResultEntrytop

Definition

object ForecastResultEntry {
- long $totalInventory

required

Total that can be build from:

placement + adjusted inventory
OR
unavailable + non-matching + matching available inventory

- long $adjustedInventory

required

Inventory affected by forecast adjustments.

- long $placementInventory

required

Inventory calculated for the configured placement.

- long $unavailableInventory

required

Inventory occupied by campaigns with equal or higher priority.

- long $nonMatchingInventory

required

Inventory that requires different targetings.

- long $matchingAvailableInventory

required

Inventory available for the current campaign including inventory of campaigns with lower priority.
Allocating the complete available inventory will starve campaigns with lower priority.

- long $matchingLowerPriorityBookedInventory

required

Part of matching available inventory used by campaigns with lower priority.

}

LearningTagFiltertop

Definition

object LearningTagFilter extends ForecastFilter {
- string $code

required

}

MultiDeviceFrequencyCappingFiltertop

Definition

object MultiDeviceFrequencyCappingFilter extends ForecastFilter {
- int $requests

required

- int $time

required

Seconds

- int $graphId

optional

}

OperatingSystemFiltertop

Definition

object OperatingSystemFilter extends ForecastFilter {
- Array <int> $operatingSystemIds

required

}

ProfileFiltertop

Definition

object ProfileFilter extends ForecastFilter {
- string $code

required

}

ResolutionFiltertop

Definition

object ResolutionFilter extends ForecastFilter {
- Array <int> $resolutionIds

required

}

ScheduleFiltertop

Definition

object ScheduleFilter extends ForecastFilter {
- WeekSchedule $weekSchedule

required

}

StateFiltertop

Definition

object StateFilter extends ForecastFilter {
- Array <int> $stateIds

required

}

TagFiltertop

Definition

object TagFilter extends ForecastFilter {
- string $code

required

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

WeekScheduletop

Definition

Schedule for the week. Hours can be defined per day.
Values in 24-hour format without leading zeros. 0 through 23.

object WeekSchedule {
- Array <int> $mon

optional

Hours for monday.

- Array <int> $tue

optional

Hours for tuesday.

- Array <int> $wed

optional

Hours for wednesday.

- Array <int> $thu

optional

Hours for thursday.

- Array <int> $fri

optional

Hours for friday.

- Array <int> $sat

optional

Hours for saturday.

- Array <int> $sun

optional

Hours for sunday.

}

Console