ForecastServiceV2 Types

ForecastServiceV2 WSDL


This service is stateless.

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

getWaitTimeInMStop

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 getWaitTimeInMS(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

}

CampaignPrototypeForecastSettingstop

Definition

object CampaignPrototypeForecastSettings {
- string $reportName

optional

- string $startDate

required

Y-m-d format

- string $endDate

required

Y-m-d format

- int $campaignPriority

required

- 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

}

ForecastCompetingCampaignEntrytop

Definition

object ForecastCompetingCampaignEntry {
- string $campaignId

required

- string $inventory

required

}

ForecastDailyResultEntrytop

Definition

object ForecastDailyResultEntry {
- string $date

required

- int $unavailable_inventory

required

- int $available_inventory

required

- int $total_inventory

required

}

ForecastResulttop

Definition

object ForecastResult {
- ForecastSummaryEntry $summaryEntry

required

- Array <ForecastDailyResultEntry> $dailyResultEntries

optional

- Array <ForecastCompetingCampaignEntry> $competingCampaignEntries

optional

}

ForecastSummaryEntrytop

Definition

object ForecastSummaryEntry {
- int $totalCapacity

required

- int $unavailable

required

- int $available

required

}

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